Skip to content

Commit d03893a

Browse files
committed
Adapt docstrings and whatsnew
1 parent 2dee052 commit d03893a

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ If you have a working Python 3 environment, use pypi to install the latest windp
3333
The windpowerlib is designed for Python 3 and tested on Python >= 3.5.
3434
Please see the `installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the oemof documentation for complete instructions on how to install python and a virtual environment on your operating system.
3535

36-
For retrieving power (coefficient) curves from the Open Energy Database (oedb) the python package requests will be installed with your windpowerlib installation. The windpowerlib was tested with requests version 2.20.1 but might work with lower versions.
36+
For retrieving power (coefficient) curves from the OpenEnergy Database (oedb) the python package requests will be installed with your windpowerlib installation. The windpowerlib was tested with requests version 2.20.1 but might work with lower versions.
3737

3838
Optional Packages
3939
~~~~~~~~~~~~~~~~~

doc/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If you have a working Python 3 environment, use pypi to install the latest windp
3232
The windpowerlib is designed for Python 3 and tested on Python >= 3.5.
3333
Please see the `installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the oemof documentation for complete instructions on how to install python and a virtual environment on your operating system.
3434

35-
For retrieving power (coefficient) curves from the Open Energy Database (oedb) the python package requests will be installed with your windpowerlib installation. The windpowerlib was tested with requests version 2.20.1 but might work with lower versions.
35+
For retrieving power (coefficient) curves from the OpenEnergy Database (oedb) the python package requests will be installed with your windpowerlib installation. The windpowerlib was tested with requests version 2.20.1 but might work with lower versions.
3636

3737
Optional Packages
3838
~~~~~~~~~~~~~~~~~

doc/whatsnew/v0-1-0.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
v0.1.0 (January 17, 2019)
22
++++++++++++++++++++++++++++++++++
33

4-
ATTENTION: From v0.1.0 on power (coefficient) curves are provided by the Open Energy Database (oedb) instead of in csv files (v0.6.0 and lower) due to legal reasons.
4+
ATTENTION: From v0.1.0 on power (coefficient) curves are provided by the OpenEnergy Database (oedb) instead of in csv files (v0.6.0 and lower) due to legal reasons.
55
Use :py:func:`~wind_turbine.get_turbine_types` to check whether the turbine types you need are included in the database.
6-
If your turbine type is not included you can either add it to the `database <https://openenergy-platform.org/dataedit/view/model_draft/openfred_windpower_powercurve>`_
7-
(see `API tutorial <https://oep-data-interface.readthedocs.io/en/latest/api/how_to.html>`_) or use your own csv file.
6+
If your turbine type is not included you can either use your own csv file or open an issue.
87

98
New classes
109
###########
@@ -22,7 +21,7 @@ New functions
2221
* logarithmic interpolation/extrapolation for wind speed time series
2322
* gauss distribution (needed for power curve smoothing)
2423
* estimation of turbulence intensity by roughness length
25-
* retrieve power curves from Open Energy Database
24+
* retrieve power curves from OpenEnergy Database
2625

2726

2827
Testing

example/modelchain_example.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def initialize_wind_turbines():
9090
9191
Function shows three ways to initialize a WindTurbine object. You can
9292
either specify your own turbine, as done below for 'my_turbine', or fetch
93-
power and/or power coefficient curve data from the Open Energy Database
93+
power and/or power coefficient curve data from the OpenEnergy Database
9494
(oedb), as done for the 'enercon_e126', or provide your turbine data in csv
9595
files as done for 'dummy_turbine' with an example file.
9696
Execute ``windpowerlib.wind_turbine.get_turbine_types()`` to get a table
@@ -167,7 +167,7 @@ def calculate_power_output(weather, my_turbine, e126, dummy_turbine):
167167
my_turbine : WindTurbine
168168
WindTurbine object with self provided power curve.
169169
e126 : WindTurbine
170-
WindTurbine object with power curve from the Open Energy Database.
170+
WindTurbine object with power curve from the OpenEnergy Database.
171171
dummy_turbine : WindTurbine
172172
WindTurbine object with power coefficient curve from example file.
173173

windpowerlib/wind_turbine.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class WindTurbine(object):
4747
Default: None.
4848
data_source : string
4949
Specifies whether turbine data (f.e. nominal power, power curve, power
50-
coefficient curve) is loaded from the Open Energy Database ('oedb') or
50+
coefficient curve) is loaded from the OpenEnergy Database ('oedb') or
5151
from a csv file ('<path including file name>'). Default: 'oedb'.
5252
See `example_power_curves.csv' and
5353
`example_power_coefficient_curves.csv` in example/data for the required
@@ -84,7 +84,7 @@ class WindTurbine(object):
8484
Your wind turbine object should have a power coefficient or power curve.
8585
You can set the `fetch_curve` parameter and the `data_source` parameter if
8686
you want to automatically fetch a curve from a data set provided in the
87-
Open Energy Database (oedb) or want to read a csv file that you provide.
87+
OpenEnergy Database (oedb) or want to read a csv file that you provide.
8888
See `example_power_curves.csv' and `example_power_coefficient_curves.csv`
8989
in example/data for the required form of such a csv file (more columns can
9090
be added).
@@ -146,7 +146,7 @@ def fetch_turbine_data(self, fetch_curve, data_source):
146146
are 'power_curve' and 'power_coefficient_curve'. Default: None.
147147
data_source : string
148148
Specifies whether turbine data (f.e. nominal power, power curve,
149-
power coefficient curve) is loaded from the Open Energy Database
149+
power coefficient curve) is loaded from the OpenEnergy Database
150150
('oedb') or from a csv file ('<path including file name>').
151151
Default: 'oedb'.
152152

0 commit comments

Comments
 (0)