foxes

A modular wind farm simulation and wake modelling toolbox which is based on engineering wake models.
https://github.com/fraunhoferiwes/foxes

Category: Renewable Energy
Sub Category: Wind Energy

Keywords from Contributors

archiving measur transforms observation conversion optimize generic animals projection compose

Last synced: about 21 hours ago
JSON representation

Repository metadata

Farm Optimization and eXtended yield Evaluation Software

Host: GitHub
URL: https://github.com/fraunhoferiwes/foxes
Owner: FraunhoferIWES
License: mit
Created: 2022-04-28T05:02:11.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2025-03-31T11:03:38.000Z (27 days ago)
Last Synced: 2025-04-22T07:03:14.428Z (5 days ago)
Language: Python
Size: 43.6 MB
Stars: 28
Watchers: 2
Forks: 8
Open Issues: 1
Releases: 84
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff

Welcome to foxes

FOXES Logo

Overview

The software foxes is a modular wind farm simulation and wake modelling toolbox which is based on engineering wake models. It has many applications, for example

Wind farm optimization, e.g. layout optimization or wake steering,
Wind farm post-construction analysis,
Wake model studies, comparison and validation,
Wind farm simulations invoking complex model chains.

The fast performance of foxes is owed to vectorization and parallelization,
and it is intended to be used for large wind farms and large timeseries inflow data.
The parallelization on local or remote clusters is supported, based on
mpi4py or
dask.distributed.
The wind farm
optimization capabilities invoke the foxes-opt package which
as well supports vectorization and parallelization.

foxes is build upon many years of experience with wake model code development at IWES, starting with the C++ based in-house code flapFOAM (2011-2019) and the Python based direct predecessor flappy (2019-2022).

Documentation: https://fraunhoferiwes.github.io/foxes.docs/index.html

Source code: https://github.com/FraunhoferIWES/foxes

PyPi reference: https://pypi.org/project/foxes/

Anaconda reference: https://anaconda.org/conda-forge/foxes

Citation

Please cite the JOSS paper "FOXES: Farm Optimization and eXtended yield Evaluation Software"

Bibtex:

@article{
   Schmidt2023, 
   author = {Jonas Schmidt and Lukas Vollmer and Martin Dörenkämper and Bernhard Stoevesandt}, 
   title = {FOXES: Farm Optimization and eXtended yield Evaluation Software}, 
   doi = {10.21105/joss.05464}, 
   url = {https://doi.org/10.21105/joss.05464}, 
   year = {2023}, 
   publisher = {The Open Journal}, 
   volume = {8}, 
   number = {86}, 
   pages = {5464}, 
   journal = {Journal of Open Source Software} 
}

Requirements

The supported Python versions are:

Python 3.8
Python 3.9
Python 3.10
Python 3.11
Python 3.12
Python 3.13

Installation

Either install via pip:

pip install foxes

Alternatively, install via conda:

conda install foxes -c conda-forge

Usage

For detailed examples of how to run foxes, check the examples and notebooks folders in this repository. A minimal running example is the following, based on provided static csv data files:

import foxes

if __name__ == "__main__":

    states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])

    farm = foxes.WindFarm()
    foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])

    algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
    farm_results = algo.calc_farm()

    print(farm_results)

Testing

For testing, please clone the repository and install the required dependencies:

git clone https://github.com/FraunhoferIWES/foxes.git
cd foxes
pip install -e .[test]

The tests are then run by

pytest tests

Contributing

Fork foxes on github.
Create a branch (git checkout -b new_branch)
Commit your changes (git commit -am "your awesome message")
Push to the branch (git push origin new_branch)
Create a pull request here

Acknowledgements

The development of foxes and its predecessors flapFOAM and flappy (internal - non public) has been supported through multiple publicly funded research projects. We acknowledge in particular the funding by the Federal Ministry of Economic Affairs and Climate Action (BMWK) through the projects Smart Wind Farms (grant no. 0325851B), GW-Wakes (0325397B) and X-Wakes (03EE3008A), as well as the funding by the Federal Ministry of Education and Research (BMBF) in the framework of the project H2Digital (03SF0635). We furthermore acknowledge funding by the Horizon Europe project FLOW (Atmospheric Flow, Loads and pOwer
for Wind energy - grant id 101084205).

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Schmidt
  given-names: Jonas
  orcid: "https://orcid.org/0000-0002-8191-8141"
