Python APIs for hipims
Project description
PYPIMS
This package provides python APIs for running the open source hydraulic model hipims-cuda. It also includes the hipims-io package for pre-processing and result visualisation.
Installation
Before installing pypims, 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++ compiler 'GCC' is usually on the system as default. If you use windows, you should download and install Visual Studio. If there exists several different versions of CUDA Toolkits on your system, cmake may struggle to decide which one to use and return an error. In such a case, you need to define the CUDAToolkit_ROOT environmental varialble. On Linux, this can be done by
export CUDAToolkit_ROOT=<path to your cuda directory>
For example
export CUDAToolkit_ROOT=/usr/local/cuda-10.1
Once the aforementioned dependencies have been properly installed. Installing pypims is straightforward, simple type in the following in your terminal
pip install pypims
Basic usage
The flood simulation engine can be imported by
from pypims import flood
The inputs can be prepared by hipims-io. This package has already been included in pypims, you can import it by
from pypims import IO
Once the inputs have all been prepared, the simulations can be started by
```python
flood.run('path to your inputs')
or
flood.run_mgpus('path to your inputs')
for multiple GPUs.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.