Skip to content

Commit cf7363e

Browse files
committed
Change default value and adapt docstrings
1 parent 3b8bac1 commit cf7363e

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

windpowerlib/power_curves.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def smooth_power_curve(power_curve_wind_speeds, power_curve_values,
126126

127127

128128
def wake_losses_to_power_curve(power_curve_wind_speeds, power_curve_values,
129-
wake_losses_method='constant_efficiency',
129+
wake_losses_method='wind_efficiency_curve',
130130
wind_farm_efficiency=None):
131131
r"""
132132
Applies wake losses depending on the method to a power curve.
@@ -141,7 +141,8 @@ def wake_losses_to_power_curve(power_curve_wind_speeds, power_curve_values,
141141
`power_curve_wind_speeds`.
142142
wake_losses_method : String
143143
Defines the method for talking wake losses within the farm into
144-
consideration. Default: 'constant_efficiency'.
144+
consideration. Options: 'wind_efficiency_curve', 'constant_efficiency'.
145+
Default: 'wind_efficiency_curve'.
145146
wind_farm_efficiency : Float or pd.DataFrame or Dictionary
146147
Efficiency of the wind farm. Either constant (float) or wind efficiency
147148
curve (pd.DataFrame or Dictionary) contianing 'wind_speed' and
@@ -188,7 +189,7 @@ def wake_losses_to_power_curve(power_curve_wind_speeds, power_curve_values,
188189
power_curve_df.columns = ['wind_speed', 'power']
189190
else:
190191
raise ValueError(
191-
"`wake_losses_method` is {0} but should be None, ".format(
192+
"`wake_losses_method` is {0} but should be ".format(
192193
wake_losses_method) +
193194
"'constant_efficiency' or 'wind_efficiency_curve'")
194195
return power_curve_df

windpowerlib/turbine_cluster_modelchain.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ class TurbineClusterModelChain(object):
2727
before the summation. Default: False.
2828
wake_losses_method : String
2929
Defines the method for talking wake losses within the farm into
30-
consideration. Default: 'constant_efficiency'.
30+
consideration. Options: 'wind_efficiency_curve', 'constant_efficiency'
31+
or None. Default: 'wind_efficiency_curve'.
3132
smoothing : Boolean
3233
If True the power curves will be smoothed before the summation.
3334
Default: True.
@@ -61,7 +62,8 @@ class TurbineClusterModelChain(object):
6162
before the summation. Default: False.
6263
wake_losses_method : String
6364
Defines the method for talking wake losses within the farm into
64-
consideration. Default: 'constant_efficiency'.
65+
consideration. Options: 'wind_efficiency_curve', 'constant_efficiency'
66+
or None. Default: 'wind_efficiency_curve'.
6567
smoothing : Boolean
6668
If True the power curves will be smoothed before the summation.
6769
Default: True.
@@ -88,7 +90,7 @@ class TurbineClusterModelChain(object):
8890
8991
"""
9092
def __init__(self, wind_object, density_correction=False,
91-
wake_losses_method='constant_efficiency', smoothing=True,
93+
wake_losses_method='wind_efficiency_curve', smoothing=True,
9294
block_width=0.5,
9395
standard_deviation_method='turbulence_intensity',
9496
density_correction_order='wind_farm_power_curves',

0 commit comments

Comments
 (0)