Metadata-Version: 2.4
Name: foxes-opt
Version: 0.9.1
Summary: Wind farm optimization for the FOXES package
Author: Jonas Schulte
Maintainer: Jonas Schulte
License: MIT License
        
        Copyright (c) 2024 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.
        
Project-URL: Homepage, https://github.com/FraunhoferIWES/foxes-opt
Project-URL: Documentation, https://fraunhoferiwes.github.io/foxes-opt
Project-URL: Repository, https://github.com/FraunhoferIWES/foxes-opt.git
Project-URL: Bug Tracker, https://github.com/FraunhoferIWES/foxes-opt/issues
Project-URL: Changelog, https://github.com/FraunhoferIWES/foxes-opt/blob/main/CHANGELOG.md
Keywords: Wind farm,Wake modelling,Wind farm optimization
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: foxes>=1.9.8
Requires-Dist: iwopy>=1.0.0
Requires-Dist: pymoo>=0.6
Requires-Dist: xarray>=2023.9
Requires-Dist: netcdf4>=1.7
Requires-Dist: pygmo>=2.19
Provides-Extra: doc
Requires-Dist: setuptools>=84.0.0; extra == "doc"
Requires-Dist: sphinx>=5.0; extra == "doc"
Requires-Dist: sphinx-autoapi>=3.0; extra == "doc"
Requires-Dist: numpydoc>=1.0; extra == "doc"
Requires-Dist: sphinx-immaterial>=0.10; extra == "doc"
Requires-Dist: myst-nb>=1.0; extra == "doc"
Requires-Dist: tomli>=2.0; python_version < "3.11" and extra == "doc"
Requires-Dist: ipykernel>=6.0.2; extra == "doc"
Requires-Dist: ipywidgets>=8.0; extra == "doc"
Requires-Dist: lxml_html_clean>=0.4.5; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest>=9.0.3; extra == "test"
Requires-Dist: nbmake>1.0; extra == "test"
Requires-Dist: pre-commit>=3.0; extra == "test"
Requires-Dist: mypy!=2.3.1,>=1.11.0; extra == "test"
Provides-Extra: dev
Requires-Dist: pre-commit>=3.0; extra == "dev"
Requires-Dist: mypy!=2.3.1,>=1.11.0; extra == "dev"
Requires-Dist: objsize>=0.5; extra == "dev"
Requires-Dist: jupyter>=1.0; extra == "dev"
Dynamic: license-file

# Welcome to FOXES Optimization

## Overview

*FOXES Optimization* is a modular Python package for wind-farm optimization by
Fraunhofer IWES. Typical applications include:

- Wind-farm layout optimization,
- Wake steering through turbine yaw optimization,
- Constrained optimization of turbine positions and farm geometries,
- Multi-stage layout optimization pipelines.

FOXES Optimization combines wind-farm and wake modelling from
[FOXES](https://github.com/FraunhoferIWES/foxes) with the shared optimizer
interface provided by [iwopy](https://github.com/FraunhoferIWES/iwopy). It
supports vectorized population evaluation and uses FOXES execution engines for
local or distributed calculations.

| Resource | Link |
| :--- | :--- |
| Documentation | [https://fraunhoferiwes.github.io/foxes-opt](https://fraunhoferiwes.github.io/foxes-opt) |
| Source code | [https://github.com/FraunhoferIWES/foxes-opt](https://github.com/FraunhoferIWES/foxes-opt) |
| PyPI | [https://pypi.org/project/foxes-opt/](https://pypi.org/project/foxes-opt/) |
| conda-forge | [https://anaconda.org/conda-forge/foxes-opt](https://anaconda.org/conda-forge/foxes-opt) |
| License | [MIT](https://github.com/FraunhoferIWES/foxes-opt/blob/main/LICENSE) |

## Requirements

Requires Python 3.10 through 3.14.

## Installation

There are multiple ways to install *foxes-opt*.

### Installation as standard user

```console
pip install foxes[opt]
```
or
```console
pip install foxes-opt
```
or
```console
conda install foxes-opt -c conda-forge
```

### Installation as developer

The developer creates and maintains the uv environment from the `foxes-opt`
repository root. The default setup uses editable FOXES and iwopy checkouts:

```console
uv sync --extra dev --extra test --upgrade
uv pip uninstall foxes iwopy
uv pip install -e <path to foxes>[test,dev,mpi,shp] --upgrade
uv pip install -e <path to iwopy>[opt] --upgrade
```

During development, run project commands with `uv run --no-sync` so uv does not
replace those editable installs. Coding agents and other contributors do not
change the environment; if it needs repair, they ask the developer to re-sync
it. See the [development guide](docs/development.md) for the complete workflow.

## Citation

Please cite the JOSS paper [FOXES: Farm Optimization and eXtended yield
Evaluation Software](https://doi.org/10.21105/joss.05464).

BibTeX:
```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}
}
```

## Acknowledgements

Development of *FOXES Optimization* 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)
