Skip to content

Commit 5a7d031

Browse files
committed
Enhance documentation and fix links
1 parent 5acf36d commit 5a7d031

File tree

2 files changed

+27
-10
lines changed

2 files changed

+27
-10
lines changed

doc/model_description.rst

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
Model description
33
~~~~~~~~~~~~~~~~~~~~~~
44

5+
Wind power plants
6+
=================
7+
8+
The windpowerlib provides three classes for modelling wind power as wind turbines (:py:class:`~.wind_turbine.WindTurbine`),
9+
wind farms (:py:class:`~.wind_farm.WindFarm`) and wind turbine clusters (:py:class:`~.wind_farm.WindFarm`).
10+
11+
Descisptions can also be found in the sections
12+
:ref:`wind_turbine_label`, :ref:`wind_farm_label` and :ref:`wind_turbine_cluster_label`.
13+
14+
515
Height correction and conversion of weather data
616
================================================
717

@@ -33,28 +43,33 @@ For the first option wind efficiency curves are provided which determine the
3343
average reduction of wind speeds within a wind farm induced by wake losses depending on the wind speed. These curves
3444
were taken from the dena-Netzstudie II and the dissertation of Kaspar Knorr
3545
(for references see :py:func:`~.get_wind_efficiency_curve`).
46+
The following graph shows all provided wind efficiency curves. The mean wind efficiency curves were calculated in
47+
the dena-Netzstudie II and by Kaspar Knorr by averaging wind efficiency curves of 12 wind farm distributed over Germany (dena) or
48+
respectively of over 2000 wind farms in Germany (Knorr). Curves with the appendix 'extreme'
49+
are wind efficiency curves of single wind farms that are extremely deviating from the respective
50+
mean wind efficiency curve.
3651

3752
todo: add graph of provided curves
3853

3954
The second option of considering wake losses is applying them to power curves by reducing the power values
4055
by a constant or a wind speed depending wind farm efficiency (see :py:func:`~.wake_losses_to_power_curve`).
4156
Applying the wind farm efficiency (curve) to power curves instead of to feed-in time series has the advantage that the
42-
power curves can further be aggregated to achieve turbine cluster power curves (see WindTurbineCluster in :ref:`classes_label` section).
57+
power curves can further be aggregated to achieve turbine cluster power curves (see :py:class:`~.wind_turbine_cluster.WindTurbineCluster`).
4358

4459
Smoothing of power curves
4560
=========================
4661

4762
To account for the spatial distribution of wind speeds within an area the windpowerlib provides a
48-
function for power curve uses the approach of Nørgaard and Holttinen (for references see :py:func:`~.smooth_power_curve`).
63+
function for power curve smoothing and uses the approach of Nørgaard and Holttinen (for references see :py:func:`~.smooth_power_curve`).
4964

5065

5166
The modelchains
5267
===============
5368

5469
The modelchains are implemented to ensure an easy start into the Windpowerlib. They work
55-
like models that combine all functions provided in the library. The :ref:`modelchain_module_label` is a model
70+
like models that combine all functions provided in the library. Via parameteres desired functions
71+
of the windpowerlib can be selected. For parameters not being specified default parameters are used.
72+
The :ref:`modelchain_module_label` is a model
5673
to determine the output of a wind turbine while the :ref:`tc_modelchain_module_label` is a model to determine
5774
the output of a wind farm or wind turbine cluster.
5875
The usage of both modelchains is shown in the :ref:`example_section_label` section.
59-
60-

doc/modules.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
API
55
#############
66

7-
.. _classes_label:
87

98
Classes
109
=========
@@ -56,12 +55,13 @@ Functions for calculating wind speed at hub height.
5655
wind_speed.logarithmic_profile
5756
wind_speed.hellman
5857

58+
.. _wind_turbine_label:
5959

6060
Wind turbine data
6161
====================
6262

6363
Functions and methods to obtain the nominal power as well as
64-
power curve or power coefficient curve needed by the :py:class:`~wind_turbine.WindTurbine` class.
64+
power curve or power coefficient curve needed by the :py:class:`~.wind_turbine.WindTurbine` class.
6565

6666

6767
.. autosummary::
@@ -71,12 +71,13 @@ power curve or power coefficient curve needed by the :py:class:`~wind_turbine.Wi
7171
wind_turbine.get_turbine_types
7272
wind_turbine.read_turbine_data
7373

74+
.. _wind_farm_label:
7475

7576
Wind farm calculations
7677
======================
7778

7879
Functions and methods to calculate the mean hub height, installed power as well
79-
as the aggregated power curve of a :py:class:`~wind_farm.WindFarm` object.
80+
as the aggregated power curve of a :py:class:`~.wind_farm.WindFarm` object.
8081

8182

8283
.. autosummary::
@@ -86,14 +87,15 @@ as the aggregated power curve of a :py:class:`~wind_farm.WindFarm` object.
8687
wind_farm.WindFarm.get_installed_power
8788
wind_farm.WindFarm.assign_power_curve
8889

90+
.. _wind_turbine_cluster_label:
8991

9092
Wind turbine cluster calculations
9193
=================================
9294

9395
Functions and methods to calculate the mean hub height, installed power as well
94-
as the aggregated power curve of a :py:class:`~wind_turbine_cluster.WindTurbineCluster` object.
96+
as the aggregated power curve of a :py:class:`~.wind_turbine_cluster.WindTurbineCluster` object.
9597
This is realized in a new module as the functions differ from the functions in
96-
the :py:class:`~wind_farm.WindFarm` class.
98+
the :py:class:`~.wind_farm.WindFarm` class.
9799

98100
.. autosummary::
99101
:toctree: temp/

0 commit comments

Comments
 (0)