Welcome to FOXES
Overview
Farm Optimization and eXtended yield Evaluation Software
FOXES is a modular Python package for wind-farm and wake modelling by Fraunhofer IWES. Typical applications include:
- 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.
FOXES uses vectorized calculations and supports local or distributed execution. Wind-farm optimization is provided by the separate foxes-opt package.
| Resource | Link |
|---|---|
| Documentation | https://fraunhoferiwes.github.io/foxes |
| Source code | https://github.com/FraunhoferIWES/foxes |
| PyPI | https://pypi.org/project/foxes/ |
| conda-forge | https://anaconda.org/conda-forge/foxes |
| License | MIT |
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
Requires Python 3.10 through 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
uv sync --extra test
Run the tests with:
uv run pytest tests
For the full development setup, see the development guide.
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
Development of FOXES was supported by:
- BMWK projects Smart Wind Farms (0325851B), GW-Wakes (0325397B), and X-Wakes (03EE3008A)
- BMBF project H2Digital (03SF0635)
- Horizon Europe projects FLOW (101084205) and AIRE (101083716)
1 maintainer
Metadata
1 maintainer
Release files for foxes 1.9.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| foxes-1.9.7.tar.gz | 1.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| foxes-1.9.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.0 MB
Release files / foxes-1.9.7.tar.gz
| Download URL | foxes-1.9.7.tar.gz |
|---|---|
| Size | 1.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2eb00ae6b2e865469276101cddb155cbb742463619a7e4f3f00ff77c557b208f
|
|
BLAKE2b-256 checksum How to use checksums |
1e5a016cbd875fafd391983237e954ffdf5d791870c819a33f19c0dea8ec77ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 8, 2026.
Transparency logRelease files / foxes-1.9.7-py3-none-any.whl
| Download URL | foxes-1.9.7-py3-none-any.whl |
|---|---|
| Size | 2.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f0a6bf8d147faf8d09c4e60cb77d09104751d16a1ef2d9cef9a925dc6ed3a5fc
|
|
BLAKE2b-256 checksum How to use checksums |
f05260ac32c4551a5a8920ecdafa902fae3f7d0103e3d5d2dfb705974235bf8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 8, 2026.
Transparency log
