Skip to content

Commit b643516

Browse files
Make mdadash a link in docs
1 parent cd0bad6 commit b643516

4 files changed

Lines changed: 19 additions & 10 deletions

File tree

docs/source/batching.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ in `IMDReader`_.
1111
Buffered Access
1212
---------------
1313

14-
To support buffered, time-dependent analyses in ``mdadash``, a
14+
To support buffered, time-dependent analyses in `mdadash`_, a
1515
:class:`~mdadash.backend.kernel.core.BufferedTrajectory` is introduced.
1616

1717
The original trajectory is wrapped by the :class:`~mdadash.backend.kernel.core.BufferedTrajectory`
@@ -96,6 +96,8 @@ The list of all the Widgets that support batching can be found on the
9696
:doc:`built_in_widgets` page.
9797
9898
99+
.. _mdadash: https://github.com/MDAnalysis/mdadash
100+
99101
.. _IMDReader: https://docs.mdanalysis.org/stable/
100102
documentation_pages/coordinates/IMD.html
101103

docs/source/getting_started.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Getting Started
22
===============
33

4-
This page details how to get started with ``mdadash``.
4+
This page details how to get started with `mdadash`_.
55

66
Installation
77
~~~~~~~~~~~~
88

9-
``mdadash`` can be installed in any of the following ways depending on
9+
`mdadash`_ can be installed in any of the following ways depending on
1010
your Python environment:
1111

1212
.. code:: sh
@@ -41,7 +41,7 @@ To execute directly from an isolated environment without installing:
4141
Run
4242
~~~
4343

44-
Once the package is installed, it can be run using the ``mdadash``
44+
Once the package is installed, it can be run using the `mdadash`_
4545
command to start the dashboard server:
4646

4747
.. code:: sh
@@ -107,3 +107,5 @@ The dashboard can be accessed by navigating to
107107
108108
.. image:: _static/images/cover-image.png
109109
:alt: MDAnalysis Dashboard
110+
111+
.. _mdadash: https://github.com/MDAnalysis/mdadash

docs/source/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to ``mdadash`` documentation!
6+
Welcome to `mdadash`_ documentation!
77
=====================================
88

9-
Source code and contributing instructions for this project can be found in the `GitHub Repository <https://github.com/MDAnalysis/mdadash>`_.
9+
Source code and contributing instructions for this project can be found in the
10+
GitHub Repository: https://github.com/MDAnalysis/mdadash.
1011

1112
.. toctree::
1213
:maxdepth: 2
@@ -26,3 +27,5 @@ Indices and tables
2627

2728
* :ref:`genindex`
2829
* :ref:`modindex`
30+
31+
.. _mdadash: https://github.com/MDAnalysis/mdadash

docs/source/parallelization.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
Parallelization
22
===============
33

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
55
``loky`` backend to run the parallel jobs as separate processes. A global "Parallel Jobs"
66
under "Settings > Dashboard Configuration" in the dasboard controls the total number of jobs
77
that can run in parallel (``n_jobs`` param for `joblib.Parallel`_ call).
88

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
1010
is chosen instead of Thread-based parallelism.
1111

1212
`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
1414
`IMDReader`_ to remove `imdclient`_ from the serialization state since the trajectory is never
1515
iterated using `imdclient`_ within a parallel job. This makes parallelization possible within
16-
``mdadash`` for streaming trajectories.
16+
`mdadash`_ for streaming trajectories.
1717

1818
A Widget class that supports a ``parallel`` :ref:`_run_mode <run-mode>` must implement
1919
: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
4646
:doc:`built_in_widgets` page.
4747

4848

49+
.. _mdadash: https://github.com/MDAnalysis/mdadash
50+
4951
.. _Joblib: https://joblib.readthedocs.io/en/stable/
5052

5153
.. _joblib.Parallel: https://joblib.readthedocs.io/en/stable/generated/joblib.Parallel.html

0 commit comments

Comments
 (0)