Welcome to FOXES

FOXES Logo

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)

Metadata

Release files for foxes 1.9.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxes 1.9.8
File	Size	Uploaded
foxes-1.9.8.tar.gz	1.9 MB	Oct 14, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for foxes 1.9.8
File	Interpreter	ABI	Platform	Reset
foxes-1.9.8-py3-none-any.whl 2.1 MB Oct 14, 2026	Python 3	none	any	Details

Total release size: 4.0 MB

Release files / foxes-1.9.8.tar.gz

Download URL	foxes-1.9.8.tar.gz
Size	1.9 MB
Tags	Source
SHA-256 checksum How to use checksums	`1081e95112056a1714fe469b39af139f56f16566d0c0164c0cf8df825b0345c6`
BLAKE2b-256 checksum How to use checksums	`ffd7839659b309469da268452fe69e35cf4fa3683f486c45633ef2206a907f42`
Upload date	Oct 14, 2026
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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/FraunhoferIWES/foxes
Publishing commit: github.com/FraunhoferIWES/foxes/tree/7db2ccaa824ebb2017a7864069b5d0b73ae14002

Workflow

Publishing configuration: github.com/FraunhoferIWES/foxes/blob/7db2ccaa824ebb2017a7864069b5d0b73ae14002/.github/workflows/publish.yml
Publishing logs: github.com/FraunhoferIWES/foxes/actions/runs/38535163219/attempts/1

Artifact

Subject: foxes-1.9.8.tar.gz
SHA-256 checksum: 1081e95112056a1714fe469b39af139f56f16566d0c0164c0cf8df825b0345c6 Verifying attestations

Release files / foxes-1.9.8-py3-none-any.whl

Download URL	foxes-1.9.8-py3-none-any.whl
Size	2.1 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`194f28d2645dc815c96a70f8bee611a2ab8167cd176eabec1c191b5cdfe8b273`
BLAKE2b-256 checksum How to use checksums	`fe4d50c08b32e332bd96def6b82497ffc0e4ab89b4a0f038c82965c47fc3ff78`
Upload date	Oct 14, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/FraunhoferIWES/foxes
Publishing commit: github.com/FraunhoferIWES/foxes/tree/7db2ccaa824ebb2017a7864069b5d0b73ae14002

Workflow

Publishing configuration: github.com/FraunhoferIWES/foxes/blob/7db2ccaa824ebb2017a7864069b5d0b73ae14002/.github/workflows/publish.yml
Publishing logs: github.com/FraunhoferIWES/foxes/actions/runs/38535163219/attempts/1

Artifact

Subject: foxes-1.9.8-py3-none-any.whl
SHA-256 checksum: 194f28d2645dc815c96a70f8bee611a2ab8167cd176eabec1c191b5cdfe8b273 Verifying attestations