Skip to content

Commit b1f9264

Browse files
committed
Adapt WindTurbine docstring
1 parent 6b06924 commit b1f9264

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

windpowerlib/wind_turbine.py

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,36 @@ class WindTurbine(object):
2626
power_curve : :pandas:`pandas.DataFrame<frame>` or dict (optional)
2727
Directly sets the power curve. DataFrame/dictionary must have
2828
'wind_speed' and 'value' columns/keys with wind speeds in m/s and
29-
the corresponding power curve value in W.
29+
the corresponding power curve value in W. If not set the value is
30+
retrieved from 'power_curve.csv' file in `path`. In that case a
31+
`turbine_type` is needed. Default: None.
3032
power_coefficient_curve : :pandas:`pandas.DataFrame<frame>` or dict (optional)
3133
Directly sets the power coefficient curve. DataFrame/dictionary must
3234
have 'wind_speed' and 'value' columns/keys with wind speeds in m/s
33-
and the corresponding power coefficient curve value.
35+
and the corresponding power coefficient curve value. If not set the
36+
value is retrieved from 'power_coefficient_curve.csv' file in `path`.
37+
In that case a `turbine_type` is needed. Default: None.
3438
turbine_type : str (optional)
3539
Name of the wind turbine type. Must be provided if power (coefficient)
36-
curve is retrieved from oedb turbine library or self provided file.
40+
curve, nominal power or rotor diameter is retrieved from self-provided
41+
or oedb turbine library csv files. If turbine_type is None it is not
42+
possible to retrieve turbine data from file.
3743
Use :py:func:`~.get_turbine_types` to see a table of all wind turbines
38-
for which power (coefficient) curve data is provided. If turbine_type
39-
is None it is not possible to retrieve turbine data from file.
40-
rotor_diameter : None or float (optional)
44+
for which power (coefficient) curve data and other turbine data is
45+
provided in the oedb turbine library.
46+
Default: None.
47+
rotor_diameter : float (optional)
4148
Diameter of the rotor in m. Only needs to be provided if power output
42-
is calculated using the power coefficient curve.
43-
nominal_power : None or float (optional)
49+
is calculated using the power coefficient curve. Default: None.
50+
nominal_power : float (optional)
4451
The nominal power of the wind turbine in W. If not set the value is
45-
retrieved from file. In that case a `turbine_type` is needed.
52+
retrieved from 'turbine_data.csv' file in `path`. In that case a
53+
`turbine_type` is needed. Default: None.
4654
path : str (optional)
4755
Directory where the turbine database files are located. The names of
48-
the files are fix 'power_coefficient_curve.csv', 'power_curve.csv',
56+
the files need to be 'power_coefficient_curve.csv', 'power_curve.csv',
4957
'turbine_data.csv'. Set path to `None` to ignore turbine data from
50-
files.
58+
files. Default: 'oedb'.
5159
5260
Attributes
5361
----------

0 commit comments

Comments
 (0)