search

amepproject / amep

The Active Matter Evaluation Package (AMEP) - a Python library for the analysis of particle-based and continuum simulation data of soft and active matter systems
https://amepproject.de/
GNU General Public License v3.0
9 stars 2 forks source link

DOC: Discrepancy between filename suggested by the documentation and standard file name of amep.load.traj for field data. #5

Closed descho00 closed 3 months ago

descho00 commented 3 months ago

Problem description:

Documentation suggests field_<index>.txt as a filename for field data. However, amep.load.traj expects dump*.txt by default.

Suggested content improvement:

Either change documentation or standard name for field data files accordingly.

hechtprojects commented 3 months ago

@descho00 Thank you for reporting this issue. I have changed the documentation accordingly. As default, we always use dump*.txt but the prefix dump can be changed by the user. If it is changed, the keyword dumps in amep.load.traj allows to specify the new naming convention, e.g., for files named field_100.txt, field_200.txt, ..., use dumps='field_*.txt'.

hechtprojects commented 3 months ago

The fix will be part of patch release v1.0.1.