Skip to content

Commit 030cba0

Browse files
committed
Update documentation and README according to auto LeafletFinder updates
1 parent 9c7aa62 commit 030cba0

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ With DomHMM you can:
2323

2424
- Calculate the area per lipid for each lipid in every leaflet.
2525
- Compute the average S<sub>CC</sub> parameter for each acyl chain of every lipid.
26-
- Easily identify lateral nano- and microdomains in your membrane simulations.
26+
- Identify lateral nano- and microdomains in your membrane simulations.
2727

2828
Documentation
2929
--------------
@@ -157,7 +157,6 @@ tails = {"DPPC": [["C1B", "C2B", "C3B", "C4B"], ["C1A", "C2A", "C3A", "C4A"]],
157157
sterol_heads = {"CHOL": "ROH"}
158158
sterol_tails = {"CHOL": ["ROH", "C1"]}
159159
model = domhmm.PropertyCalculation(universe_or_atomgroup=uni,
160-
leaflet_kwargs={"select": "name PO4", "pbc": True},
161160
membrane_select=membrane_select,
162161
leaflet_select="auto",
163162
heads=heads,

docs/source/how-to-run.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ DomHMM's main class is ``PropertyCalculation``. In a basic example, it is initia
1414
.. code-block::
1515
1616
model = domhmm.PropertyCalculation(universe_or_atomgroup=universe,
17-
leaflet_kwargs=leaflet_kwargs,
1817
membrane_select=membrane_select,
1918
leaflet_select="auto",
2019
heads=heads,
@@ -42,21 +41,14 @@ Let's dive into each parameter's details.
4241
path2tpr = "YOUR_TPR_FILE.tpr"
4342
universe = mda.Universe(path2tpr, path2xtc)
4443
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.
46-
47-
.. code-block::
48-
49-
# An example where all lipids head group is PO4
50-
leaflet_kwargs={"select": "name PO4", "pbc": True}
51-
5244
* ``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``
5345

5446
.. code-block::
5547
5648
# An example where simulation contains DPPC and DIPC lipids, and CHOL sterol
5749
membrane_select = "resname DPPC DIPC CHOL"
5850
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.
6052

6153
.. code-block::
6254
@@ -143,6 +135,13 @@ Option for saving result plots in pdf format.
143135

144136
Verbose option for debugging. It shows which steps are done in the analysis.
145137

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.
139+
140+
.. code-block::
141+
142+
# An example where all lipids head group is PO4
143+
leaflet_kwargs={"select": "name PO4", "pbc": True}
144+
146145
* ``lipid_leaflet_rate``
147146

148147
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.

docs/source/post-analysis.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,6 @@ Users can save and reload the model itself or required data via `pickle`_.
7373
7474
7575
.. 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.
7777

7878
.. _pickle: https://www.mdanalysis.org/pages/mdakits/

0 commit comments

Comments
 (0)