- family-names: Vollmer
  given-names: Lukas
- family-names: Dörenkämper
  given-names: Martin
  orcid: "https://orcid.org/0000-0002-0210-5733"
- family-names: Stoevesandt
  given-names: Bernhard
  orcid: "https://orcid.org/0000-0001-6626-1084"
contact:
- family-names: Schmidt
  given-names: Jonas
  orcid: "https://orcid.org/0000-0002-8191-8141"
doi: 10.5281/zenodo.8027929
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Schmidt
    given-names: Jonas
    orcid: "https://orcid.org/0000-0002-8191-8141"
  - family-names: Vollmer
    given-names: Lukas
  - family-names: Dörenkämper
    given-names: Martin
    orcid: "https://orcid.org/0000-0002-0210-5733"
  - family-names: Stoevesandt
    given-names: Bernhard
    orcid: "https://orcid.org/0000-0001-6626-1084"
  date-published: 2023-06-28
  doi: 10.21105/joss.05464
  issn: 2475-9066
  issue: 86
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5464
  title: "FOXES: Farm Optimization and eXtended yield Evaluation
    Software"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05464"
  volume: 8
title: "FOXES: Farm Optimization and eXtended yield Evaluation Software"

Owner metadata

Name: FraunhoferIWES
Login: FraunhoferIWES
Email:
Kind: organization
Description:
Website:
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/88376562?v=4
Repositories: 4
Last ynced at: 2023-04-08T21:39:25.267Z
Profile URL: https://github.com/FraunhoferIWES

GitHub Events

Total

Create event: 14
Issues event: 5
Release event: 8
Watch event: 7
Delete event: 4
Issue comment event: 9
Push event: 126
Pull request review comment event: 2
Pull request review event: 4
Pull request event: 3
Fork event: 1

Last Year

Create event: 14
Issues event: 5
Release event: 8
Watch event: 7
Delete event: 4
Issue comment event: 9
Push event: 126
Pull request review comment event: 2
Pull request review event: 4
Pull request event: 3
Fork event: 1

Committers metadata

Last synced: 4 days ago

Total Commits: 1,533
Total Committers: 10
Avg Commits per committer: 153.3
Development Distribution Score (DDS): 0.282

Commits in past year: 601
Committers in past year: 6
Avg Commits per committer in past year: 100.167
Development Distribution Score (DDS) in past year: 0.502

Name	Email	Commits
Jonas Schmidt	j**t@i**e	1101
Jonas Schulte	j**e@i**e	341
MellBeli	b**h@i**e	55
Balthazar Sengers	b**s@i**e	23
simonIWES	1****S	5
Lukas Vollmer	l**r@i**e	3
Rafael M Mudafort	r**f@g**m	2
dependabot[bot]	4****]	1
Hassan Kassem	h**m@i**e	1
Correoso Garcia	U**8@e**l	1

Committer domains:

iwes.fraunhofer.de: 6

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 20
Total pull requests: 21
Average time to close issues: 3 months
Average time to close pull requests: 3 days
Total issue authors: 7
Total pull request authors: 6
Average comments per issue: 3.4
Average comments per pull request: 0.67
Merged pull request: 18
Bot issues: 0
Bot pull requests: 2

Past year issues: 4
Past year pull requests: 4
Past year average time to close issues: 6 days
Past year average time to close pull requests: 43 minutes
Past year issue authors: 3
Past year pull request authors: 3
Past year average comments per issue: 5.0
Past year average comments per pull request: 0.0
Past year merged pull request: 3
Past year bot issues: 0
Past year bot pull requests: 2

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/fraunhoferiwes/foxes

Top Issue Authors

SchmJo (9)
Wissant (3)
isdanni (2)
prof-abdelrahman (2)
kikocorreoso (2)
umair-ali-syed (1)
lmichaelis-fhg (1)

Top Pull Request Authors

SchmJo (12)
simonIWES (4)
dependabot[bot] (2)
kikocorreoso (1)
kyleniemeyer (1)
rafmudaf (1)

Top Issue Labels

enhancement (8)
bug (7)
suggestion (4)
documentation (1)

Top Pull Request Labels

enhancement (5)
dependencies (2)
bug (1)

Package metadata

Total packages: 1
Total downloads:
- pypi: 2,830 last-month
Total dependent packages: 0
Total dependent repositories: 1
Total versions: 81
Total maintainers: 1

pypi.org: foxes