windkit.io.windio.write_wind_farm#

windkit.io.windio.write_wind_farm(data, path)[source]#

Write a dictionary to windIO wind_farm YAML format.

Warning

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

Writes a wind_farm-level dictionary suitable for use as a standalone file that can be referenced via !include from a plant file.

Parameters:

  • data (dict) – Dictionary following the windIO wind_farm schema structure, containing layouts, turbine_types, etc.

  • path (str or pathlib.Path) – Output file path.

Examples

>>> from windkit.io.windio import write_wind_farm, compose_wind_farm
>>> wind_farm = compose_wind_farm(turbines, wtgs={"IEA_10MW": wtg})
>>> write_wind_farm(wind_farm, "wind_farm.yaml")
On this page