Skip to content

Commit 9e922c9

Browse files
committed
Update documentation
1 parent afae9cd commit 9e922c9

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

doc/modules.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ Classes
1111
:toctree: temp/
1212

1313
wind_turbine.WindTurbine
14+
wind_farm.WindFarm
15+
wind_turbine_cluster.WindTurbineCluster
1416
modelchain.ModelChain
17+
turbine_cluster_modelchain.TurbineClusterModelChain
1518

1619

1720
Temperature
@@ -76,6 +79,18 @@ Functions for calculating power output of a wind turbine.
7679
power_output.power_curve_density_correction
7780

7881

82+
Alteration of power curves
83+
==============
84+
85+
Functions for smoothing power curves or applying wake losses.
86+
87+
.. autosummary::
88+
:toctree: temp/
89+
90+
power_curves.smooth_power_curve
91+
power_curves.wake_losses_to_power_curve
92+
93+
7994
ModelChain
8095
==============
8196

@@ -104,6 +119,35 @@ Methods of the ModelChain object.
104119
modelchain.ModelChain.turbine_power_output
105120

106121

122+
TurbineClusterModelChain
123+
==============
124+
The TurbineClusterModelChain inherits all functions from the ModelChain.
125+
126+
Creating a TurbineClusterModelChain object.
127+
128+
.. autosummary::
129+
:toctree: temp/
130+
131+
turbine_cluster_modelchain.TurbineClusterModelChain
132+
133+
Running the TurbineClusterModelChain.
134+
135+
.. autosummary::
136+
:toctree: temp/
137+
138+
turbine_cluster_modelchain.TurbineClusterModelChain.run_model
139+
140+
Methods of the TurbineClusterModelChain object.
141+
142+
.. autosummary::
143+
:toctree: temp/
144+
145+
turbine_cluster_modelchain.TurbineClusterModelChain.temperature_hub
146+
turbine_cluster_modelchain.TurbineClusterModelChain.density_hub
147+
turbine_cluster_modelchain.TurbineClusterModelChain.wind_speed_hub
148+
turbine_cluster_modelchain.TurbineClusterModelChain.turbine_power_output
149+
150+
107151
Tools
108152
==============
109153

@@ -113,6 +157,9 @@ Additional functions used in the windpowerlib.
113157
:toctree: temp/
114158

115159
tools.linear_interpolation_extrapolation
160+
tools.logarithmic_interpolation_extrapolation
161+
tools.gauss_distribution
162+
tools.estimate_turbulence_intensity
116163

117164

118165
Example

0 commit comments

Comments
 (0)