Merge pull request #33 from wind-python/restructure_turbine_data_reading

SabineHaas · web-flow · commit 145a808c711e · 2019-01-17T19:06:17.000+01:00
Restructure turbine data reading
diff --git a/README.rst b/README.rst
@@ -33,6 +33,8 @@ If you have a working Python 3 environment, use pypi to install the latest windp
 The windpowerlib is designed for Python 3 and tested on Python >= 3.5.
 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.
 
+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.
+
 Optional Packages
 ~~~~~~~~~~~~~~~~~
 
diff --git a/doc/getting_started.rst b/doc/getting_started.rst
@@ -32,6 +32,8 @@ If you have a working Python 3 environment, use pypi to install the latest windp
 The windpowerlib is designed for Python 3 and tested on Python >= 3.5.
 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.
 
+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.
+
 Optional Packages
 ~~~~~~~~~~~~~~~~~
 
diff --git a/doc/modelchain_example_notebook.ipynb b/doc/modelchain_example_notebook.ipynb
@@ -188,7 +188,8 @@
       "12      Enercon    E-82/2350             True          True\n",
       "13      Enercon    E-82/3000             True          True\n",
       "14      Enercon    E-92/2350             True          True\n",
-      "15      Enercon      E48/800             True          True\n"
+      "15      Enercon   E/126/7500             True         False\n",
+      "16      Enercon      E48/800             True          True\n"
      ]
     }
    ],
@@ -256,7 +257,7 @@
       "DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): oep.iks.cs.ovgu.de:80\n",
       "DEBUG:urllib3.connectionpool:http://oep.iks.cs.ovgu.de:80 \"GET //api/v0/schema/model_draft/tables/openfred_windpower_powercurve/rows/ HTTP/1.1\" 301 438\n",
       "DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): openenergy-platform.org:80\n",
-      "DEBUG:urllib3.connectionpool:http://openenergy-platform.org:80 \"GET /api/v0/schema/model_draft/tables/openfred_windpower_powercurve/rows/ HTTP/1.1\" 200 149329\n",
+      "DEBUG:urllib3.connectionpool:http://openenergy-platform.org:80 \"GET /api/v0/schema/model_draft/tables/openfred_windpower_powercurve/rows/ HTTP/1.1\" 200 150623\n",
       "INFO:root:Data base connection successful.\n"
      ]
     }
@@ -284,12 +285,13 @@
    "source": [
     "# specification of wind turbine where power coefficient curve is provided\n",
     "# by a csv file\n",
+    "source = 'data/example_power_coefficient_curves.csv'\n",
     "dummy_turbine = {\n",
     "    'name': 'DUMMY 1',  # turbine type as in file #\n",
     "    'hub_height': 100,  # in m\n",
     "    'rotor_diameter': 70,  # in m\n",
     "    'fetch_curve': 'power_coefficient_curve',  # fetch cp curve #\n",
-    "    'data_source': 'example_power_coefficient_curves.csv'  # data source\n",
+    "    'data_source': source  # data source\n",
     "}\n",
     "# initialize WindTurbine object\n",
     "dummy_turbine = WindTurbine(**dummy_turbine)"
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -2,4 +2,4 @@ sphinx>=1.4
 ipykernel
 nbsphinx
 pandas
-numpy
+requests
diff --git a/doc/whatsnew/v0-1-0.txt b/doc/whatsnew/v0-1-0.txt
@@ -1,6 +1,11 @@
-v0.1.0 (January 16, 2019)
+v0.1.0 (January 17, 2019)
 ++++++++++++++++++++++++++++++++++
 
+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.
+Use :py:func:`~wind_turbine.get_turbine_types` to check whether the turbine types you need are included in the database.
+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>`_
+(see `API tutorial <https://oep-data-interface.readthedocs.io/en/latest/api/how_to.html>`_) or use your own csv file.
+
 New classes
 ###########
 
diff --git a/example/modelchain_example.ipynb b/example/modelchain_example.ipynb
@@ -188,7 +188,8 @@
       "12      Enercon    E-82/2350             True          True\n",
       "13      Enercon    E-82/3000             True          True\n",
       "14      Enercon    E-92/2350             True          True\n",
-      "15      Enercon      E48/800             True          True\n"
+      "15      Enercon   E/126/7500             True         False\n",
+      "16      Enercon      E48/800             True          True\n"
      ]
     }
    ],
