Skip to main content

Couple load surrogate models with PyWake and Floris.

Project description

Wind farm load surrogate

pipeline status coverage report Poetry Code style: black

Couple a load surrogate model with PyWake and Floris.

The documentation is available at https://surrogate-models.pages.windenergy.dtu.dk/wind-farm-loads/

Installation instructions

The dependencies are managed with Poetry, and some are marked as optional. To install all dependencies type

poetry install --all-extras

It is also possible to install only some optional dependencies, with

poetry install --extras "<option_1> <option_2>"

For example

poetry install --extras "develop code_style"

The optional dependencies are listed in the following table

Name Description
pywake Add PyWake
floris Add Floris
spyder Enable the use of Spyder with this virtual environment
test Enable testing
code_style Enable code style checking
docs Enable building the documentation
profiler Enable time and memory profiler

This package relies on surrogates-interface to evaluate the loads. It is the responsibility of the user to select which surrogate model library to install. At the time of writing, the options are:

  • surrogates-interface[tf] ➡️ TensorFlow
  • surrogates-interface[torch] ➡️ PyTorch
  • surrogates-interface[smt] ➡️ SMT

Poetry will write the location of the virtual environment. This is useful to delete it when it's not needed anymore, and also to select the python executable from Spyder.

To use Spyder go to Tools / Preferences / Python interpreter. Select "Use the following Python interpreter" and enter the path to python.exe in the virtual environment. It should look like %userprofile%\AppData\Local\pypoetry\Cache\virtualenvs\wind-farm-loads-yjbA2zDm-py3.11.11\Scripts\python.exe.

To run any command there are two options:

  • Activate the virtual environment. That is, open a new command prompt, and then enter %userprofile%\AppData\Local\pypoetry\Cache\virtualenvs\wind-farm-loads-yjbA2zDm-py3.12\Scripts\activate.bat.
  • Always write poetry run before anything. For example poetry run python my_script.py.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wind_farm_loads-0.9.0.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wind_farm_loads-0.9.0-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file wind_farm_loads-0.9.0.tar.gz.

File metadata

  • Download URL: wind_farm_loads-0.9.0.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.10 Linux/6.8.0-60-generic

File hashes

Hashes for wind_farm_loads-0.9.0.tar.gz
Algorithm Hash digest
SHA256 9fe21d175a0d58c79ecb8badef78b62c75b62d41c1f8d2ac14b1fa5dc44e010c
MD5 66726de91ca0c9bf910d7037e2cd6523
BLAKE2b-256 31c23ab071e340d555c6a1ae3caa83def88d1d77314303f3be75abfd944c2b71

See more details on using hashes here.

File details

Details for the file wind_farm_loads-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: wind_farm_loads-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 31.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.10 Linux/6.8.0-60-generic

File hashes

Hashes for wind_farm_loads-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e15f733896748e5ec1ea409efdb17bbcd5fc2a2c70681d7730af3808412a70c
MD5 8e31365473f245a8b5c1633e7829aa68
BLAKE2b-256 8163eba9285d87f5eca3f244b672dbc34094f9bbe201576044ad9c1bb217bfd7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page