Tutorial Data

WindKit provides sample datasets to help you get started with examples and tutorials. These datasets are hosted on Zenodo and are automatically downloaded and cached locally when you first request them.

Downloading Tutorial Data

There are two ways to access tutorial data:

1. Get the path to data files using get_tutorial_data():

   import windkit as wk
   
   # Get the path to the tutorial data folder
   path = wk.get_tutorial_data("serra_santa_luzia")
   
   # Load files manually using windkit readers
   bwc = wk.read_bwc(path / "bwc.omwc")
   wtg = wk.read_wtg(path / "Bonus1MW.wtg")
   

2. Load data directly into memory using load_tutorial_data():

   # Load all data files into memory at once
   data = wk.load_tutorial_data("serra_santa_luzia")
   
   # Access loaded datasets as attributes
   # data.bwc       # Binned Wind Climate (xarray.Dataset)
   # data.wtg       # Wind Turbine Generator (xarray.Dataset)
   # data.turbines  # Wind Turbines (xarray.Dataset)
   # data.elev      # Elevation Map (geopandas.GeoDataFrame)
   # data.rgh       # Roughness Map (geopandas.GeoDataFrame)
   

Available Datasets

serra_santa_luzia

A wind farm site in Portugal with 15 turbines. This dataset includes:

• Wind climate data (binned wind climate)

• Wind turbine generator specifications (Bonus 1 MW)

• Turbine positions

• Elevation and roughness maps

The data is available in multiple formats (NetCDF, WAsP native formats, CSV, GeoPackage) to demonstrate different WindKit I/O capabilities.

Cache Location

Downloaded data is cached locally to avoid repeated downloads:

• Linux: ~/.local/share/windkit/tutorial_data/

• macOS: ~/Library/Application Support/windkit/tutorial_data/

• Windows: C:\Users\<username>\AppData\Roaming\windkit\tutorial_data\

To force a fresh download (e.g., after a dataset update), use the force_download parameter:

data = wk.load_tutorial_data("serra_santa_luzia", force_download=True)