Skip to content

Commit ee0d90b

Browse files
committed
Improve docstrings
1 parent 2085f0d commit ee0d90b

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

windpowerlib/turbine_cluster_modelchain.py

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,41 @@ class TurbineClusterModelChain(ModelChain):
3131
* None -
3232
Wake losses are not taken into account.
3333
* 'wind_farm_efficiency' -
34+
The values of the wind farm power curve(s) are reduced by the wind
35+
farm efficiency, which needs to be set in the
36+
:py:class:`~.wind_farm.WindFarm` class. Note: The wind farm
37+
efficiency has no effect if `wake_losses_model` is not set to
38+
'wind_farm_efficiency'.
3439
See :func:`~.power_curves.wake_losses_to_power_curve` for more
3540
information.
3641
* 'dena_mean' or name of other wind efficiency curve -
42+
The values of the wind speed time series are reduced by the chosen
43+
wind efficiency curve in :func:`~.run_model` before the power output
44+
calculations.
3745
See :func:`~.wake_losses.reduce_wind_speed` and
3846
:func:`~.wake_losses.get_wind_efficiency_curve` for more information.
3947
4048
Default: 'dena_mean'.
4149
smoothing : bool
42-
If True the power curves will be smoothed. Depending on the parameter
43-
`smoothing_order` the power curves are smoothed before or after the
44-
aggregation. See :func:`~.power_curves.smooth_power_curve` for more
45-
information. Default: False.
50+
If True the power curves will be smoothed to account for the
51+
distribution of wind speeds over space. Depending on the parameter
52+
`smoothing_order` the power curves are smoothed before or after
53+
aggregating wind turbine power curves to one representative power
54+
curve of the wind farm or cluster.
55+
See :func:`~.power_curves.smooth_power_curve` for more information.
56+
57+
Default: False.
4658
block_width : float
4759
Width between the wind speeds in the sum of the equation in
48-
:py:func:`~.power_curves.smooth_power_curve`. Default: 0.5.
60+
:py:func:`~.power_curves.smooth_power_curve`. This parameter is only
61+
used if `smoothing` is True. To achieve a smooth curve without steps a
62+
value not much higher than the step width between the power curve wind
63+
speeds should be chosen.
64+
65+
Default: 0.5.
4966
standard_deviation_method : str
5067
Method for calculating the standard deviation for the Gauss
51-
distribution.
68+
distribution if `smoothing` is True.
5269
5370
* 'turbulence_intensity' -
5471
See :func:`~.power_curves.smooth_power_curve` for more information.

0 commit comments

Comments
 (0)