Merge branch 'rename_power_cp_curve_column' into release_branch

Author: SabineHaas

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 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.
+
 Optional Packages
 ~~~~~~~~~~~~~~~~~
 

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 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.
+
 Optional Packages
 ~~~~~~~~~~~~~~~~~
 

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)"

doc/requirements.txt

@@ -2,4 +2,4 @@ sphinx>=1.4
 ipykernel
 nbsphinx
 pandas
-numpy
+requests

doc/whatsnew/v0-1-0.txt

@@ -1,6 +1,10 @@
-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 OpenEnergy 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 use your own csv file or open an issue.
+
 New classes
 ###########
 
@@ -17,7 +21,7 @@ New functions
  * logarithmic interpolation/extrapolation for wind speed time series
  * gauss distribution (needed for power curve smoothing)
  * estimation of turbulence intensity by roughness length
- * retrieve power curves from Open Energy Database
+ * retrieve power curves from OpenEnergy Database
 
 
 Testing
@@ -38,7 +42,7 @@ API changes
 
  * renamed attribute `turbine_name` of WindTurbine class to `name` to match with `name` attribute of WindFarm and WindTurbineCluster class
  * renamed `basic_example` to `modelchain_example`
- * renamed column 'values' of power curves to 'power' and column 'values' of power coefficient curves to 'power coefficient'
+ * renamed column 'values' of power (coefficient) curves to 'value' to prevent errors using df.value(s)
  * renamed `run_basic_example()` to `run_example()` in `modelchain_example`
  * renamed parameter `wind_turbine` of `ModelChain` object to `power_plant`
  * removed parameter `density_correction` from `power_plant.power_coefficient()`

doc/whatsnew/v0-1-0-1.txt doc/whatsnew/v0-1-1.txtdoc/whatsnew/v0-1-0-1.txt renamed to doc/whatsnew/v0-1-1.txt

@@ -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"
      ]
     }
    ],
@@ -236,7 +237,7 @@
     "    'hub_height': 105,  # in m\n",
     "    'rotor_diameter': 90,  # in m\n",
     "    'power_curve': pd.DataFrame(\n",
-    "            data={'power': [p * 1000 for p in [\n",
+    "            data={'value': [p * 1000 for p in [\n",
     "                      0.0, 26.0, 180.0, 1500.0, 3000.0, 3000.0]],  # in W\n",
     "                  'wind_speed': [0.0, 3.0, 5.0, 10.0, 15.0, 25.0]})  # in m/s\n",
     "    }  \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)"
@@ -524,20 +525,20 @@
     "if plt:\n",
     "    if e126.power_coefficient_curve is not None:\n",
     "        e126.power_coefficient_curve.plot(\n",
-    "            x='wind_speed', y='power coefficient', style='*',\n",
+    "            x='wind_speed', y='value', style='*',\n",
     "            title='Enercon E126 power coefficient curve')\n",
     "        plt.show()\n",
     "    if e126.power_curve is not None:\n",
-    "        e126.power_curve.plot(x='wind_speed', y='power', style='*',\n",
+    "        e126.power_curve.plot(x='wind_speed', y='value', style='*',\n",
     "                              title='Enercon E126 power curve')\n",
     "        plt.show()\n",
     "    if my_turbine.power_coefficient_curve is not None:\n",
     "        my_turbine.power_coefficient_curve.plot(\n",
-    "            x='wind_speed', y='power coefficient', style='*',\n",
+    "            x='wind_speed', y='value', style='*',\n",
     "            title='myTurbine power coefficient curve')\n",
     "        plt.show()\n",
     "    if my_turbine.power_curve is not None:\n",
-    "        my_turbine.power_curve.plot(x='wind_speed', y='power', style='*',\n",
+    "        my_turbine.power_curve.plot(x='wind_speed', y='value', style='*',\n",
     "                                    title='myTurbine power curve')\n",
     "        plt.show()"
    ]

example/modelchain_example.ipynb

@@ -90,7 +90,7 @@ def initialize_wind_turbines():
 
     Function shows three ways to initialize a WindTurbine object. You can
     either specify your own turbine, as done below for 'my_turbine', or fetch
-    power and/or power coefficient curve data from the Open Energy Database
+    power and/or power coefficient curve data from the OpenEnergy Database
     (oedb), as done for the 'enercon_e126', or provide your turbine data in csv
     files as done for 'dummy_turbine' with an example file.
     Execute ``windpowerlib.wind_turbine.get_turbine_types()`` to get a table
