files#

HDF5 writing.

This module contains classes and functions that allow OM to load data from files in HDF5 format.

load_hdf5_data(*, hdf5_filename, hdf5_path)#

Loads data from an HDF5 file.

This function loads data from an HDF5 file.

Parameters:

hdf5_filename (Path) – The relative of absolute path to an HDF5 file containing the data to load.
hdf5_path (str) – The internal path, within the HDF5 file, to the block storing the data to load.

Returns:

The loaded data.

Raises:

OmHdf5FileReadingError – Raised if an error is encountered while reading the file.

Return type:

ndarray[Any, dtype[int64 | float64]]

load_configuration_parameters(*, config)#

#TODO: Documentation