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
optimize measur archiving transforms animals observation conversion projection compose generic
Last synced: 24 minutes 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 (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-19T12:13:26.000Z (6 days ago)
- Last Synced: 2025-12-20T06:54:12.691Z (6 days ago)
- Language: Python
- Size: 44.7 MB
- Stars: 35
- Watchers: 2
- Forks: 9
- Open Issues: 1
- Releases: 91
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff
README.md
Welcome to foxes
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.9...3.14.
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: 18
- Issues event: 5
- Release event: 11
- Watch event: 11
- Delete event: 5
- Issue comment event: 12
- Push event: 219
- Pull request review comment event: 2
- Pull request review event: 6
- Pull request event: 5
- Fork event: 1
Last Year
- Create event: 5
- Release event: 3
- Issues event: 2
- Watch event: 5
- Delete event: 1
- Issue comment event: 10
- Push event: 104
- Pull request review event: 2
- Pull request event: 2
Committers metadata
Last synced: 4 days ago
Total Commits: 1,768
Total Committers: 12
Avg Commits per committer: 147.333
Development Distribution Score (DDS): 0.374
Commits in past year: 261
Committers in past year: 6
Avg Commits per committer in past year: 43.5
Development Distribution Score (DDS) in past year: 0.038
| Name | Commits | |
|---|---|---|
| Jonas Schmidt | j****t@i****e | 1106 |
| Jonas Schulte | j****e@i****e | 566 |
| MellBeli | b****h@i****e | 55 |
| Balthazar Sengers | b****s@i****e | 24 |
| simonIWES | 1****S | 5 |
| dependabot[bot] | 4****] | 3 |
| Lukas Vollmer | l****r@i****e | 3 |
| Rafael M Mudafort | r****t@n****v | 2 |
| Qianyu Zheng | 1****5 | 1 |
| Lukas | l****r@u****e | 1 |
| Hassan Kassem | h****m@i****e | 1 |
| Correoso Garcia | U****8@e****l | 1 |
Committer domains:
- iwes.fraunhofer.de: 6
- uni-oldenburg.de: 1
- nrel.gov: 1
Issue and Pull Request metadata
Last synced: 17 days ago
Total issues: 17
Total pull requests: 26
Average time to close issues: 3 months
Average time to close pull requests: 3 days
Total issue authors: 5
Total pull request authors: 7
Average comments per issue: 2.71
Average comments per pull request: 0.65
Merged pull request: 21
Bot issues: 0
Bot pull requests: 4
Past year issues: 0
Past year pull requests: 3
Past year average time to close issues: N/A
Past year average time to close pull requests: about 6 hours
Past year issue authors: 0
Past year pull request authors: 2
Past year average comments per issue: 0
Past year average comments per pull request: 1.0
Past year merged pull request: 3
Past year bot issues: 0
Past year bot pull requests: 2
Top Issue Authors
- SchmJo (9)
- Wissant (3)
- isdanni (2)
- kikocorreoso (2)
- prof-abdelrahman (1)
Top Pull Request Authors
- SchmJo (13)
- dependabot[bot] (4)
- simonIWES (4)
- kikocorreoso (2)
- qzheng75 (1)
- kyleniemeyer (1)
- rafmudaf (1)
Top Issue Labels
- enhancement (8)
- bug (6)
- suggestion (3)
- documentation (1)
Top Pull Request Labels
- enhancement (5)
- dependencies (4)
- python (2)
- bug (1)
Package metadata
- Total packages: 3
-
Total downloads:
- pypi: 867 last-month
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 1 (may contain duplicates)
- Total versions: 178
- Total maintainers: 1
proxy.golang.org: github.com/fraunhoferiwes/foxes
- Homepage:
- Documentation: https://pkg.go.dev/github.com/fraunhoferiwes/foxes#section-documentation
- Licenses: mit
- Latest release: v1.6.2 (published about 1 month ago)
- Last Synced: 2025-12-22T21:07:08.902Z (3 days ago)
- Versions: 45
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
proxy.golang.org: github.com/FraunhoferIWES/foxes
- Homepage:
- Documentation: https://pkg.go.dev/github.com/FraunhoferIWES/foxes#section-documentation
- Licenses: mit
- Latest release: v1.6.2 (published about 1 month ago)
- Last Synced: 2025-12-22T21:07:09.711Z (3 days ago)
- Versions: 45
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
pypi.org: foxes
Farm Optimization and eXtended yield Evaluation Software
- Homepage: https://github.com/FraunhoferIWES/foxes
- Documentation: https://fraunhoferiwes.github.io/foxes.docs/index.html
- Licenses: MIT License Copyright (c) 2022 FraunhoferIWES Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- Latest release: 1.6.2 (published about 1 month ago)
- Last Synced: 2025-12-22T21:07:07.457Z (3 days ago)
- Versions: 88
- Dependent Packages: 0
- Dependent Repositories: 1
- Downloads: 867 Last month
-
Rankings:
- Dependent packages count: 10.126%
- Forks count: 14.239%
- Stargazers count: 14.246%
- Average: 15.486%
- Downloads: 17.285%
- Dependent repos count: 21.535%
- Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
Score: 12.835768713509502