@@ -256,7 +257,7 @@
       "DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): oep.iks.cs.ovgu.de:80\n",
       "DEBUG:urllib3.connectionpool:http://oep.iks.cs.ovgu.de:80 \"GET //api/v0/schema/model_draft/tables/openfred_windpower_powercurve/rows/ HTTP/1.1\" 301 438\n",
       "DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): openenergy-platform.org:80\n",
-      "DEBUG:urllib3.connectionpool:http://openenergy-platform.org:80 \"GET /api/v0/schema/model_draft/tables/openfred_windpower_powercurve/rows/ HTTP/1.1\" 200 149329\n",
+      "DEBUG:urllib3.connectionpool:http://openenergy-platform.org:80 \"GET /api/v0/schema/model_draft/tables/openfred_windpower_powercurve/rows/ HTTP/1.1\" 200 150623\n",
       "INFO:root:Data base connection successful.\n"
      ]
     }
@@ -284,13 +285,13 @@
    "source": [
     "# specification of wind turbine where power coefficient curve is provided\n",
     "# by a csv file\n",
-    "csv_file = '../example/data/example_power_coefficient_curves.csv'\n",
+    "source = 'data/example_power_coefficient_curves.csv'\n",
     "dummy_turbine = {\n",
     "    'name': 'DUMMY 1',  # turbine type as in file #\n",
     "    'hub_height': 100,  # in m\n",
     "    'rotor_diameter': 70,  # in m\n",
     "    'fetch_curve': 'power_coefficient_curve',  # fetch cp curve #\n",
-    "    'data_source': csv_file  # data source\n",
+    "    'data_source': source  # data source\n",
     "}\n",
     "# initialize WindTurbine object\n",
     "dummy_turbine = WindTurbine(**dummy_turbine)"
diff --git a/example/modelchain_example.py b/example/modelchain_example.py
@@ -135,7 +135,6 @@ def initialize_wind_turbines():
     # by a csv file
     csv_file = os.path.join(os.path.dirname(__file__), 'data',
                             'example_power_coefficient_curves.csv')
-    # todo adapt in jupyter notebook!!!
     dummy_turbine = {
         'name': 'DUMMY 1',  # turbine type as in file #
         'hub_height': 100,  # in m
diff --git a/setup.py b/setup.py
@@ -16,6 +16,5 @@ def read(fname):
           'windpowerlib': [os.path.join('data', '*.csv')]},
       long_description=read('README.rst'),
       zip_safe=False,
-      install_requires=['numpy >= 1.7.0',
-                        'pandas >= 0.13.1',
+      install_requires=['pandas >= 0.19.1',
                         'requests'])
diff --git a/tests/test_wind_turbine.py b/tests/test_wind_turbine.py
@@ -1,18 +1,20 @@
-import pandas as pd
-from pandas.util.testing import assert_series_equal
 import pytest
+import os
 
-from windpowerlib.wind_turbine import read_turbine_data, WindTurbine
+from windpowerlib.wind_turbine import (get_turbine_data_from_file, WindTurbine,
+                                       get_turbine_types)
 
 class TestWindTurbine:
 
     def test_error_raising(self):
+        source = os.path.join(os.path.dirname(__file__), '../example/data',
+                              'example_power_curves.csv')
         self.test_turbine_data = {'hub_height': 100,
                                   'rotor_diameter': 80,
                                   'name': 'turbine_not_in_file',
                                   'fetch_curve': 'power_curve',
-                                  'data_source': 'example_power_curves.csv'}
-        # Raise system exit
+                                  'data_source': source}
+        # Raise system exit due to turbine type not in file
         with pytest.raises(SystemExit):
             test_turbine = WindTurbine(**self.test_turbine_data)
 
@@ -22,8 +24,17 @@ def test_error_raising(self):
         with pytest.raises(ValueError):
             test_turbine = WindTurbine(**self.test_turbine_data)
 
