Installation

MPIRE builds are distributed through PyPi.

MPIRE can be installed through pip:

pip install mpire

and is available through conda-forge:

conda install -c conda-forge mpire

Note

MPIRE is available for Python >= 3.6.

Dependencies

• Python >= 3.6

Python packages (installed automatically when installing MPIRE):

• tqdm

• dataclasses (Python 3.6 only)

• pygments

• pywin32 (Windows only)

Note

When using MPIRE on Windows with conda, you might need to install pywin32 using conda install pywin32 when encountering a DLL failed to load error.

Dill

For some functions or tasks it can be useful to not rely on pickle, but on some more powerful serialization backend, like dill. dill isn’t installed by default as it has a BSD license, while MPIRE has an MIT license. If you want to use it, the license of MPIRE will change to a BSD license as well, as required by the original BSD license. See the BSD license of multiprocess for more information.

You can enable dill by executing:

pip install mpire[dill]

This will install multiprocess, which uses dill under the hood. You can enable the use of dill by setting use_dill=True in the mpire.WorkerPool constructor.

Dashboard

Optionally, you can install the dependencies for the MPIRE dashboard, which depends on Flask. Similarly as with dill, Flask has a BSD-license. Installing these dependencies will change the license of MPIRE to BSD as well. See the BSD license of Flask for more information.

The dashboard allows you to see progress information from a browser. This is convenient when running scripts in a notebook or screen, or want to share the progress information with others. Install the appropriate dependencies to enable this:

pip install mpire[dashboard]