Installation

PMMoTo requires a functioning MPI environment to achieve optimal performance on distributed memory systems. You may install OpenMPI or MPICH, depending on your system and preference:

• On macOS (with Homebrew):

  brew install open-mpi
  # or
  brew install mpich
  

• On Ubuntu/Debian:

  sudo apt install libopenmpi-dev openmpi-bin
  # or
  sudo apt install libmpich-dev mpich
  

Once MPI is installed, install PMMoTo from PyPI:

pip install pmmoto

If you’re installing from source for the first time:

git clone https://github.com/tmweigand/pmmoto.git
cd pmmoto
pip install -e .

Note

For testing of PMMoTo, the developer mode dev must be specified to install the necessary dependencies. Please see Installation for Development for detailed instructions.

To visualize PMMoTo’s .vti and .vtp output files, install ParaView.

• On macOS:

  brew install --cask paraview
  

• On Ubuntu/Debian:

  sudo apt install paraview
  

Note

For some systems, the latest executable version of ParaView may be required and can be found at: https://www.paraview.org/download/