You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/how-to-run.rst
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,6 @@ DomHMM's main class is ``PropertyCalculation``. In a basic example, it is initia
14
14
.. code-block::
15
15
16
16
model = domhmm.PropertyCalculation(universe_or_atomgroup=universe,
17
-
leaflet_kwargs=leaflet_kwargs,
18
17
membrane_select=membrane_select,
19
18
leaflet_select="auto",
20
19
heads=heads,
@@ -42,21 +41,14 @@ Let's dive into each parameter's details.
42
41
path2tpr = "YOUR_TPR_FILE.tpr"
43
42
universe = mda.Universe(path2tpr, path2xtc)
44
43
45
-
* ``leaflet_kwargs`` parameter stands for MDAnalysis ``LeafletFinder`` function's arguments. It is used to determine each leaflet's lipids. ``leaflet_kwargs`` requires head groups of lipids but not sterols.
* ``membrane_select`` argument is for atom group selection of universe. It is useful for simulations that contain non-membrane residues/molecules inside. If the universe contains only membrane elements, the parameter can be left in the default option which is ``all``
53
45
54
46
.. code-block::
55
47
56
48
# An example where simulation contains DPPC and DIPC lipids, and CHOL sterol
57
49
membrane_select = "resname DPPC DIPC CHOL"
58
50
59
-
* ``leaflet_select`` argument is a selection option for lipids which can be a list of atom groups, a list of string queries, or automatic via LeafletFinder.
51
+
* ``leaflet_select`` argument is a selection option for lipids which can be a list of atom groups, a list of string queries, or automatic via LeafletFinder. In automatic option, lipid head groups from ``heads`` parameter will be used for leaflet identification or user can setup with ``leaflet_kwargs`` optional parameter.
60
52
61
53
.. code-block::
62
54
@@ -143,6 +135,13 @@ Option for saving result plots in pdf format.
143
135
144
136
Verbose option for debugging. It shows which steps are done in the analysis.
145
137
138
+
* ``leaflet_kwargs`` parameter stands for MDAnalysis ``LeafletFinder`` function's arguments and used with ``leaflet_select="auto"`` option. It is used to determine each leaflet's lipids. ``leaflet_kwargs`` requires head groups of lipids but not sterols.
The frame rate for checking lipids leaflet assignments via LeafletFinder. In the default option, it is equal to 0 which means leaflet assignment is only done at the beginning of the analysis.
Copy file name to clipboardExpand all lines: docs/source/post-analysis.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,6 @@ Users can save and reload the model itself or required data via `pickle`_.
73
73
74
74
75
75
.. note::
76
-
When loading the full model, the MDAnalysis universe will load the trajectory and topology file from the same directory that was given in the analysis run. Therefore, full-model saving can't be loaded if files do not exist.
76
+
When loading the full model, the MDAnalysis universe will load the trajectory and topology file from the same directory that was given in the analysis run. Therefore, full-model saving may not be loaded from outside of analysis directory.
0 commit comments