Skip to content

Commit e145bd3

Browse files
committed
Add examples and modules to documentation
1 parent d1a2c5f commit e145bd3

File tree

3 files changed

+54
-5
lines changed

3 files changed

+54
-5
lines changed

doc/example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
basic_example.initialise_wind_turbines
88
basic_example.calculate_power_output
99
basic_example.plot_or_print
10-
basic_example.run_basic_example
10+
basic_example.run_basic_example

doc/example_2.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: example
2+
3+
.. autosummary::
4+
:toctree: temp/
5+
6+
further_example.initialise_wind_farm
7+
further_example.initialise_wind_turbine_cluster
8+
further_example.calculate_power_output
9+
further_example.plot_or_print
10+
further_example.run_example

doc/modules.rst

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,41 @@ power curve or power coefficient curve needed by the :py:class:`~wind_turbine.Wi
6666
wind_turbine.read_turbine_data
6767

6868

69+
Wind farm calculations
70+
======================
71+
72+
Functions and methods to calculate the mean hub height, installed power as well
73+
as the aggregated power curve of a :py:class:`~wind_farm.WindFarm` object.
74+
75+
76+
.. autosummary::
77+
:toctree: temp/
78+
79+
wind_farm.WindFarm.mean_hub_height
80+
wind_farm.WindFarm.get_installed_power
81+
wind_farm.WindFarm.assign_power_curve
82+
83+
84+
Wind turbine cluster calculations
85+
=================================
86+
87+
Functions and methods to calculate the mean hub height, installed power as well
88+
as the aggregated power curve of a :py:class:`~wind_turbine_cluster.WindTurbineCluster` object.
89+
This is realized in a new module as the functions differ from the functions in
90+
the :py:class:`~wind_farm.WindFarm` class.
91+
92+
.. autosummary::
93+
:toctree: temp/
94+
95+
wind_farm.WindTurbineCluster.mean_hub_height
96+
wind_farm.WindTurbineCluster.get_installed_power
97+
wind_farm.WindTurbineCluster.assign_power_curve
98+
99+
69100
Power output
70101
==============
71102

72-
Functions for calculating power output of a wind turbine.
103+
Functions for calculating power output of a wind power plant.
73104

74105
.. autosummary::
75106
:toctree: temp/
@@ -80,7 +111,7 @@ Functions for calculating power output of a wind turbine.
80111

81112

82113
Alteration of power curves
83-
==============
114+
==========================
84115

85116
Functions for smoothing power curves or applying wake losses.
86117

@@ -120,7 +151,7 @@ Methods of the ModelChain object.
120151

121152

122153
TurbineClusterModelChain
123-
==============
154+
========================
124155
The TurbineClusterModelChain inherits all functions from the ModelChain.
125156

126157
Creating a TurbineClusterModelChain object.
@@ -162,9 +193,17 @@ Additional functions used in the windpowerlib.
162193
tools.estimate_turbulence_intensity
163194

164195

165-
Example
196+
Basic example
166197
==============
167198

168199
The basic example consists of the following functions.
169200

170201
.. include:: example.rst
202+
203+
Further example
204+
===============
205+
206+
A further example consists of the following functions as well as uses functions
207+
of the basic example.
208+
209+
.. include:: example_2.rst

0 commit comments

Comments
 (0)