|
1 | | -<p></p> |
2 | | - |
3 | | -```{image} _static/OptiWindNet.svg |
4 | | -:alt: OptiWindNet |
5 | | -:width: 40% |
6 | | -:align: center |
7 | | -``` |
8 | | -# OptiWindNet Documentation |
9 | | -**OptiWindNet = Optimize Windfarm Network**\ |
10 | | -(distributed under the [MIT License](https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet/-/blob/main/LICENSE)) |
11 | | - |
12 | | -||| |
13 | | -|--:|:--| |
14 | | -Python Package Index (PyPI) | <https://pypi.org/project/optiwindnet/> |
15 | | -Source code repository | <https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet> |
16 | | -Issue tracker | <https://github.com/DTUWindEnergy/OptiWindNet/issues> |
17 | | -Jupyter notebooks used in this manual | <https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet/-/tree/main/docs/notebooks> |
18 | | - |
19 | | -## About OptiWindNet |
20 | | - |
21 | | -OptiWindNet is an electrical network design tool for offshore wind farms developed at the Technical University of Denmark -- DTU. |
22 | | -The package offers a framework to obtain optimal or near-optimal cable routes for a given turbine layout within the cable-laying boundaries. It provides high-level access to heuristic, meta-heuristic and mathematical optimization approaches to the problem. |
23 | | - |
24 | | -The tool is distributed as an open-source Python package that is suitable for use within an interactive Python session (e.g. Jupyter notebook). Alternatively, OptiWindNet's API can be invoked directly from another application. |
25 | | - |
26 | | -## What can OptiWindNet do? |
27 | | - |
28 | | -* Optimize the network of array cables; |
29 | | -* Route the cables so as to avoid crossings; |
30 | | -* Assign cable types and calculate network costs; |
31 | | -* Use different optimization approaches according to the preferred time/quality trade-off; |
32 | | -* Employ user-provided models and objective functions within the mathematical optimization approach. |
33 | | - |
34 | | -## Getting Started |
35 | | - |
36 | | -[](setup) your Python environment and check the {doc}`Quickstart <notebooks/quickstart_high>` to begin using OptiWindNet. |
37 | | - |
38 | | - |
39 | | -## How to Cite |
40 | | - |
41 | | -A peer-reviewed scientific article explaining the OptiWindNet framework and benchmarking it against state-of-the-art methods is available (open-access) at: |
42 | | -- Mauricio Souza de Alencar, Tuhfe Göçmen, Nicolaos A. Cutululis, |
43 | | -_Flexible cable routing framework for wind farm collection system optimization_, |
44 | | -European Journal of Operational Research, |
45 | | -2025, ISSN 0377-2217, <https://doi.org/10.1016/j.ejor.2025.07.069>. |
46 | | - |
47 | | -```{code-block} bib |
48 | | -@article{ |
49 | | - SOUZADEALENCAR2025, |
50 | | - title = {Flexible cable routing framework for wind farm collection system optimization}, |
51 | | - journal = {European Journal of Operational Research}, |
52 | | - year = {2025}, |
53 | | - issn = {0377-2217}, |
54 | | - doi = {https://doi.org/10.1016/j.ejor.2025.07.069}, |
55 | | - url = {https://www.sciencedirect.com/science/article/pii/S0377221725005946}, |
56 | | - author = {Mauricio {Souza de Alencar} and Tuhfe Göçmen and Nicolaos A. Cutululis}, |
57 | | - keywords = {Combinatorial optimization, Network design, Collection system, Wind farm}, |
58 | | -} |
59 | | -``` |
60 | | - |
61 | | -The OptiWindNet software package can be cited as: |
62 | | -- Mauricio Souza de Alencar, Amir Arasteh and Mikkel Friis-Møller. |
63 | | -_OptiWindNet: An open-source wind farm electrical network optimization tool_, |
64 | | -DTU Wind and Energy Systems, Technical University of Denmark (2025, March), |
65 | | -url: <https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet> |
66 | | - |
67 | | -```{code-block} bib |
68 | | -@software{souza_de_alencar_2026_18388439, |
69 | | - author = {Souza de Alencar, Mauricio and |
70 | | - Arasteh, Amir and |
71 | | - Friis-Møller, Mikkel}, |
72 | | - title = {DTUWindEnergy/OptiWindNet: Release of v0.1.7}, |
73 | | - month = jan, |
74 | | - year = 2026, |
75 | | - publisher = {Zenodo}, |
76 | | - version = {v0.1.7}, |
77 | | - doi = {10.5281/zenodo.18388439}, |
78 | | - url = {https://doi.org/10.5281/zenodo.18388439}, |
79 | | - swhid = {swh:1:dir:289eeb68be1214f069d0634666fe0c3bad2df84d |
80 | | - ;origin=https://doi.org/10.5281/zenodo.18388438;vi |
81 | | - sit=swh:1:snp:8ca52a089ae33194f300b466a6168ef29e58 |
82 | | - 2eb4;anchor=swh:1:rel:c660f0924a7df34ae674a91b178c |
83 | | - 715c43f6317c;path=DTUWindEnergy- |
84 | | - OptiWindNet-9c6db85 |
85 | | - }, |
86 | | -} |
87 | | -``` |
88 | | - |
89 | | -```{toctree} |
90 | | -setup |
91 | | -notebooks/quickstart_high |
92 | | -overview |
93 | | -high_level_api |
94 | | -low_level_api |
95 | | -theory |
96 | | -paper |
97 | | -``` |
| 1 | +<p></p> |
| 2 | + |
| 3 | +```{image} _static/OptiWindNet.svg |
| 4 | +:alt: OptiWindNet |
| 5 | +:width: 40% |
| 6 | +:align: center |
| 7 | +``` |
| 8 | +# OptiWindNet Documentation |
| 9 | +**OptiWindNet = Optimize Windfarm Network**\ |
| 10 | +(distributed under the [MIT License](https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet/-/blob/main/LICENSE)) |
| 11 | + |
| 12 | +||| |
| 13 | +|--:|:--| |
| 14 | +Python Package Index (PyPI) | <https://pypi.org/project/optiwindnet/> |
| 15 | +Source code repository | <https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet> |
| 16 | +Issue tracker | <https://github.com/DTUWindEnergy/OptiWindNet/issues> |
| 17 | +Jupyter notebooks used in this manual | <https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet/-/tree/main/docs/notebooks> |
| 18 | + |
| 19 | +## About OptiWindNet |
| 20 | + |
| 21 | +OptiWindNet is an electrical network design tool for offshore wind farms developed at the Technical University of Denmark -- DTU. |
| 22 | +The package offers a framework to obtain optimal or near-optimal cable routes for a given turbine layout within the cable-laying boundaries. It provides high-level access to heuristic, meta-heuristic and mathematical optimization approaches to the problem. |
| 23 | + |
| 24 | +The tool is distributed as an open-source Python package that is suitable for use within an interactive Python session (e.g. Jupyter notebook). Alternatively, OptiWindNet's API can be invoked directly from another application. |
| 25 | + |
| 26 | +## What can OptiWindNet do? |
| 27 | + |
| 28 | +* Optimize the network of array cables; |
| 29 | +* Route the cables so as to avoid crossings; |
| 30 | +* Assign cable types and calculate network costs; |
| 31 | +* Use different optimization approaches according to the preferred time/quality trade-off; |
| 32 | +* Employ user-provided models and objective functions within the mathematical optimization approach. |
| 33 | + |
| 34 | +## Getting Started |
| 35 | + |
| 36 | +[](setup) your Python environment and check the {doc}`Quickstart <notebooks/quickstart_high>` to begin using OptiWindNet. |
| 37 | + |
| 38 | + |
| 39 | +## How to Cite |
| 40 | + |
| 41 | +A peer-reviewed scientific article explaining the OptiWindNet framework and benchmarking it against state-of-the-art methods is available (open-access) at: |
| 42 | +- Mauricio Souza de Alencar, Tuhfe Göçmen, Nicolaos A. Cutululis, |
| 43 | +_Flexible cable routing framework for wind farm collection system optimization_, |
| 44 | +European Journal of Operational Research, |
| 45 | +2025, ISSN 0377-2217, <https://doi.org/10.1016/j.ejor.2025.07.069>. |
| 46 | + |
| 47 | +```{code-block} bib |
| 48 | +@article{ |
| 49 | + SOUZADEALENCAR2025, |
| 50 | + title = {Flexible cable routing framework for wind farm collection system optimization}, |
| 51 | + journal = {European Journal of Operational Research}, |
| 52 | + year = {2025}, |
| 53 | + issn = {0377-2217}, |
| 54 | + doi = {https://doi.org/10.1016/j.ejor.2025.07.069}, |
| 55 | + url = {https://www.sciencedirect.com/science/article/pii/S0377221725005946}, |
| 56 | + author = {Mauricio {Souza de Alencar} and Tuhfe Göçmen and Nicolaos A. Cutululis}, |
| 57 | + keywords = {Combinatorial optimization, Network design, Collection system, Wind farm}, |
| 58 | +} |
| 59 | +``` |
| 60 | + |
| 61 | +The OptiWindNet software package can be cited as: |
| 62 | +- Mauricio Souza de Alencar, Amir Arasteh and Mikkel Friis-Møller. |
| 63 | +_OptiWindNet: An open-source wind farm electrical network optimization tool_, |
| 64 | +DTU Wind and Energy Systems, Technical University of Denmark (2025, March), |
| 65 | +url: <https://gitlab.windenergy.dtu.dk/TOPFARM/OptiWindNet> |
| 66 | + |
| 67 | +```{code-block} bib |
| 68 | +@software{souza_de_alencar_2026_18400851, |
| 69 | + author = {Souza de Alencar, Mauricio and |
| 70 | + Arasteh, Amir and |
| 71 | + Friis-Møller, Mikkel}, |
| 72 | + title = {DTUWindEnergy/OptiWindNet: OptiWindNet v0.1.6}, |
| 73 | + month = jan, |
| 74 | + year = 2026, |
| 75 | + publisher = {Zenodo}, |
| 76 | + version = {v0.1.6}, |
| 77 | + doi = {10.5281/zenodo.18400851}, |
| 78 | + url = {https://doi.org/10.5281/zenodo.18400851}, |
| 79 | + swhid = {swh:1:dir:047c893b761a4bc8e1af7f5447587c301ba93d25 |
| 80 | + ;origin=https://doi.org/10.5281/zenodo.18388438;vi |
| 81 | + sit=swh:1:snp:de59f2c0875971a38020ed3990e581f7450b |
| 82 | + c8bb;anchor=swh:1:rel:a500b34edde6ed685d0f56751ded |
| 83 | + 7587496ba1d3;path=DTUWindEnergy- |
| 84 | + OptiWindNet-d8e2ea3 |
| 85 | + }, |
| 86 | +} |
| 87 | +``` |
| 88 | + |
| 89 | +```{toctree} |
| 90 | +setup |
| 91 | +notebooks/quickstart_high |
| 92 | +overview |
| 93 | +high_level_api |
| 94 | +low_level_api |
| 95 | +theory |
| 96 | +paper |
| 97 | +``` |
0 commit comments