windkit.io.windio.read_plant#

windkit.io.windio.read_plant(path, resolve=False)[source]#

Parse a windIO plant YAML file.

Warning

windIO support is experimental. API may change in future versions.

Parameters:

  • path (str or pathlib.Path) – Path to windIO plant YAML file.

  • resolve (bool, optional) – If True, eagerly resolve all !include markers. Default is False (markers are preserved for lazy resolution).

Returns:

Parsed YAML as nested dictionary. !include directives are preserved as-is (not resolved) unless resolve is True.

Return type:

dict

Raises:

  • FileNotFoundError – If file does not exist.

  • yaml.YAMLError – If YAML parsing fails.

Examples

>>> from windkit.io.windio import read_plant
>>> data = read_plant("site.yaml")
>>> print(data["name"])
'My Wind Farm'
On this page