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 "pywake spyder"

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.12.0.tar.gz (33.5 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.12.0-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wind_farm_loads-0.12.0.tar.gz
  • Upload date:
  • Size: 33.5 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.12.0.tar.gz
Algorithm Hash digest
SHA256 f47a934addedfa843a0209ff460cbd90019a1e8af1e5f51d70dec948d7d8e145
MD5 bd3570dc0b283766b1c5c8fb65654f08
BLAKE2b-256 116e86fe48e49cd950d89d0fb18e3abf545b2b7b2f60715143d870996683d8ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wind_farm_loads-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 36.0 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.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7dd325b6861e54998724e959ad433b4a9b2df976487c178fb81e9e73b502df4f
MD5 05786f1647726a6e1c56872a59b52548
BLAKE2b-256 6db1b0871e296e0e389bb65f856327148b05739809396101e89b4c9855383c83

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