pympdata-mpi 1.7.1

PyMPDATA + numba-mpi coupler sandbox

PyMPDATA-MPI

PyMPDATA-MPI constitutes a PyMPDATA + numba-mpi coupler enabling numerical solutions of transport equations with the MPDATA numerical scheme in a hybrid parallelisation model with both multi-threading and MPI distributed memory communication. PyMPDATA-MPI adapts to API of PyMPDATA offering domain decomposition logic.

Dependencies and installation

Along with PyMPDATA dependencies, this package also depends on numba-mpi and h5py.

To install PyMPDATA-MPI, first we recommend installing MPI-compatible h5py and then downloading the package via pip:

HDF5_MPI="ON" pip install --no-binary=h5py h5py
pip install PyMPDATA-MPI

Examples gallery

We strongly encourage to take a look at out examples gallery availible on Github.

Contributing, reporting issues, seeking support

Submitting new code to the project, please preferably use GitHub pull requests it helps to keep record of code authorship, track and archive the code review workflow and allows to benefit from the continuous integration setup which automates execution of tests with the newly added code.

Design goals

• MPI support for PyMPDATA implemented externally (i.e., not incurring any overhead or additional dependencies for PyMPDATA users)
• MPI calls within Numba njitted code (hence not using mpi4py, but rather numba-mpi)
• hybrid domain-decomposition parallelism: threading (internal in PyMPDATA, in the inner dimension) + MPI (either inner or outer dimension)
• example simulation scenarios featuring HDF5/MPI-IO output storage (using h5py)
• py-modelrunner simulation orchestration
• portability across Linux & macOS (no Windows support as of now due to challenges in getting HDF5/MPI-IO to work there)
• Continuous Integration (CI) with different OSes and different MPI implementations (leveraging to mpi4py's setup-mpi Github Action)
• full test coverage including CI builds asserting on same results with multi-node vs. single-node computations (with help of pytest-mpi)
• ships as a pip-installable package - aimed to be a dependency of domain-specific packages

Credits & acknowledgments:

PyMPDATA-MPI started as a separate project for the MSc thesis of Kacper Derlatka (@Delcior). Integration of PyMPDATA-MPI into PyMPDATA repo was carried out as a part of BEng project of Michał Wroński.

Development of PyMPDATA-MPI has been supported by the Poland's National Science Centre (grant no. 2020/39/D/ST10/01220).

We acknowledge Poland’s high-performance computing infrastructure PLGrid (HPC Centers: ACK Cyfronet AGH) for providing computer facilities and support within computational grants no. PLG/2023/016369 and no. PLG/2024/017823.

copyright: Jagiellonian University & AGH University of Krakow licence: GPL v3