opal package

Subpackages

opal.config module

opal.opal module

opal.opal._append_dataset(datasets, ftype, astype, directory, fname)[source]

Append a dataset to the list.

Parameters:

  • datasets (list) – Collection of datasets

  • ftype (FileType) – Type of file to read in

  • astype (FileType) – Read a file according some dataset type E.g. OPAL standard output contains timings as well.

  • directory (str) – Root directory of the OPAL simulation

  • fname (str) – File to read in

Returns:

True if reading is stopped (i.e. sampler, optimizer and AMR datasets), False otherwise.

Return type:

bool

opal.opal.load_dataset(directory, **kwargs)[source]

Load any file(s) produced by an OPAL simulation.

If neither ftype nor fname is specified it tries to read in a *.stat file.

Parameters:

  • directory (str) – Root directory of the OPAL simulation

  • ftype (FileType, optional) – Type of file to read in

  • fname (str or tuple, optional) – File(s) to read in

  • astype (FileType, optional) – Read a file according some dataset type E.g. OPAL standard output contains timings as well.