Skip to content

Commit e35bcc9

Browse files
committed
Minor docstring changes
1 parent 7a4447b commit e35bcc9

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

windpowerlib/wind_turbine.py

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ def fetch_turbine_data(self, fetch_curve, data_source):
127127
Fetches data of the requested wind turbine.
128128
129129
Method fetches nominal power as well as power coefficient curve or
130-
power curve from a data set provided in the Open Energy Database
130+
power curve from a data set provided in the OpenEnergy Database
131131
(oedb). You can also import your own power (coefficient) curves from a
132132
file. For that the wind speeds in m/s have to be in the first row and
133133
the corresponding power coefficient curve values or power curve values
@@ -199,13 +199,15 @@ def get_turbine_data_from_file(turbine_type, file_):
199199
Fetches power (coefficient) curve data from a csv file.
200200
201201
See `example_power_curves.csv' and `example_power_coefficient_curves.csv`
202-
in example/data for the required form of a csv file
203-
(more columns can be added).
202+
in example/data for the required format of a csv file. The self-provided
203+
csv file may contain more columns than the example files. Only columns
204+
containing wind speed and the corresponding power or power coefficient as
205+
well as the column 'nominal_power' are taken into account.
204206
205207
Parameters
206208
----------
207209
turbine_type : string
208-
Specifies the turbine type of which data is fetched.
210+
Specifies the turbine type data is fetched for.
209211
file_ : string
210212
Specifies the source of the turbine data.
211213
See the example below for how to use the example data.
@@ -216,7 +218,7 @@ def get_turbine_data_from_file(turbine_type, file_):
216218
Power curve or power coefficient curve (pandas.DataFrame) and nominal
217219
power (float). Power (coefficient) curve DataFrame contains power
218220
coefficient curve values (dimensionless) or power curve values in W
219-
with the corresponding wind speeds in m/s.
221+
as column names with the corresponding wind speeds in m/s.
220222
221223
Examples
222224
--------
@@ -268,12 +270,12 @@ def isfloat(x):
268270

269271
def get_turbine_data_from_oedb(turbine_type, fetch_curve):
270272
r"""
271-
Gets turbine data from the Open Energy Database (oedb).
273+
Gets turbine data from the OpenEnergy Database (oedb).
272274
273275
Parameters
274276
----------
275277
turbine_type : string
276-
Specifies the turbine type of which data is fetched.
278+
Specifies the turbine type data is fetched for.
277279
Use :py:func:`~.get_turbine_types` to see a table of all wind turbines
278280
for which power (coefficient) curve data is provided.
279281
fetch_curve : string
@@ -310,16 +312,16 @@ def get_turbine_data_from_oedb(turbine_type, fetch_curve):
310312

311313
def load_turbine_data_from_oedb():
312314
r"""
313-
Loads turbine data from the Open Energy Database (oedb).
315+
Loads turbine data from the OpenEnergy Database (oedb).
314316
315317
Returns
316318
-------
317319
turbine_data : pd.DataFrame
318-
Contains turbine data of different turbine types like 'manufacturer',
320+
Contains turbine data of different turbines such as 'manufacturer',
319321
'turbine_type', nominal power ('installed_capacity_kw').
320322
321323
"""
322-
# url of Open Energy Platform that contains the oedb
324+
# url of OpenEnergy Platform that contains the oedb
323325
oep_url = 'http://oep.iks.cs.ovgu.de/'
324326
# location of data
325327
schema = 'model_draft'
@@ -329,9 +331,9 @@ def load_turbine_data_from_oedb():
329331
oep_url + '/api/v0/schema/{}/tables/{}/rows/?'.format(
330332
schema, table), )
331333
if result.status_code == 200:
332-
logging.info("Data base connection successful.")
334+
logging.info("Database connection successful.")
333335
else:
334-
raise ConnectionError("Data base connection not successful. " +
336+
raise ConnectionError("Database connection not successful. " +
335337
"Error: ".format(result.status_code))
336338
# extract data
337339
turbine_data = pd.DataFrame(result.json())
@@ -341,7 +343,7 @@ def load_turbine_data_from_oedb():
341343
def get_turbine_types(print_out=True):
342344
r"""
343345
Get the names of all possible wind turbine types for which the power
344-
coefficient curve or power curve is provided in the Open Energy Data Base
346+
coefficient curve or power curve is provided in the OpenEnergy Data Base
345347
(oedb).
346348
347349
Parameters

0 commit comments

Comments
 (0)