amep.base.BaseReader#

class amep.base.BaseReader(savedir: str, start: float, stop: float, nth: int, filename: str)#

Bases: object

Base class to read simulation data from output files and to convert it into the hdf5 file format.

__init__(savedir: str, start: float, stop: float, nth: int, filename: str) None#

Initializes a BaseReader object.

Parameters:
  • savedir (str) – Directory in which the .h5amep file is created.

  • start (int) – Start reading the trajectory data from this fraction of the trajectory.

  • stop (int) – Stop reading the trajectory data from this fraction of the trajectory.

  • nth (int) – Read each nth frame.

  • filename (str) – Name of the trajectory file that is created. Needs to be an .h5amep file.

Return type:

None

Methods

__init__(savedir, start, stop, nth, filename)

Initializes a BaseReader object.

Attributes

d

dt

filename

The path to the HDF5-file that contains the writers data.

nth

savedir

start

steps

The array of simulation steps for each saved frame.

stop

times

The array of physical times for each saved frame.

property filename: Path#

The path to the HDF5-file that contains the writers data.

property steps: ndarray#

The array of simulation steps for each saved frame.

The simulation steps are also used to index the frame data in the HDF5-File.

property times#

The array of physical times for each saved frame.