| Name | foxes-opt JSON |
| Version |
0.3
JSON |
| download |
| home_page | None |
| Summary | Wind farm optimization for the FOXES package |
| upload_time | 2024-11-29 14:11:46 |
| maintainer | Jonas Schulte |
| docs_url | None |
| author | Jonas Schulte |
| requires_python | >=3.8 |
| 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. |
| 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.
|
# foxes-opt
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": "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/13/fa/72c9f34e497f4e91572ce5d0d9c460cfa20f35cb97c727abf1842cd360cf/foxes_opt-0.3.tar.gz",
"platform": null,
"description": "# foxes-opt\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 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. ",
"summary": "Wind farm optimization for the FOXES package",
"version": "0.3",
"project_urls": {
"Bug Tracker": "https://github.com/FraunhoferIWES/foxes-opt/issues",
"Changelog": "https://github.com/FraunhoferIWES/foxes-opt/blob/main/CHANGELOG.md",
"Documentation": "https://fraunhoferiwes.github.io/foxes-opt/index.html",
"Homepage": "https://github.com/FraunhoferIWES/foxes-opt",
"Repository": "https://github.com/FraunhoferIWES/foxes-opt.git"
},
"split_keywords": [
"wind farm",
" wake modelling",
" wind farm optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "724971cbf083c50f703befcf86928dc3a8f3f4a84923cbfe610167d1009ea6b6",
"md5": "da7c3485ae9194537f47175c8fcfd700",
"sha256": "73ac3fee5776e622512d4859dc35c2d2e9d910afe2ff3b85182bf8ca337fedbb"
},
"downloads": -1,
"filename": "foxes_opt-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da7c3485ae9194537f47175c8fcfd700",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 68867,
"upload_time": "2024-11-29T14:11:42",
"upload_time_iso_8601": "2024-11-29T14:11:42.481564Z",
"url": "https://files.pythonhosted.org/packages/72/49/71cbf083c50f703befcf86928dc3a8f3f4a84923cbfe610167d1009ea6b6/foxes_opt-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13fa72c9f34e497f4e91572ce5d0d9c460cfa20f35cb97c727abf1842cd360cf",
"md5": "39e5dd385e16f2e93823efeb016aa2af",
"sha256": "735d85e7f6f49a9160a15f189eb471fcf27ccc82a6875e13554fe4d9604377bc"
},
"downloads": -1,
"filename": "foxes_opt-0.3.tar.gz",
"has_sig": false,
"md5_digest": "39e5dd385e16f2e93823efeb016aa2af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 38619,
"upload_time": "2024-11-29T14:11:46",
"upload_time_iso_8601": "2024-11-29T14:11:46.308649Z",
"url": "https://files.pythonhosted.org/packages/13/fa/72c9f34e497f4e91572ce5d0d9c460cfa20f35cb97c727abf1842cd360cf/foxes_opt-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-29 14:11:46",
"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"
}
