1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
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
and is available through conda-forge:
.. code-block:: bash
conda install -c conda-forge mpire
Dependencies
------------
- Python >= 3.8
Python packages (installed automatically when installing MPIRE):
- tqdm
- pygments
- pywin32 (Windows only)
- importlib_resources (Python < 3.9 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.
.. _dilldep:
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:
.. code-block:: bash
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 :obj:`mpire.WorkerPool` constructor.
.. _dill: https://pypi.org/project/dill/
.. _multiprocess: https://github.com/uqfoundation/multiprocess
.. _BSD license of multiprocess: https://github.com/uqfoundation/multiprocess/blob/master/LICENSE
.. _richdep:
Rich progress bars
~~~~~~~~~~~~~~~~~~
If you want to use rich_ progress bars, you have to install the dependencies for it manually:
.. code-block:: bash
pip install rich
.. _rich: https://github.com/Textualize/rich
.. _dashboarddep:
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:
.. code-block:: bash
pip install mpire[dashboard]
.. _Flask: https://flask.palletsprojects.com/en/1.1.x/
.. _BSD license of Flask: https://github.com/pallets/flask/blob/main/LICENSE.rst
|
