Skip to content

Commit 4829f19

Browse files
orbeckstljwoods2Copilot
authored
Apply suggestions from code review
Co-authored-by: ljwoods2 <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent a499695 commit 4829f19

File tree

1 file changed

+5
-5
lines changed
  • doc/source/formats/reference

1 file changed

+5
-5
lines changed

doc/source/formats/reference/imd.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ IMD (Data streamed via Interactive Molecular Dynamics protocol v3)
77

88
.. include:: classes/IMD.txt
99

10-
Real-time streaming of simulation data between molecular dynamics engines and receiving clients can be achieved using IMD protocols like IMDv2 and IMDv3. The :class:`~MDAnalysis.coordinates.IMD.IMDReader` implements the IMDv3 protocol, enabling live streaming of ongoing simulation data.
10+
IMDv2 and IMDv3 enable real-time streaming of simulation data between molecular dynamics engines and receiving clients. The :class:`~MDAnalysis.coordinates.IMD.IMDReader` implements the IMDv3 protocol.
1111

1212
.. note::
13-
MDAnalysis supports **IMDv3 only**, which provides continuous, gap-free streaming and is implemented in modern versions of GROMACS, LAMMPS, and NAMD. IMDv2, while widely available, was designed primarily for visualization and allows gaps in the data stream.
13+
MDAnalysis supports **IMDv3 only**, which provides continuous, gap-free streaming and is implemented in modern versions of GROMACS, LAMMPS, and NAMD. IMDv2, while widely available, was designed primarily for visualization and doesn't enforce a consistent number of integration steps between transmitted frames
1414

1515
What is Streaming?
1616
==================
1717

1818
Streaming involves processing data in real-time as it is generated, rather than storing it for later analysis. In molecular dynamics, this means sending simulation data to a client on-the-fly while the simulation is running, without writing large trajectory files to disk.
1919

20-
This can be achieved through a TCP/IP socket connection between the simulation engine and receiving client, transmitting coordinates, velocities, forces, energies, and timing information using the IMDv3 protocol.
20+
In IMDv3, this is achieved through a TCP/IP socket connection between the simulation engine and receiving client, transmitting coordinates, velocities, forces, energies, and timing information.
2121

2222
MDAnalysis's :class:`~MDAnalysis.coordinates.IMD.IMDReader` uses the `imdclient <https://imdclient.readthedocs.io/>`_ package and provides a familiar interface for reading streaming data, similar to other trajectory readers in MDAnalysis.
2323

@@ -56,7 +56,7 @@ The IMDReader requires the ``imdclient`` package:
5656
MD Engine Configuration
5757
-----------------------
5858

59-
We provide below example configurations for enabling IMDv3 streaming in popular MD engines.
59+
We provide example configurations below for enabling IMDv3 streaming in popular MD engines.
6060

6161
**GROMACS**
6262

@@ -195,7 +195,7 @@ For compute-intensive analysis, increase the buffer size to reduce communication
195195
Connection Management
196196
---------------------
197197

198-
Always ensure proper cleanup, especially in interactive environments like Jupyter notebooks et al.:
198+
Always ensure proper cleanup, especially in interactive environments like Jupyter notebooks and other interactive environments:
199199

200200
.. code-block:: python
201201

0 commit comments

Comments
 (0)