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.11.0.tar.gz (31.9 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.11.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wind_farm_loads-0.11.0.tar.gz
  • Upload date:
  • Size: 31.9 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.11.0.tar.gz
Algorithm Hash digest
SHA256 1168d135bc478cfbb44a6873a63a86330ab0a09654c08c1d1d5b2c20f7b95426
MD5 e93e647c1f48e559a02cea6d693ddec8
BLAKE2b-256 ffd7dac39e97ca3b9ce7e01134cd7d73f931f9e6ad043f48f4dcf05f5b357dbb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wind_farm_loads-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 35.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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f068912feb5d987d55986be050d4bfc8473ec231db1b6fe9be32a928e999880f
MD5 a93a5b25eeb7c4ffc38a846f9b97f4b3
BLAKE2b-256 d8dc5dcf37d5450e937e4d84690de538d8fb824653e1eea60a3fbc8824f33682

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