Installation
============

:ref:`MPIRE <secret>` builds are distributed through PyPi_.

.. _PyPi: https://pypi.org/

MPIRE can be installed through pip:

.. code-block:: bash

    pip install mpire

.. note::

    MPIRE is only available for Python >= 3.6.

Dependencies
------------

- Python >= 3.6

Python packages (installed automatically when installing MPIRE):

- multiprocess
- numpy
- tqdm

.. _dashboarddep:

Dashboard
~~~~~~~~~

Optionally, you can install the dependencies for the MPIRE dashboard, which depends on Flask_. 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:

.. code-block:: bash

    pip install mpire[dashboard]

.. _Flask: https://flask.palletsprojects.com/en/1.1.x/