# API client {% embed url="" %} 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](https://gitlab.com/whiffle-public/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](https://pypi.org/project/whiffle-client/). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.whiffle.cloud/getting-started/python-client.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.