hdf5_recorder.py

Class definition for HDF5Recorder, which uses the HDF5 format.

class openmdao.recorders.hdf5_recorder.HDF5Recorder(out, **driver_kwargs)[source]

Bases: openmdao.recorders.base_recorder.BaseRecorder

A recorder that stores data using HDF5. This format naturally handles hierarchical data and is a standard for handling large datasets.

Args:

out : str

String containing the filename for the HDF5 file.

**driver_kwargs

Additional keyword args to be passed to the HDF5 driver.

record(params, unknowns, resids, metadata)[source]

Stores the provided data in the HDF5 file using the iteration coordinate for the Group name.

Args:

params : dict

Dictionary containing parameters. (p)

unknowns : dict

Dictionary containing outputs and states. (u)

resids : dict

Dictionary containing residuals. (r)

metadata : dict, optional

Dictionary containing execution metadata (e.g. iteration coordinate).