| Name | foxes JSON |
| Version |
1.2.5
JSON |
| download |
| home_page | None |
| Summary | Farm Optimization and eXtended yield Evaluation Software |
| upload_time | 2024-12-20 12:36:53 |
| maintainer | Jonas Schulte |
| docs_url | None |
| author | Jonas Schulte |
| requires_python | >=3.8 |
| 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. |
| keywords |
wind farm
wake modelling
wind farm optimization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://mpi4py.readthedocs.io/en/stable/) or
[dask.distributed](https://distributed.dask.org/en/stable/).
The wind farm
optimization capabilities invoke the [foxes-opt](https://github.com/FraunhoferIWES/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](https://fraunhoferiwes.github.io/foxes.docs/index.html)
Source code: [https://github.com/FraunhoferIWES/foxes](https://github.com/FraunhoferIWES/foxes)
PyPi reference: [https://pypi.org/project/foxes/](https://pypi.org/project/foxes/)
Anaconda reference: [https://anaconda.org/conda-forge/foxes](https://anaconda.org/conda-forge/foxes)
## Citation
Please cite the JOSS paper `"FOXES: Farm Optimization and eXtended yield
Evaluation Software"`
[](https://doi.org/10.21105/joss.05464)
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`
- `Python 3.9`
- `Python 3.10`
- `Python 3.11`
- `Python 3.12`
- `Python 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
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
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](https://github.com/FraunhoferIWES/foxes/pulls)
## 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).
Raw data
{
"_id": null,
"home_page": null,
"name": "foxes",
"maintainer": "Jonas Schulte",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Wind farm, Wake modelling, Wind farm optimization",
"author": "Jonas Schulte",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/75/de/50e2db62383872b447445fd50919aca1c55f3f8055542b93e8bc2d89776d/foxes-1.2.5.tar.gz",
"platform": null,
"description": "# Welcome to foxes\n\n\n\n## Overview\n\nThe 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\n\n- Wind farm optimization, e.g. layout optimization or wake steering,\n- Wind farm post-construction analysis,\n- Wake model studies, comparison and validation,\n- Wind farm simulations invoking complex model chains.\n\nThe fast performance of `foxes` is owed to vectorization and parallelization,\nand it is intended to be used for large wind farms and large timeseries inflow data.\nThe parallelization on local or remote clusters is supported, based on \n[mpi4py](https://mpi4py.readthedocs.io/en/stable/) or\n[dask.distributed](https://distributed.dask.org/en/stable/).\nThe wind farm\noptimization capabilities invoke the [foxes-opt](https://github.com/FraunhoferIWES/foxes-opt) package which\nas well supports vectorization and parallelization.\n\n`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).\n\nDocumentation: [https://fraunhoferiwes.github.io/foxes.docs/index.html](https://fraunhoferiwes.github.io/foxes.docs/index.html)\n\nSource code: [https://github.com/FraunhoferIWES/foxes](https://github.com/FraunhoferIWES/foxes)\n\nPyPi reference: [https://pypi.org/project/foxes/](https://pypi.org/project/foxes/)\n\nAnaconda reference: [https://anaconda.org/conda-forge/foxes](https://anaconda.org/conda-forge/foxes)\n\n## Citation\n\nPlease cite the JOSS paper `\"FOXES: Farm Optimization and eXtended yield\nEvaluation Software\"` \n\n [](https://doi.org/10.21105/joss.05464)\n\n Bibtex:\n ```\n@article{\n Schmidt2023, \n author = {Jonas Schmidt and Lukas Vollmer and Martin D\u00f6renk\u00e4mper and Bernhard Stoevesandt}, \n title = {FOXES: Farm Optimization and eXtended yield Evaluation Software}, \n doi = {10.21105/joss.05464}, \n url = {https://doi.org/10.21105/joss.05464}, \n year = {2023}, \n publisher = {The Open Journal}, \n volume = {8}, \n number = {86}, \n pages = {5464}, \n journal = {Journal of Open Source Software} \n}\n ```\n\n## Requirements\n\nThe supported Python versions are: \n\n- `Python 3.8`\n- `Python 3.9`\n- `Python 3.10`\n- `Python 3.11`\n- `Python 3.12`\n- `Python 3.13`\n\n## Installation\n\nEither install via pip:\n\n```console\npip install foxes\n```\n\nAlternatively, install via conda:\n\n```console\nconda install foxes -c conda-forge\n```\n\n## Usage\n\nFor 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:\n\n```python\nimport foxes\n\nstates = foxes.input.states.Timeseries(\"timeseries_3000.csv.gz\", [\"WS\", \"WD\",\"TI\",\"RHO\"])\n\nfarm = foxes.WindFarm()\nfoxes.input.farm_layout.add_from_file(farm, \"test_farm_67.csv\", turbine_models=[\"NREL5MW\"])\n\nalgo = foxes.algorithms.Downwind(farm, states, [\"Jensen_linear_k007\"])\nfarm_results = algo.calc_farm()\n\nprint(farm_results)\n```\n\n## Testing\n\nFor testing, please clone the repository and install the required dependencies:\n```console\ngit clone https://github.com/FraunhoferIWES/foxes.git\ncd foxes\npip install -e .[test]\n```\n\nThe tests are then run by\n```console\npytest tests\n```\n\n## Contributing\n\n1. Fork _foxes_ on _github_.\n2. Create a branch (`git checkout -b new_branch`)\n3. Commit your changes (`git commit -am \"your awesome message\"`)\n4. Push to the branch (`git push origin new_branch`)\n5. Create a pull request [here](https://github.com/FraunhoferIWES/foxes/pulls)\n\n## Acknowledgements\n\nThe 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 \nfor Wind energy - grant id 101084205).\n",
"bugtrack_url": null,
"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. ",
"summary": "Farm Optimization and eXtended yield Evaluation Software",
"version": "1.2.5",
"project_urls": {
"Bug Tracker": "https://github.com/FraunhoferIWES/foxes/issues",
"Changelog": "https://github.com/FraunhoferIWES/foxes/blob/main/CHANGELOG.md",
"Documentation": "https://fraunhoferiwes.github.io/foxes.docs/index.html",
"Homepage": "https://github.com/FraunhoferIWES/foxes",
"Repository": "https://github.com/FraunhoferIWES/foxes.git"
},
"split_keywords": [
"wind farm",
" wake modelling",
" wind farm optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9b3996875cb1e68dfafc316e54d200b02a30b257d3fd6f1de86ef23858fce45",
"md5": "581e62d96f829cdcbd136c5be749036f",
"sha256": "8ac7ef3c0500c5daeb32d6aa166fe7a8829394a1cc361032621977053e94c366"
},
"downloads": -1,
"filename": "foxes-1.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "581e62d96f829cdcbd136c5be749036f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1327498,
"upload_time": "2024-12-20T12:36:50",
"upload_time_iso_8601": "2024-12-20T12:36:50.760835Z",
"url": "https://files.pythonhosted.org/packages/b9/b3/996875cb1e68dfafc316e54d200b02a30b257d3fd6f1de86ef23858fce45/foxes-1.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "75de50e2db62383872b447445fd50919aca1c55f3f8055542b93e8bc2d89776d",
"md5": "afa6b790f4560daade8e8e2bc2cab87f",
"sha256": "97d4f64f353d3c5950a6c06ce08e9ecf6b88f396bea51b7ef1dd7a37b363402a"
},
"downloads": -1,
"filename": "foxes-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "afa6b790f4560daade8e8e2bc2cab87f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1146509,
"upload_time": "2024-12-20T12:36:53",
"upload_time_iso_8601": "2024-12-20T12:36:53.178977Z",
"url": "https://files.pythonhosted.org/packages/75/de/50e2db62383872b447445fd50919aca1c55f3f8055542b93e8bc2d89776d/foxes-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 12:36:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FraunhoferIWES",
"github_project": "foxes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "foxes"
}
