Skip to content

Installation

maybempi is pure Python with no dependencies. It needs Python 3.10 or newer.

Terminal window
pip install maybempi

To run under MPI, install mpi4py as well, built against the MPI library of your system:

Terminal window
pip install "maybempi[mpi]" # same as: pip install maybempi mpi4py

Without mpi4py, every process of an mpirun job runs serially as rank 0 of 1, and maybempi.get_mpi() warns about it.

Check what maybempi decides in an environment with the maybempi command (or python -m maybempi):

Terminal window
maybempi # in a terminal: serial
mpirun -n 2 maybempi --init # rank 0 prints one table: rank, host, launcher variable, ...
Terminal window
git clone https://github.com/max-models/maybempi.git
cd maybempi
pip install -e ".[dev]"
ExtraInstalls
mpimpi4py
testpytest, pytest-cov and NumPy
docsthe notebook runner, NumPy and griffe for the API reference
devformatters and linters, plus the test and docs extras