-    def test_read_turbine_data(self):
+        # Raise KeyError due to turbine type not in oedb
+        self.test_turbine_data['fetch_curve'] = 'power_curve'
+        self.test_turbine_data['data_source'] = 'oedb'
+        with pytest.raises(KeyError):
+            test_turbine = WindTurbine(**self.test_turbine_data)
+
+
+    def test_get_turbine_data_from_file(self):
         # Raise FileNotFoundError due to missing
         with pytest.raises(FileNotFoundError):
-            read_turbine_data(filename='not_existent')
+            get_turbine_data_from_file(turbine_type='...', file_='not_existent')
 
+    def test_get_turbine_types(self):
+        get_turbine_types(print_out=False)
diff --git a/windpowerlib/modelchain.py b/windpowerlib/modelchain.py
@@ -318,7 +318,7 @@ def wind_speed_hub(self, weather_df):
 
     def calculate_power_output(self, wind_speed_hub, density_hub):
         r"""
-        Calculates the power output of the wind turbine. # todo power plant output????
+        Calculates the power output of the wind power plant.
 
         The method specified by the parameter `power_output_model` is used.
 
@@ -358,7 +358,7 @@ def calculate_power_output(self, wind_speed_hub, density_hub):
                         self.power_plant.power_coefficient_curve[
                             'wind_speed'],
                         self.power_plant.power_coefficient_curve[
-                            'power coefficient'],
+                            'power_coefficient'],
                         self.power_plant.rotor_diameter, density_hub))
         else:
             raise ValueError("'{0}' is an invalid value. ".format(
diff --git a/windpowerlib/power_curves.py b/windpowerlib/power_curves.py
@@ -126,7 +126,7 @@ def smooth_power_curve(power_curve_wind_speeds, power_curve_values,
         raise ValueError("{} is no valid `standard_deviation_method`. Valid "
                          + "options are 'turbulence_intensity', or "
                          + "'Staffell_Pfenninger'".format(
-            standard_deviation_method))
+                                 standard_deviation_method))
     # Initialize list for power curve values
     smoothed_power_curve_values = []
     # Append wind speeds to `power_curve_wind_speeds`
@@ -225,7 +225,8 @@ def wake_losses_to_power_curve(power_curve_wind_speeds, power_curve_values,
                     wake_losses_model, wind_farm_efficiency))
         df = pd.concat([power_curve_df.set_index('wind_speed'),
                         wind_farm_efficiency.set_index('wind_speed')], axis=1)
-        # Add column with reduced power (nan values of efficiency are interpolated)
+        # Add column with reduced power (nan values of efficiency are
+        # interpolated)
         df['reduced_power'] = df['power'] * df['efficiency'].interpolate(
             method='index')
         reduced_power = df['reduced_power'].dropna()
diff --git a/windpowerlib/wake_losses.py b/windpowerlib/wake_losses.py
@@ -136,7 +136,7 @@ def get_wind_efficiency_curve(curve_name='all'):
         # Raise error if wind efficiency curve specified in 'curve_name' does
         # not exist
         if curve_name not in list(wind_efficiency_curves):
-            msg = ("Efficiency curve <{0}> does not exist. Must be one of the" 
+            msg = ("Efficiency curve <{0}> does not exist. Must be one of the"
                    "following: {1}.")
             raise ValueError(msg.format(curve_name, *possible_curve_names))
 
diff --git a/windpowerlib/wind_farm.py b/windpowerlib/wind_farm.py
@@ -264,14 +264,13 @@ def assign_power_curve(self, wake_losses_model='power_efficiency_curve',
                     power_curve = pd.concat(
                         [pd.DataFrame(data={
                             'power': [0.0], 'wind_speed': [0.0]}),
-                         power_curve], sort=False)
+                         power_curve])
                 if power_curve.iloc[-1]['power'] != 0.0:
                     power_curve = pd.concat(
                         [power_curve, pd.DataFrame(data={
                             'power': [0.0], 'wind_speed': [
                                 power_curve['wind_speed'].loc[
-                                    power_curve.index[-1]] + 0.5]})],
-                        sort=False)
+                                    power_curve.index[-1]] + 0.5]})])
             # Add power curves of all turbine types to data frame
             # (multiplied by turbine amount)
             df = pd.concat(
diff --git a/windpowerlib/wind_turbine.py b/windpowerlib/wind_turbine.py
