WindShape

Windsuite SDK

Access the WindSuite Eco-system using python

WindSuite SDK Examples

Set of example scripts demonstrating how to use the WindSuite SDK

Quickstart

You can get started quickly by running the example scripts:

git clone git@github.com:WindShape-SA/windsuite-sdk-examples.git
cd windsuite-sdk-examples

cp .env.example .env

# Modify the .env with the IP address of your server (default is 192.168.88.40)
SERVER_IP_ADDRESS="192.168.88.40"

cd examples
uv run checkers_fans_pattern.py

Fan Checkers pattern result

Installing the SDK

The SDK is available via PyPI. You can simply install it using pip / uv:

windsuite-sdk

WindSuite SDK Python package

uv add windsuite-sdk

# or using pip
pip install windsuite-sdk

Dependencies

You'll need Astral uv installed to run the examples:

Astral uv

Fast Python package and project manager

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh