Skip to content

Commit b628fcc

Browse files
committed
Adapt documentation
1 parent fc7cd79 commit b628fcc

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

windpowerlib/wind_turbine.py

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ class WindTurbine(object):
5454
data_source : string
5555
Specifies whether turbine data (f.e. nominal power, power curve, power
5656
coefficient curve) is loaded from the Open Energy Database ('oedb') or
57-
from a csv file ('<name of csv file>'). See `example_power_curves.csv'
58-
and `example_power_coefficient_curves.csv` in windpowerlib/data for
59-
the required form of a csv file. Default: 'oedb'.
57+
from a csv file ('<path including file name>'). See
58+
`example_power_curves.csv' and `example_power_coefficient_curves.csv`
59+
in example/data for the required form of a csv file. Default: 'oedb'.
6060
6161
Attributes
6262
----------
@@ -87,9 +87,11 @@ class WindTurbine(object):
8787
Notes
8888
------
8989
Your wind turbine object should have a power coefficient or power curve.
90-
You can set the `fetch_curve` parameter and the `data_source` parameter if
91-
you don't want to provide one yourself but want to automatically fetch a
92-
curve from a data set provided in the Open Energy Database (oedb).
90+
You can set the `fetch_curve` parameter and the `data_source` parameter
91+
want to automatically fetch a curve from a data set provided in the Open
92+
Energy Database (oedb) or want to read a csv file that you provide.
93+
See `example_power_curves.csv' and `example_power_coefficient_curves.csv`
94+
in example/data for the required form of such a csv file.
9395
9496
Examples
9597
--------
@@ -145,10 +147,12 @@ def fetch_turbine_data(self, fetch_curve, data_source):
145147
data_source : string
146148
Specifies whether turbine data (f.e. nominal power, power curve,
147149
power coefficient curve) is loaded from the Open Energy Database
148-
('oedb') or from a csv file ('<name of csv file>'). See
149-
`example_power_curves.csv` and
150-
`example_power_coefficient_curves.csv` in windpowerlib/data for the
150+
('oedb') or from a csv file ('<path including file name>'). See
151+
`example_power_curves.csv' and
152+
`example_power_coefficient_curves.csv` in example/data for the
151153
required form of a csv file. Default: 'oedb'.
154+
See :py:func:`~.read_turbine_data` for an example reading data from
155+
a csv file.
152156
153157
Returns
154158
-------
@@ -255,8 +259,7 @@ def read_turbine_data(file_):
255259
----------
256260
file_ : string
257261
Specifies the source of the turbine data.
258-
Use 'example_power_coefficient_curves.csv' or # todo adapt
259-
'example_power_curves.csv' to use the example data.
262+
See the example below for how to use the example data.
260263
261264
Returns
262265
-------

0 commit comments

Comments
 (0)