this branch fixes #37 and #47

amepproject · Oct 18, 2024 · 2d6db15 · 2d6db15
1 parent 1336a73
commit 2d6db15
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/amep/reader.py b/amep/reader.py
@@ -1113,6 +1113,11 @@ def __init__(
         r'''
         Reader for simulation data in the gsd file format (hoomd-blue).
 
+        Note: The gsd file format does not save the (physical) time.
+            Only the timestep is saved. By supplying the simulation 
+            timestep `dt`, the (physical) time will be calculated.
+            The default for `dt` is 1.
+
         Parameters
         ----------
         directory : str