Skip to content

Commit 08c6643

Browse files
* Update based on PR MDAnalysis#64
1 parent d3eb0e5 commit 08c6643

2 files changed

Lines changed: 20 additions & 9 deletions

File tree

docs/source/built_in_widgets.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ and can run in parallel:
1818
- ✅
1919
* - :mod:`~mdadash.backend.analyses.com_distance`
2020
- Distance between two center-of-masses
21-
-
22-
-
21+
-
22+
-
2323
* - :mod:`~mdadash.backend.analyses.contacts`
2424
- Contacts within a cutoff
2525
- ✅
@@ -46,8 +46,8 @@ and can run in parallel:
4646
- ✅
4747
* - :mod:`~mdadash.backend.analyses.janin`
4848
- Janin plot (Dihedral angles analysis)
49-
-
50-
-
49+
-
50+
-
5151
* - :mod:`~mdadash.backend.analyses.msd`
5252
- MSD Analysis
5353
- —
@@ -58,8 +58,8 @@ and can run in parallel:
5858
- ✅
5959
* - :mod:`~mdadash.backend.analyses.ramachandran`
6060
- Ramachandran plot (Dihedral angles analysis)
61-
-
62-
-
61+
-
62+
-
6363
* - :mod:`~mdadash.backend.analyses.rmsd`
6464
- RMSD Analysis
6565
- ✅

mdadash/backend/analyses/com_distance.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,18 @@ class COMDistance(WidgetBase):
2626
2727
**Inputs**
2828
29-
Selection 1
29+
Run frequency
3030
.. compound::
31-
First MDAnalysis selection phrase
32-
Default: ``protein``
31+
The frequency with which the widget is run - `every-frame` or `batch`
32+
Default: ``every-frame``
33+
34+
Run mode
35+
The mode in which the widget is run - `serial` or `parallel`
36+
Default: ``serial``
37+
38+
Selection 1
39+
First MDAnalysis selection phrase
40+
Default: ``protein``
3341
3442
Selection 2
3543
Second MDAnalysis selection phrase
@@ -74,6 +82,9 @@ class COMDistance(WidgetBase):
7482
.. figure:: /_static/images/com_distance_output.jpg
7583
:alt: COM Distance output
7684
85+
.. tip::
86+
This widget supports batching and can run in parallel
87+
7788
"""
7889

7990
name = "COMDistance"

0 commit comments

Comments
 (0)