Skip to content

Commit a644d7d

Browse files
orbeckstljwoods2
andauthored
Apply suggestions from code review
Co-authored-by: ljwoods2 <[email protected]>
1 parent 5ca8a6d commit a644d7d

File tree

1 file changed

+3
-2
lines changed
  • doc/source/formats/reference

1 file changed

+3
-2
lines changed

doc/source/formats/reference/imd.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ The IMDReader provides access to additional simulation data through ``ts.data``:
277277

278278
* ``dt``: Time step size in picoseconds
279279
* ``step``: Current simulation step number
280-
* Energy terms: ``potential_energy``, ``total_energy``, etc. (IMD-streamed in NAMD and GROMACS only)
280+
* Energy terms: ``potential_energy``, ``total_energy``, etc. (available as an option in NAMD and GROMACS only)
281281

282282
.. code-block:: python
283283
@@ -312,7 +312,8 @@ Compatible Analysis
312312
- :class:`~MDAnalysis.analysis.rdf.InterRDF` - Frame-by-frame radial distribution function calculations
313313
- :class:`~MDAnalysis.analysis.dihedrals.Dihedral` - Dihedral angle accumulation for conformational analysis
314314
- :class:`~MDAnalysis.analysis.lineardensity.LinearDensity` - Density profile building over streaming frames
315-
315+
.. note::
316+
Passing any backend other than ``backend="serial"`` to these analysis classes will cause them to fail since streams are single-pass and forward-only.
316317
**What doesn't work:**
317318

318319
* **Multi-pass analyses**: Methods requiring multiple trajectory passes, for example:

0 commit comments

Comments
 (0)