pypims 0.0.1

Python APIs for hipims

HiPIMS-PYTHON

This package provides python APIs for running the open source hydraulic model hipims-cuda. It is used in companion with the hipims-io package for pre-processing and result visualisation.

Installation

Before installing hipims, you need to install Cmake, NVIDIA CUDA Toolkit and the C++ compiler. Cmake can be simply installed by

pip install cmake

The CUDA Toolkit can be downloaded from the NVIDIA website. If you use Linux system, the C++ compilerGCC is usually on the system as default. If you use windows, you should download and install Visual Studio.

Once the aforementioned dependencies have been properly installed. Installing hipims is straightforward, simple type in the following in your terminal

pip install hipims

Basic usage

The package can be imported by

from hipims import flood

The inputs to hipims can be prepared by hipims-io. Once the inputs have all been prepared, the simulations can be started by

flood.run('path to your inputs')

or

flood.run_mgpus('path to your inputs')

for multiple GPUs.