|
1 | 1 | Parallelization |
2 | 2 | =============== |
3 | 3 |
|
4 | | -``mdadash`` supports running Widgets in parallel. It uses `Joblib`_ with the default |
| 4 | +`mdadash`_ supports running Widgets in parallel. It uses `Joblib`_ with the default |
5 | 5 | ``loky`` backend to run the parallel jobs as separate processes. A global "Parallel Jobs" |
6 | 6 | under "Settings > Dashboard Configuration" in the dasboard controls the total number of jobs |
7 | 7 | that can run in parallel (``n_jobs`` param for `joblib.Parallel`_ call). |
8 | 8 |
|
9 | | -All the analyses that run in ``mdadash`` are CPU-bound and hence a Process-based parallelism |
| 9 | +All the analyses that run in `mdadash`_ are CPU-bound and hence a Process-based parallelism |
10 | 10 | is chosen instead of Thread-based parallelism. |
11 | 11 |
|
12 | 12 | `IMDReader`_ uses `imdclient`_ to connect to a live MD simulation. Because of the use of a |
13 | | -network socket within `imdclient`_, this is not serializable by default. ``mdadash`` patches |
| 13 | +network socket within `imdclient`_, this is not serializable by default. `mdadash`_ patches |
14 | 14 | `IMDReader`_ to remove `imdclient`_ from the serialization state since the trajectory is never |
15 | 15 | iterated using `imdclient`_ within a parallel job. This makes parallelization possible within |
16 | | -``mdadash`` for streaming trajectories. |
| 16 | +`mdadash`_ for streaming trajectories. |
17 | 17 |
|
18 | 18 | A Widget class that supports a ``parallel`` :ref:`_run_mode <run-mode>` must implement |
19 | 19 | :meth:`~mdadash.backend.widgets.base.WidgetBase.get_parallel_job` and |
@@ -46,6 +46,8 @@ The list of all the Widgets that can be run in parallel can be found on the |
46 | 46 | :doc:`built_in_widgets` page. |
47 | 47 |
|
48 | 48 |
|
| 49 | +.. _mdadash: https://github.com/MDAnalysis/mdadash |
| 50 | + |
49 | 51 | .. _Joblib: https://joblib.readthedocs.io/en/stable/ |
50 | 52 |
|
51 | 53 | .. _joblib.Parallel: https://joblib.readthedocs.io/en/stable/generated/joblib.Parallel.html |
|
0 commit comments