@@ -111,7 +111,7 @@ def initialize_wind_turbines():
         'hub_height': 105,  # in m
         'rotor_diameter': 90,  # in m
         'power_curve': pd.DataFrame(
-            data={'power': [p * 1000 for p in [
+            data={'value': [p * 1000 for p in [
                       0.0, 26.0, 180.0, 1500.0, 3000.0, 3000.0]],  # in W
                   'wind_speed': [0.0, 3.0, 5.0, 10.0, 15.0, 25.0]})  # in m/s
     }
@@ -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
@@ -168,7 +167,7 @@ def calculate_power_output(weather, my_turbine, e126, dummy_turbine):
     my_turbine : WindTurbine
         WindTurbine object with self provided power curve.
     e126 : WindTurbine
-        WindTurbine object with power curve from the Open Energy Database.
+        WindTurbine object with power curve from the OpenEnergy Database.
     dummy_turbine : WindTurbine
         WindTurbine object with power coefficient curve from example file.
 
@@ -247,7 +246,7 @@ def plot_or_print(my_turbine, e126, dummy_turbine):
                 title='Enercon E126 power coefficient curve')
             plt.show()
         if e126.power_curve is not None:
-            e126.power_curve.plot(x='wind_speed', y='power', style='*',
+            e126.power_curve.plot(x='wind_speed', y='value', style='*',
                                   title='Enercon E126 power curve')
             plt.show()
         if my_turbine.power_coefficient_curve is not None:
@@ -256,7 +255,7 @@ def plot_or_print(my_turbine, e126, dummy_turbine):
                 title='myTurbine power coefficient curve')
             plt.show()
         if my_turbine.power_curve is not None:
-            my_turbine.power_curve.plot(x='wind_speed', y='power', style='*',
+            my_turbine.power_curve.plot(x='wind_speed', y='value', style='*',
                                         title='myTurbine power curve')
             plt.show()
     else:

example/modelchain_example.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'])

setup.py

@@ -18,7 +18,7 @@ def setup_class(self):
     def test_smooth_power_curve(self):
         test_curve = wt.WindTurbine(**self.test_turbine).power_curve
         parameters = {'power_curve_wind_speeds': test_curve['wind_speed'],
-                      'power_curve_values': test_curve['power'],
+                      'power_curve_values': test_curve['value'],
                       'standard_deviation_method': 'turbulence_intensity'}
 
         # Raise ValueError - `turbulence_intensity` missing
@@ -32,7 +32,7 @@ def test_smooth_power_curve(self):
                                           name='wind_speed')
         power_values_exp = pd.Series([
             1141906.9806766496, 1577536.8085282773, 1975480.993355767,
-            2314059.4022704284, 2590216.6802602503], name='power')
+            2314059.4022704284, 2590216.6802602503], name='value')
         smoothed_curve_exp = pd.DataFrame(data=pd.concat([
             wind_speed_values_exp, power_values_exp], axis=1))
         smoothed_curve_exp.index = np.arange(5, 10, 1)
@@ -43,7 +43,7 @@ def test_smooth_power_curve(self):
         parameters['standard_deviation_method'] = 'Staffell_Pfenninger'
         power_values_exp = pd.Series([
             929405.1348918702, 1395532.5468724659, 1904826.6851982325,
-            2402659.118305521, 2844527.1732449625], name='power')
+            2402659.118305521, 2844527.1732449625], name='value')
         smoothed_curve_exp = pd.DataFrame(
             data=pd.concat([wind_speed_values_exp, power_values_exp], axis=1))
         smoothed_curve_exp.index = np.arange(5, 10, 1)
@@ -58,13 +58,13 @@ def test_smooth_power_curve(self):
     def test_wake_losses_to_power_curve(self):
         test_curve = wt.WindTurbine(**self.test_turbine).power_curve
         parameters = {'power_curve_wind_speeds': test_curve['wind_speed'],
-                      'power_curve_values': test_curve['power'],
+                      'power_curve_values': test_curve['value'],
                       'wind_farm_efficiency': 0.9,
                       'wake_losses_model': 'constant_efficiency'}
 
         # Test constant efficiency
         power_curve_exp = test_curve.copy(deep=True)
-        power_curve_exp['power'] = power_curve_exp['power'].values * 0.9
+        power_curve_exp['value'] = power_curve_exp['value'].values * 0.9
         assert_frame_equal(wake_losses_to_power_curve(**parameters),
                            power_curve_exp)
 
@@ -85,8 +85,8 @@ def test_wake_losses_to_power_curve(self):
         parameters['wind_farm_efficiency'].columns = ['wind_speed',
                                                       'efficiency']
         power_curve_exp = test_curve.copy(deep=True)
-        power_curve_exp['power'] = (
-            power_curve_exp['power'].values * parameters[
+        power_curve_exp['value'] = (
+            power_curve_exp['value'].values * parameters[
                 'wind_farm_efficiency']['efficiency'])
         assert_frame_equal(wake_losses_to_power_curve(**parameters),
                            power_curve_exp)