windIO is a data format for inputs and outputs to wind energy system computational models. Historically, it has focused on systems engineering models, but it has been adopted in other topic areas of wind energy modeling, as well. The windIO data format is a community-focused effort to standardize the data format for wind energy system models, and we encourage collaboration. The github repository is at https://github.com/IEAWindSystems/windIO and the online documentation is at https://ieawindsystems.github.io/windIO.
The windIO repository includes the following:
- Schema defining windIO components describing wind turbines and wind plants
- Python library for validating files relative to the schema and loading the data into a Python dictionary
- windIO input files for test-case wind turbine and wind plant models
Reference wind turbines designed within the IEA Wind Systems Engineering Task are available at the following links:
- IEA onshore 3.4 MW
- IEA offshore 10.0 MW
- IEA floating 15.0 MW
- IEA 22-MW offshore
- IEA Wind 740-10-MW Reference Offshore Wind Plants
If you use this model in your research or publications, please cite this [IEA technical report](https://doi.org/10.2172/1868328):
- @article{osti_1868328,
- title = {System Modeling Frameworks for Wind Turbines and Plants: Review and Requirements Specifications}, author = {Bortolotti, Pietro and Bay, Christopher and Barter, Garrett and Gaertner, Evan and Dykes, Katherine and McWilliam, Michael and Friis-Moller, Mikkel and Molgaard Pedersen, Mads and Zahle, Frederik}, doi = {10.2172/1868328}, place = {United States}, year = {2022}, month = {5}
}
Author: IEA Wind Task 37 Team
windIO is typically included as a dependency in software that uses the windIO data format, so users will normally not need to install it directly. However, it can be useful to install the windIO package to access version converters or during integration into a software package. In that case, windIO can be installed from PyPI with the following command:
pip install windIOThe windIO data format is defined by the schemas included in this repository. In order for a software to support windIO, it must support the data as described in the schemas and use the included functions to validate the data. windIO should be included as a dependency. It is distributed through PyPI and can be installed as a package with pip. The suggested method of incorporating windIO into your code is:
import windIO
# Other code here
windIO.validate(input="path/to/input.yaml", schema_type="plant/wind_energy_system <for example>")
windIO.load_yaml("path/to/input.yaml")
# Conversion to your software's data structures here