Skip to content
Snippets Groups Projects
Commit c096b740 authored by Mads M. Pedersen's avatar Mads M. Pedersen
Browse files

fix docs

parent d4dad1f7
No related branches found
No related tags found
No related merge requests found
...@@ -39,9 +39,9 @@ PyWake is equipped with many capabilities that can range from basic to complex. ...@@ -39,9 +39,9 @@ PyWake is equipped with many capabilities that can range from basic to complex.
Explanations of PyWake's core objects can be found in the following tutorials: Explanations of PyWake's core objects can be found in the following tutorials:
* :ref:`Site </notebooks/Site.ipynb>`: this tutorial walks through the set up of pre-defined sites in PyWake as well as the possibility for user-defined sites. * :ref:`Site </notebooks/Site.ipynb>`: this tutorial walks through the set up of pre-defined sites in PyWake as well as the possibility for user-defined sites.
* :ref:`Wind Turbine </notebooks/WindTurbines.ipynb>`: this example demonstrates how to set up a wind turbine object and also to create user-defined turbines with specific power and CT curves. * :ref:`Wind Turbine </notebooks/WindTurbines.ipynb>`: this example demonstrates how to set up a wind turbine object and also to create user-defined turbines with specific power and CT curves.
* :ref:`Engineering Wind Farm Models </notebooks/EngineeringWindFarmModels.ipynb>`: here there is a detailed explanation of all the wake deficit models available in PyWake as well as other engineering models such as wake superposition, deflection, etc. * :ref:`Engineering Wind Farm Models </notebooks/EngineeringWindFarmModels.ipynb>`: here there is a detailed explanation of all the wake deficit models available in PyWake as well as other engineering models such as wake superposition, deflection, etc.
The :ref:`Wind farm simulation </notebooks/RunWindFarmSimulation.ipynb>` example shows how to execute PyWake and extract relevant information about the wind farm studied. In addition, PyWake's capablities to calculate gradients are demonstrated in the :ref:`Gradients, parallelization and precision </notebooks/gradients_parallellization.ipynb>` example, and an optimization with TOPFARM is available in the :ref:`Optimization </notebooks/Optimization.ipynb>` tutorial. The :ref:`Wind farm simulation </notebooks/RunWindFarmSimulation.ipynb>` example shows how to execute PyWake and extract relevant information about the wind farm studied. In addition, PyWake's capablities to calculate gradients are demonstrated in the :ref:`Gradients, parallelization and precision </notebooks/gradients_parallellization.ipynb>` example, and an optimization with TOPFARM is available in the :ref:`Optimization </notebooks/Optimization.ipynb>` tutorial.
...@@ -50,7 +50,7 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises ...@@ -50,7 +50,7 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Contents :caption: Contents
installation installation
notebooks/Overview notebooks/Overview
...@@ -59,7 +59,7 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises ...@@ -59,7 +59,7 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Tutorials :caption: Tutorials
notebooks/Quickstart notebooks/Quickstart
notebooks/Site notebooks/Site
...@@ -77,19 +77,19 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises ...@@ -77,19 +77,19 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Model Verification :caption: Model Verification
notebooks/literature_verification/TurbOPark notebooks/literature_verification/TurbOPark
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Validation :caption: Validation
validation validation
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: API Reference :caption: API Reference
api/WindTurbines api/WindTurbines
api/Site api/Site
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment