FOXES
FOXES: Farm Optimization and eXtended yield Evaluation Software - Published in JOSS (2023)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
6 of 10 committers (60.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords from Contributors
Repository
Farm Optimization and eXtended yield Evaluation Software
Basic Info
- Host: GitHub
- Owner: FraunhoferIWES
- License: mit
- Language: Python
- Default Branch: main
- Size: 44.3 MB
Statistics
- Stars: 31
- Watchers: 2
- Forks: 8
- Open Issues: 1
- Releases: 87
Metadata Files
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.8...3.13.
Installation
Either install via pip:
console
pip install foxes
Alternatively, install via conda:
console
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:
```python 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:
console
git clone https://github.com/FraunhoferIWES/foxes.git
cd foxes
pip install -e .[test]
The tests are then run by
console
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).
Owner
- Name: FraunhoferIWES
- Login: FraunhoferIWES
- Kind: organization
- Repositories: 4
- Profile: https://github.com/FraunhoferIWES
JOSS Publication
FOXES: Farm Optimization and eXtended yield Evaluation Software
Authors
Fraunhofer IWES, Küpkersweg 70, 26129 Oldenburg, Germany
Fraunhofer IWES, Küpkersweg 70, 26129 Oldenburg, Germany
Fraunhofer IWES, Küpkersweg 70, 26129 Oldenburg, Germany
Fraunhofer IWES, Küpkersweg 70, 26129 Oldenburg, Germany
Editor
Tim Tröndle
Tags
wind energy wind turbine wakes wake modelling wind farm optimizationCitation (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"
GitHub Events
Total
- Create event: 17
- Issues event: 5
- Release event: 10
- Watch event: 10
- Delete event: 5
- Issue comment event: 9
- Push event: 163
- Pull request review comment event: 2
- Pull request review event: 4
- Pull request event: 5
- Fork event: 1
Last Year
- Create event: 17
- Issues event: 5
- Release event: 10
- Watch event: 10
- Delete event: 5
- Issue comment event: 9
- Push event: 164
- Pull request review comment event: 2
- Pull request review event: 4
- Pull request event: 5
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jonas Schmidt | j****t@i****e | 1,101 |
| Jonas Schulte | j****e@i****e | 445 |
| MellBeli | b****h@i****e | 55 |
| Balthazar Sengers | b****s@i****e | 23 |
| simonIWES | 1****S | 5 |
| Lukas Vollmer | l****r@i****e | 3 |
| dependabot[bot] | 4****] | 2 |
| Rafael M Mudafort | r****f@g****m | 2 |
| Hassan Kassem | h****m@i****e | 1 |
| Correoso Garcia | U****8@e****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 19
- 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.47
- Average comments per pull request: 0.67
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 2
- Pull requests: 3
- Average time to close issues: about 14 hours
- Average time to close pull requests: about 1 hour
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 3.0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- SchmJo (9)
- Wissant (3)
- isdanni (2)
- kikocorreoso (2)
- prof-abdelrahman (1)
- lmichaelis-fhg (1)
Pull Request Authors
- SchmJo (13)
- simonIWES (4)
- dependabot[bot] (3)
- kikocorreoso (2)
- kyleniemeyer (1)
- rafmudaf (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 335 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 168
- Total maintainers: 1
proxy.golang.org: github.com/FraunhoferIWES/foxes
- Documentation: https://pkg.go.dev/github.com/FraunhoferIWES/foxes#section-documentation
- License: mit
-
Latest release: v1.5.1
published 7 months ago
Rankings
proxy.golang.org: github.com/fraunhoferiwes/foxes
- Documentation: https://pkg.go.dev/github.com/fraunhoferiwes/foxes#section-documentation
- License: mit
-
Latest release: v1.5.1
published 7 months ago
Rankings
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
- License: 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.5.1
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite