amep.base.BaseEvaluation

class amep.base.BaseEvaluation

Bases: object

Evaluation base class.

__init__() → None

Evaluation base object containing general attributes needed for evaluation functions applied to simulation data.

Return type:

None.

Methods

__init__()	Evaluation base object containing general attributes needed for evaluation functions applied to simulation data.
items()
keys()
save(path[, backup, database, name])	Stores the evaluation result in an HDF5 file.
values()

Attributes

name

save(path: str, backup: bool = True, database: bool = False, name: str | None = None) → None

Stores the evaluation result in an HDF5 file.

Parameters:

• path (str) – Path of the ‘.h5’ file in which the data should be stored. If only a directory is given, the filename is chosen as self.name. Raises an error if the given directory does not exist or if the file extension is not ‘.h5’.

• backup (bool, optional) – If True, an already existing file is backed up and not overwritten. This keyword is ignored if database=True. The default is True.

• database (bool, optional) – If True, the results are appended to the given ‘.h5’ file if it already exists. If False, a new file is created and the old is backed up. If False and the given ‘.h5’ file contains multiple evaluation results, an error is raised. In this case, database has to be set to True. The default is False.

• name (str or None, optional) – Name under which the data should be stored in the HDF5 file. If None, self.name is used. The default is None.

Return type:

None.