API client

Whiffle Wind can also be used programmatically with Python thanks to the whiffle-client package. Simulations launched with the whiffle-client will also be available in the Whiffle Wind web application.

We recommend starting with the Whiffle API Client example notebooks. Afterwards you can also install the Whiffle API Client into your own projects via pip install whiffle-client.

Whiffle API Client example notebooks

This whiffle-client-example repository contains instructions and notebooks to quickly get started with the whiffle-client. You will learn how to setup and launch two simulation to model the offshore Borssele cluster and the onshore Cabauw met mast.

Thanks to the notebooks in this repository you will learn how to:

• 🚀 Set-up a Whiffle Wind simulation with yaml files, launch it and retrieve the results using the whiffle-client python API.

• 📊 Evaluate aerodynamic losses of the Borselle offshore wind cluster after running two Whiffle Wind simulations. One with turbines with thrust (interacting with the atmosphere) and the other with thrust less turbines (not interacting with the atmosphere).

• ✅ Validate Cabauw onshore met-mast data against a Whiffle Wind simulation containing a metmast.

• 🗺️ Visualize and explore wind fields over the whole simulation domain.

Installing Whiffle API Client via pip

More information on how to install and use the Whiffle Client can be found on Pypi.