windkit.io.windio.write_plant#

windkit.io.windio.write_plant(data, path, modular=False)[source]#

Write a dictionary to windIO plant YAML format.

Warning

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

Parameters:

  • data (dict) – Dictionary following windIO plant schema structure.

  • path (str or pathlib.Path) – Output file path. When modular=True, this becomes a directory path and the main plant file is written as plant.yaml inside it.

  • modular (bool) – If True, write modular files with !include references: - plant.yaml (main file with !include references) - site.yaml - energy_resource.yaml (if present) - wind_resource.yaml (if present) - wind_farm.yaml (if present)

Returns:

When modular=True, returns the plant dict with !include markers. When modular=False (default), returns None.

Return type:

dict or None

Examples

>>> from windkit.io.windio import write_plant
>>> data = {
...     "name": "My Wind Farm",
...     "site": {...},
...     "wind_farm": {...}
... }
>>>
>>> # Single file output
>>> write_plant(data, "output.yaml")
>>>
>>> # Modular output with !include references
>>> write_plant(data, "output_dir/", modular=True)
>>> # Creates: output_dir/plant.yaml, output_dir/site.yaml, etc.
On this page