Skip to content

Commit 431eea7

Browse files
committed
Add Example in docstring
1 parent e181fd6 commit 431eea7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

windpowerlib/wind_farm.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,25 @@ class WindFarm(object):
6161
power_output : pandas.Series
6262
The calculated power output of the wind farm.
6363
64+
Examples TODO: test example
65+
--------
66+
>>> from windpowerlib import wind_farm
67+
>>> from windpowerlib import wind_turbine
68+
>>> enerconE126 = {
69+
... 'hub_height': 135,
70+
... 'rotor_diameter': 127,
71+
... 'name': 'ENERCON E 126 7500',
72+
... 'fetch_curve': 'power_curve'}
73+
>>> e126 = wind_turbine.WindTurbine(**enerconE126)
74+
>>> example_farm_data = {
75+
... 'name': 'example_farm',
76+
... 'wind_turbine_fleet': [{'wind_turbine': e126,
77+
... 'number_of_turbines': 6}]}
78+
>>> example_farm = wind_farm.WindFarm(**example_farm_data)
79+
>>> example_farm.installed_power = get_installed_power()
80+
>>> print(example_farm.installed_power)
81+
45000000
82+
6483
"""
6584
def __init__(self, name, wind_turbine_fleet, coordinates=None,
6685
efficiency=None):

0 commit comments

Comments
 (0)