load_habitat_spec

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

load_habitat_spec(path: str | Path) → HabitatSpec[source]

Load a HabitatSpec from its YAML form.

Parameters:: path – YAML file holding a HabitatSpec.to_dict payload.
Returns:: The parsed specification.