Skip to content

Commit 32ad6b8

Browse files
committed
Adapt docstring
1 parent 36f1b7e commit 32ad6b8

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

windpowerlib/wind_farm.py

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,29 @@ class WindFarm(object):
2121
2222
Parameters
2323
----------
24-
wind_turbine_fleet : :pandas:`pandas.DataFrame<frame>` or list()
25-
Wind turbines of the wind farm.
24+
wind_turbine_fleet : :pandas:`pandas.DataFrame<frame>` or list(:class:`~windpowerlib.wind_turbine.WindTurbineGroup`)
25+
The wind turbine fleet specifies the turbine types in the wind farm and
26+
their corresponding number or total installed capacity. There are
27+
different options to provide the wind turbine fleet (see also examples
28+
below):
29+
30+
* :pandas:`pandas.DataFrame<frame>` -
31+
DataFrame must have columns 'wind_turbine' containing a
32+
:class:`~.wind_turbine.WindTurbine` object and either
33+
'number_of_turbines' (number of wind turbines of the same turbine
34+
type in the wind farm, can be a float) or 'total_capacity'
35+
(installed capacity of wind turbines of the same turbine type in the
36+
wind farm).
37+
38+
* list(:class:`~windpowerlib.wind_turbine.WindTurbineGroup`) -
39+
A :class:`~windpowerlib.wind_turbine.WindTurbineGroup` can be created
40+
from a :class:`~windpowerlib.wind_turbine.WindTurbine` using the
41+
:func:`~windpowerlib.wind_turbine.WindTurbine.to_group` method.
42+
43+
* list(dict) -
44+
It is still possible to use a list of dictionaries (see example) but
45+
we recommend to use one of the other options above.
2646
27-
1. DataFrame must have 'wind_turbine' containing a
28-
:class:`~.wind_turbine.WindTurbine` object and either
29-
'number_of_turbines' (number of wind turbines of the same turbine type
30-
in the wind farm, can be a float) or 'total_capacity'
31-
(installed capacity of wind turbines of the same turbine type in the
32-
wind farm) as columns/keys. See example below.
33-
34-
2. A list of :class:`~windpowerlib.wind_turbine.WindTurbineGroup`
35-
objects. A WindTurbineGroup can be created from a
36-
:class:`~windpowerlib.wind_turbine.WindTurbine` using the
37-
:func:`~windpowerlib.wind_turbine.WindTurbine.to_group` method.
38-
39-
3. It is still possible to use a list of dict (see example) but we
40-
recommend to use one of the other options above.
4147
efficiency : float or :pandas:`pandas.DataFrame<frame>` or None (optional)
4248
Efficiency of the wind farm. Provide as either constant (float) or
4349
power efficiency curve (pd.DataFrame) containing 'wind_speed' and

0 commit comments

Comments
 (0)