amep.reader.H5amepReader#

class amep.reader.H5amepReader(directory, trajfile='traj.h5amep', **kwargs)#

Bases: BaseReader

Reads simulation data from an HDF5 trajectory file.

__init__(directory, trajfile='traj.h5amep', **kwargs)#

Reader for an HDF5 trajectory file of name filename in the given directory.

Parameters:
  • directory (str) – Simulation directory.

  • trajfile (str, optional) – File name of the HDF5 file. The default is TRAJFILENAME.

  • **kwargs – Additional keyword arguments are ignored.

Return type:

None.

Methods

__init__(directory[, trajfile])

Reader for an HDF5 trajectory file of name filename in the given directory.

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.

type

The type of trajectory.

version

AMEP version with which the h5amep file has been created.

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.

property type#

The type of trajectory. Field or Particles.

property version#

AMEP version with which the h5amep file has been created.

Returns:

Version.

Return type:

str