windkit.io.windio.read_energy_resource#

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

Parse a windIO energy_resource YAML file and wrap in plant structure.

Warning

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

This function reads a standalone energy_resource file and wraps it in a minimal plant structure so it can be used with the from_windio translation functions.

Parameters:

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

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

Returns:

Plant-like dictionary with the energy_resource data.

Return type:

dict

Raises:

FileNotFoundError – If file does not exist.

Examples

>>> from windkit.io.windio import read_energy_resource
>>> from windkit.io.windio.translate import wwc_from_windio
>>> plant_data = read_energy_resource("energy_resource.yaml")
>>> wwc = wwc_from_windio(plant_data, crs="EPSG:32632")
On this page