PyEPFD uses the mpi4py package for parallelization. An existing MPI implementation (e.g. MPICH or OpenMPI) is required to install mpi4py and PyEPFD. Many supercomputers provide modules for pre-compiled MPI implementations. To install MPI manually (taking MPICH as example), execute the following command on Linux

$ sudo apt-get install mpich libmpich-dev

or the following command on Mac

$ brew install mpich

It is recommended to install PyEPFD using pip. First, clone the git repository into a local directory

$ git clone

Then, execute pip in the folder containing

$ pip install .


$ pip3 install .

PyEPFD depends on the following packages, which will be installed automatically if installed through pip

  • numpy

  • scipy

  • mpi4py

If using pip is not possible, one can manually install the above dependencies, and then go to the directory where file is located and use the following command,

$ source

This would create PyEPFD environment for that terminal session. You can also put the following lines in your .bashrc so that the environment is always available.

source /path/to/PyEPFD/

Hope you will find PyEPFD helpful for your research!