a2rl.read_metadata#

a2rl.read_metadata(yaml_file)[source]#

Load a YAML file into an in-memory metadata object.

Parameters:: yaml_file (str | Path) – Path to the input YAML file.
Return type:: Metadata
Returns:: In-memory, metadata object

See also

Metadata, save_metadata

Examples

Read the metadata of the chiller sample dataset.

>>> import a2rl as wi
>>> p = wi.sample_dataset_path("chiller") / "metadata.yaml"
>>> m = wi.read_metadata(p)
>>> m.states
['condenser_inlet_temp', 'evaporator_heat_load_rt']