Skip to content

Commit 9b80875

Browse files
committed
Add third option to wind_turbine_fleet parameter and restructure the section
1 parent cc2b380 commit 9b80875

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

windpowerlib/wind_farm.py

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,22 @@ class WindFarm(object):
2222
Parameters
2323
----------
2424
wind_turbine_fleet : :pandas:`pandas.DataFrame<frame>` or list()
25-
Wind turbines of wind farm. DataFrame must have
26-
'wind_turbine' containing a :class:`~.wind_turbine.WindTurbine` object
27-
and either 'number_of_turbines' (number of wind turbines of the same
28-
turbine type in the wind farm, can be a float) or 'total_capacity'
25+
Wind turbines of the wind farm.
26+
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'
2931
(installed capacity of wind turbines of the same turbine type in the
3032
wind farm) as columns/keys. See example below.
3133
32-
A list of :class:`~windpowerlib.wind_turbine.WindTurbineGroup` objects.
33-
A WindTurbineGroup can be created from a
34+
2. A list of :class:`~windpowerlib.wind_turbine.WindTurbineGroup`
35+
objects. A WindTurbineGroup can be created from a
3436
:class:`~windpowerlib.wind_turbine.WindTurbine` using the
3537
: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.
3641
efficiency : float or :pandas:`pandas.DataFrame<frame>` or None (optional)
3742
Efficiency of the wind farm. Provide as either constant (float) or
3843
power efficiency curve (pd.DataFrame) containing 'wind_speed' and

0 commit comments

Comments
 (0)