wind-up

A tool to assess yield uplift of wind turbines

Getting Started

See examples folder for example analysis using the wind-up package. smarteole_example.ipynb is a good place to start.

The wind-up package can be installed using any Python environment manager. Examples using uv and pip are shown below:

Using uv

# Install the wind-up package in an existing project
uv add res-wind-up

# Or create a new project and install the wind-up package
uv init my-project
cd my-project
uv add res-wind-up

Using pip

# create and activate a virtual environment, if needed
python -m venv .venv
source .venv/Scripts/activate  # or .venv/bin/activate on linux or ".venv/Scripts/activate" in Windows command prompt
# install the wind-up package in the virtual environment
pip install res-wind-up # alternatively clone the repo, navigate to the wind-up folder and run "pip install ."

Note that the package is named wind_up (with an underscore) in Python code. For example to print the version of the installed package use the following code snippet:

import wind_up
print(wind_up.__version__)

Contributing

To start making changes fork the repository or make a new branch from main. Note main is protected; if a commit fails to push and you want to undo it try git reset origin/main --hard

The development environment should be created and managed using uv. To create the environment:

uv sync --extra dev

To run the formatting, linting and testing:

uv run poe all # or all-fast to skip slow tests

Or simply

poe all # or all-fast to skip slow tests

if you have activated the virtual environment.

License

See LICENSE.txt

Contact

Alex.Clerc@res-group.com