Skip to main content

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

Ask DeepWiki

Citation

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

DOI

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

  1. Fork foxes on github.
  2. Create a branch (git checkout -b new_branch)
  3. Commit your changes (git commit -am "your awesome message")
  4. Push to the branch (git push origin new_branch)
  5. 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)
  • Research platform Wind - Reallabor 70 GW Offshore Wind (ZN4468), funded by the zukunft.niedersachsen program

Metadata

Release files for foxes 1.9.9

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.9
File Size Uploaded Provenance Actions
foxes-1.9.9.tar.gz 1.9 MB With provenance Details for foxes-1.9.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for foxes 1.9.9
File Interpreter ABI Platform Actions
foxes-1.9.9-py3-none-any.whl Python 3 none any Details for foxes-1.9.9-py3-none-any.whl

Total release size: 4.0 MB

Release files / foxes-1.9.9.tar.gz

Download URL foxes-1.9.9.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
d9ff319cba44aa1855cb14b196eb8359e1392886dcdbaf757951622fea98df42
BLAKE2b-256 checksum
How to use checksums
ad786883291b8b54fb2940b0761d7bc5e90690df44eb2e4201514ccf152025cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 27, 2026.

Transparency log

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

Download URL foxes-1.9.9-py3-none-any.whl
Size 2.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0b3f9701126d5827dbe4374c914222765d9b270af4f4f5b2cf1fd340ffab6d2d
BLAKE2b-256 checksum
How to use checksums
5f09626db1e5092d9a6061374b5b1bec6f6993933e85b7b1ed3319b5954ce5e8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 27, 2026.

Transparency log

Security for foxes 1.9.9

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for foxes-1.9.9.tar.gz

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 27, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.9.9 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page