Skip to content

Commit d5b046d

Browse files
committed
Add to docstrings and headers
1 parent 82964ab commit d5b046d

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

windpowerlib/power_curves.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ def wake_losses_to_power_curve(power_curve_wind_speeds, power_curve_values,
129129
`power_curve_wind_speeds`.
130130
wake_losses_method : String
131131
Defines the method for talking wake losses within the farm into
132-
consideration. Options: 'power_efficiency_curve', 'constant_efficiency'.
133-
Default: 'power_efficiency_curve'.
132+
consideration. Options: 'power_efficiency_curve',
133+
'constant_efficiency'. Default: 'power_efficiency_curve'.
134134
wind_farm_efficiency : Float or pd.DataFrame or Dictionary
135135
Efficiency of the wind farm. Either constant (float) or efficiency
136136
curve (pd.DataFrame or Dictionary) containing 'wind_speed' and
@@ -141,7 +141,7 @@ def wake_losses_to_power_curve(power_curve_wind_speeds, power_curve_values,
141141
Returns
142142
-------
143143
power_curve_df : pd.DataFrame
144-
With wind farm efficiency reduced power curve. DataFrame has
144+
With wind farm efficiency reduced power curve. DataFrame has
145145
'wind_speed' and 'power' columns with wind speeds in m/s and the
146146
corresponding power curve value in W.
147147

windpowerlib/turbine_cluster_modelchain.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ class TurbineClusterModelChain(ModelChain):
2525
wake_losses_method : String
2626
Defines the method for talking wake losses within the farm into
2727
consideration. Options: 'power_efficiency_curve',
28-
'constant_efficiency', 'dena_mean', 'knorr_mean' or None. # TODO all curves in WPL
29-
Default: 'dena_mean'.
28+
'constant_efficiency', 'dena_mean', 'knorr_mean', 'dena_extreme1',
29+
'dena_extreme2', 'knorr_extreme1', 'knorr_extreme2', 'knorr_extreme3'
30+
or None. Default: 'dena_mean'.
3031
smoothing : Boolean
3132
If True the power curves will be smoothed before the summation.
3233
Default: True.
@@ -82,8 +83,9 @@ class TurbineClusterModelChain(ModelChain):
8283
wake_losses_method : String
8384
Defines the method for talking wake losses within the farm into
8485
consideration. Options: 'power_efficiency_curve',
85-
'constant_efficiency', 'dena_mean', 'knorr_mean' or None. # TODO all curves in WPL
86-
Default: 'dena_mean'.
86+
'constant_efficiency', 'dena_mean', 'knorr_mean', 'dena_extreme1',
87+
'dena_extreme2', 'knorr_extreme1', 'knorr_extreme2', 'knorr_extreme3'
88+
or None. Default: 'dena_mean'.
8789
smoothing : Boolean
8890
If True the power curves will be smoothed before the summation.
8991
Default: True.

windpowerlib/wake_losses.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
The ``wake_losses`` module contains functions to TODO: add
2+
The ``wake_losses`` module contains functions for the modelling of wake losses.
33
44
"""
55

0 commit comments

Comments
 (0)