| Name | foxes-opt JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | None |
| Summary | Wind farm optimization for the FOXES package |
| upload_time | 2024-07-03 13:21:55 |
| maintainer | None |
| docs_url | None |
| author | Fraunhofer IWES |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
wind
farm
optimization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# foxes-opt
## _under construction, not yet ready to use. Please stay tuned..._
The package *foxes-opt* provides optimization functionality for the
*Farm Optimization and eXtended yield Evaluation Software* [foxes](https://github.com/FraunhoferIWES/foxes)
and is based on the optimization interface [iwopy](https://github.com/FraunhoferIWES/iwopy).
All three open-source Python packages *foxes*, *foxes-opt* and *iwopy* are provided and maintained by Fraunhofer IWES.
The calculation is fully vectorized and its fast performance is owed to [dask](https://www.dask.org/). Also the parallelization on local or remote clusters is enabled via `dask`. The wind farm
optimization capabilities invoke the [iwopy](https://github.com/FraunhoferIWES/iwopy) package which
as well supports vectorization.
`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-opt/index.html](https://fraunhoferiwes.github.io/foxes-opt/index.html)
Source code: [https://github.com/FraunhoferIWES/foxes-opt](https://github.com/FraunhoferIWES/foxes-opt)
PyPi reference: [https://pypi.org/project/foxes-opt/](https://pypi.org/project/foxes-opt/)
Anaconda reference: [https://anaconda.org/conda-forge/foxes-opt](https://anaconda.org/conda-forge/foxes-opt)
## 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
As a developer, first clone both repositories,
and then install via pip using the `-e` flag:
```console
git clone https://github.com/FraunhoferIWES/foxes.git
pip install -e foxes
git clone https://github.com/FraunhoferIWES/foxes-opt.git
pip install -e foxes-opt
```
If you want to contribute your developments, please replace
the above repository locations by your personal forks.
## 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}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "foxes-opt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Wind farm optimization",
"author": "Fraunhofer IWES",
"author_email": "jonas.schulte@iwes.fraunhofer.de",
"download_url": "https://files.pythonhosted.org/packages/19/29/9741a06679d81d491b1e388a29de6afe5ef0df04a39732c451f2d66fe6fb/foxes_opt-0.1.7.tar.gz",
"platform": null,
"description": "# foxes-opt\n\n## _under construction, not yet ready to use. Please stay tuned..._\n\nThe package *foxes-opt* provides optimization functionality for the\n*Farm Optimization and eXtended yield Evaluation Software* [foxes](https://github.com/FraunhoferIWES/foxes)\nand is based on the optimization interface [iwopy](https://github.com/FraunhoferIWES/iwopy).\n\nAll three open-source Python packages *foxes*, *foxes-opt* and *iwopy* are provided and maintained by Fraunhofer IWES.\n\nThe calculation is fully vectorized and its fast performance is owed to [dask](https://www.dask.org/). Also the parallelization on local or remote clusters is enabled via `dask`. The wind farm\noptimization capabilities invoke the [iwopy](https://github.com/FraunhoferIWES/iwopy) package which\nas well supports vectorization.\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-opt/index.html](https://fraunhoferiwes.github.io/foxes-opt/index.html)\n\nSource code: [https://github.com/FraunhoferIWES/foxes-opt](https://github.com/FraunhoferIWES/foxes-opt)\n\nPyPi reference: [https://pypi.org/project/foxes-opt/](https://pypi.org/project/foxes-opt/)\n\nAnaconda reference: [https://anaconda.org/conda-forge/foxes-opt](https://anaconda.org/conda-forge/foxes-opt)\n\n## Installation\n\nThere are multiple ways to install *foxes-opt*.\n\n### Installation as standard user \n\n```console\npip install foxes[opt]\n```\nor\n```console\npip install foxes-opt\n```\nor\n```console\nconda install foxes-opt -c conda-forge\n```\n\n### Installation as developer\n\nAs a developer, first clone both repositories,\nand then install via pip using the `-e` flag:\n\n```console\ngit clone https://github.com/FraunhoferIWES/foxes.git\npip install -e foxes\n\ngit clone https://github.com/FraunhoferIWES/foxes-opt.git\npip install -e foxes-opt\n```\n\nIf you want to contribute your developments, please replace \nthe above repository locations by your personal forks.\n\n## Citation\n\nPlease cite the JOSS paper [FOXES: Farm Optimization and eXtended yield\nEvaluation Software](https://doi.org/10.21105/joss.05464). \n\nBibtex:\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wind farm optimization for the FOXES package",
"version": "0.1.7",
"project_urls": {
"Bug Tracker": "https://github.com/FraunhoferIWES/foxes-opt/issues",
"Documentation": "https://fraunhoferiwes.github.io/foxes.docs/index.html",
"Source Code": "https://github.com/FraunhoferIWES/foxes-opt"
},
"split_keywords": [
"wind",
"farm",
"optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d349e9da9235a928a425510a2d89c6bc8084f4212c0aa1933b0bc54e7682eeab",
"md5": "2b6282d85837a987e1a0e6b61fa027e3",
"sha256": "2914c209c192046cb275a872518d8a5153d695853ec42c87c24ca61b5c9bb609"
},
"downloads": -1,
"filename": "foxes_opt-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b6282d85837a987e1a0e6b61fa027e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 45461,
"upload_time": "2024-07-03T13:21:53",
"upload_time_iso_8601": "2024-07-03T13:21:53.284646Z",
"url": "https://files.pythonhosted.org/packages/d3/49/e9da9235a928a425510a2d89c6bc8084f4212c0aa1933b0bc54e7682eeab/foxes_opt-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "19299741a06679d81d491b1e388a29de6afe5ef0df04a39732c451f2d66fe6fb",
"md5": "d33cbdf1c62dd99aa32536607b6e3e64",
"sha256": "2ee17e975c15b196fad6630c6d2dceeab42fbc318f8988424f8a218172e6141e"
},
"downloads": -1,
"filename": "foxes_opt-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "d33cbdf1c62dd99aa32536607b6e3e64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 28693,
"upload_time": "2024-07-03T13:21:55",
"upload_time_iso_8601": "2024-07-03T13:21:55.053081Z",
"url": "https://files.pythonhosted.org/packages/19/29/9741a06679d81d491b1e388a29de6afe5ef0df04a39732c451f2d66fe6fb/foxes_opt-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-03 13:21:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FraunhoferIWES",
"github_project": "foxes-opt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "foxes-opt"
}
