adjustments

IRL2 · Sep 26, 2024 · 86c4ff0 · 86c4ff0
1 parent 92810d7
commit 86c4ff0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/python-libraries/nanover-omni/src/nanover/omni/omni.py b/python-libraries/nanover-omni/src/nanover/omni/omni.py
@@ -125,7 +125,7 @@ def simulation(self):
     @property
     def is_paused(self):
         """
-        Is the currently selected simulation paused?
+        :return: True if the current simulation is paused, False otherwise.
         """
         return self._runner.is_paused if self._runner is not None else None
 

diff --git a/python-libraries/nanover-omni/src/nanover/omni/openmm.py b/python-libraries/nanover-omni/src/nanover/omni/openmm.py
@@ -17,10 +17,13 @@
 
 class OpenMMSimulation:
     """
-    A wrapper for OpenMM simulations so they can be run inside the OmniRunner.
+    A wrapper for OpenMM simulations to run inside the OmniRunner.
 
-    The following attributes can be configured after construction: :attr:`frame_interval`, :attr:`include_velocities`,
-    :attr:`include_forces`
+    The following attributes can be configured after construction:
+    - :attr:`frame_interval`: Number of simulation steps to advance between frames.
+    - :attr:`include_velocities`: Include particle velocities in frames.
+    - :attr:`include_forces`: Include particle forces in frames.
+    - :attr:`platform_name`: Name of OpenMM platform to use when loading the system from XML.
     """
 
     @classmethod