load_habitat_config

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_config(path: str | Path) → Dict[str, Any]

Load and structurally validate a v1 habitat YAML document.

Parameters:

path – YAML file written by save_habitat_config() (or equivalent).

Returns:

The validated document mapping.

Raises:

• FileNotFoundError – When path does not exist.

• HABITAPIError – When the file is not a valid habitat v1 document.