Skip to content

Commit 160ee20

Browse files
committed
Merge branch 'refactor_v0.2.0_branch' of github.com:wind-python/windpowerlib into refactor_v0.2.0_branch
2 parents da59b3d + b1f9264 commit 160ee20

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
@@ -27,28 +27,36 @@ class WindTurbine(object):
2727
power_curve : :pandas:`pandas.DataFrame<frame>` or dict (optional)
2828
Directly sets the power curve. DataFrame/dictionary must have
2929
'wind_speed' and 'value' columns/keys with wind speeds in m/s and
30-
the corresponding power curve value in W.
30+
the corresponding power curve value in W. If not set the value is
31+
retrieved from 'power_curve.csv' file in `path`. In that case a
32+
`turbine_type` is needed. Default: None.
3133
power_coefficient_curve : :pandas:`pandas.DataFrame<frame>` or dict (optional)
3234
Directly sets the power coefficient curve. DataFrame/dictionary must
3335
have 'wind_speed' and 'value' columns/keys with wind speeds in m/s
34-
and the corresponding power coefficient curve value.
36+
and the corresponding power coefficient curve value. If not set the
37+
value is retrieved from 'power_coefficient_curve.csv' file in `path`.
38+
In that case a `turbine_type` is needed. Default: None.
3539
turbine_type : str (optional)
3640
Name of the wind turbine type. Must be provided if power (coefficient)
37-
curve is retrieved from oedb turbine library or self provided file.
41+
curve, nominal power or rotor diameter is retrieved from self-provided
42+
or oedb turbine library csv files. If turbine_type is None it is not
43+
possible to retrieve turbine data from file.
3844
Use :py:func:`~.get_turbine_types` to see a table of all wind turbines
39-
for which power (coefficient) curve data is provided. If turbine_type
40-
is None it is not possible to retrieve turbine data from file.
41-
rotor_diameter : None or float (optional)
45+
for which power (coefficient) curve data and other turbine data is
46+
provided in the oedb turbine library.
47+
Default: None.
48+
rotor_diameter : float (optional)
4249
Diameter of the rotor in m. Only needs to be provided if power output
43-
is calculated using the power coefficient curve.
44-
nominal_power : None or float (optional)
50+
is calculated using the power coefficient curve. Default: None.
51+
nominal_power : float (optional)
4552
The nominal power of the wind turbine in W. If not set the value is
46-
retrieved from file. In that case a `turbine_type` is needed.
53+
retrieved from 'turbine_data.csv' file in `path`. In that case a
54+
`turbine_type` is needed. Default: None.
4755
path : str (optional)
4856
Directory where the turbine database files are located. The names of
49-
the files are fix 'power_coefficient_curve.csv', 'power_curve.csv',
57+
the files need to be 'power_coefficient_curve.csv', 'power_curve.csv',
5058
'turbine_data.csv'. Set path to `None` to ignore turbine data from
51-
files.
59+
files. Default: 'oedb'.
5260
5361
Attributes
5462
----------

0 commit comments

Comments
 (0)