Merge branch 'master' into dev

Author: SabineHaas

README.rst

@@ -2,9 +2,9 @@
     :target: https://travis-ci.org/wind-python/windpowerlib
 .. image:: https://coveralls.io/repos/github/wind-python/windpowerlib/badge.svg?branch=dev
     :target: https://coveralls.io/github/wind-python/windpowerlib?branch=dev
-.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.824268.svg
-   :target: https://doi.org/10.5281/zenodo.824268
-
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2542896.svg
+   :target: https://doi.org/10.5281/zenodo.2542896
+   
 Introduction
 =============
 
@@ -35,6 +35,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
 ~~~~~~~~~~~~~~~~~
 
@@ -47,24 +49,20 @@ Matplotlib can be installed using pip3 though some Linux users reported that it
 Examples and basic usage
 =========================
 
-The basic usage of the windpowerlib is shown in the `modelchain_example <http://windpowerlib.readthedocs.io/en/stable/basic_example_notebook.html>`_. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
+The basic usage of the windpowerlib is shown in the `modelchain_example <http://windpowerlib.readthedocs.io/en/stable/modelchain_example_notebook.html>`_. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
 
- * `ModelChain example (Python script) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/basic_example.py>`_
- * `ModelChain example (Jupyter notebook) <https://raw.githubusercontent.com/wind-python/windpowerlib/features/revise_example/example/basic_example.ipynb>`_
+ * `ModelChain example (Python script) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/modelchain_example.py>`_
+ * `ModelChain example (Jupyter notebook) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/modelchain_example.ipynb>`_
  * `Example data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/weather.csv>`_
 
-
 To run the examples you first have to install the windpowerlib. To run the notebook you also need to install notebook using pip3. To launch jupyter notebook type ``jupyter notebook`` in terminal.
 This will open a browser window. Navigate to the directory containing the notebook to open it. See the jupyter notebook quick start guide for more information on `how to install <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/install.html>`_ and
 `how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
 
-Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in a second example. As the ModelChain example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
-
- * `TurbineClusterModelChain example (Python script) <https://raw.githubusercontent.com/wind-python/windpowerlib/release_preparation/example/further_example.py>`_
- * `TurbineClusterModelChain example (Jupyter notebook) <https://raw.githubusercontent.com/wind-python/windpowerlib/release_preparation/example/basic_example.ipynb>`_
- * `Example data file <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/weather.csv>`_
+Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in the `turbine_cluster_modelchain_example <http://windpowerlib.readthedocs.io/en/stable/turbine_cluster_modelchain_example_notebook.html>`_. As the ModelChain example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
 
-You can also look at the examples in the `Examples <https://windpowerlib.readthedocs.io/en/latest/examples.html>`_ section.
+ * `TurbineClusterModelChain example (Python script) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/turbine_cluster_modelchain_example.py>`_
+ * `TurbineClusterModelChain example (Jupyter notebook) <https://raw.githubusercontent.com/wind-python/windpowerlib/master/example/turbine_cluster_modelchain_example.ipynb>`_
 
 Contributing
 ==============

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
 ~~~~~~~~~~~~~~~~~
 
@@ -54,11 +56,10 @@ To run the examples you first have to install the windpowerlib. To run the noteb
 This will open a browser window. Navigate to the directory containing the notebook to open it. See the jupyter notebook quick start guide for more information on `how to install <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/install.html>`_ and
 `how to run <http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html>`_ jupyter notebooks.
 
-Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in a second example. As the ModelChain example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
+Further functionalities, like the modelling of wind farms and wind turbine clusters, are shown in the TurbineClusterModelChain example. As the ModelChain example it is available as jupyter notebook and as python script. The weather data in this example is the same as in the example above.
 
  * :download:`TurbineClusterModelChain example (Python script) <../example/turbine_cluster_modelchain_example.py>`
  * :download:`TurbineClusterModelChain example (Jupyter notebook) <../example/turbine_cluster_modelchain_example.ipynb>`
- * :download:`Example data file <../example/weather.csv>`
 
 You can also look at the examples in the :ref:`examples_section_label` section.
 

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/modules.rst

@@ -68,8 +68,10 @@ power curve or power coefficient curve needed by the :py:class:`~.wind_turbine.W
    :toctree: temp/
 
    wind_turbine.WindTurbine.fetch_turbine_data
+   wind_turbine.get_turbine_data_from_file
+   wind_turbine.get_turbine_data_from_oedb
+   wind_turbine.load_turbine_data_from_oedb
    wind_turbine.get_turbine_types
-   wind_turbine.read_turbine_data
 
 .. _wind_farm_label:
 
@@ -196,6 +198,7 @@ Methods of the TurbineClusterModelChain object.
 .. autosummary::
    :toctree: temp/
 
+   turbine_cluster_modelchain.TurbineClusterModelChain.assign_power_curve
    turbine_cluster_modelchain.TurbineClusterModelChain.temperature_hub
    turbine_cluster_modelchain.TurbineClusterModelChain.density_hub
    turbine_cluster_modelchain.TurbineClusterModelChain.wind_speed_hub

doc/requirements.txt

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

doc/whatsnew/v0-1-0.txt

@@ -1,23 +1,28 @@
-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) <https://openenergy-platform.org/dataedit/>`_
+instead of in csv files (v0.6.0 and lower) due to legal reasons.
+Use :py:func:`~windpowerlib.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
 ###########
 
- * WindFarm class for modelling a wind farm. Defines a standard set of wind farm attributes, for example aggregated power curve and wind farm efficiency to take wake losses into account.
- * WindTurbineCluster class for modelling a turbine cluster that contains several wind turbines and/or wind farms. This class is useful for gathering all wind turbines in a weather data grid cell. An aggregated power curve can be calculated which considers the wake losses of the wind farms by a set efficiency if desired.
- * TurbineClusterModelChain class shows the usage of new functions and classes of windpowerlib v.0.1 and is based on the ModelChain class.
+ * :class:`~windpowerlib.wind_farm.WindFarm` class for modelling a wind farm. Defines a standard set of wind farm attributes, for example aggregated power curve and wind farm efficiency to take wake losses into account.
+ * :class:`~windpowerlib.wind_turbine_cluster.WindTurbineCluster` class for modelling a turbine cluster that contains several wind turbines and/or wind farms. This class is useful for gathering all wind turbines in a weather data grid cell. An aggregated power curve can be calculated which considers the wake losses of the wind farms by a set efficiency if desired.
+ * :class:`~windpowerlib.turbine_cluster_modelchain.TurbineClusterModelChain` class shows the usage of new functions and classes of windpowerlib v.0.1 and is based on the ModelChain class.
 
 New functions
 #############
 
- * power curve smoothing for taking into account the spatial distribution of wind speed
- * application of wake losses to a power curve
- * application of wake losses to a wind speed time series by using wind efficiency curves which are provided in the data directory
- * logarithmic interpolation/extrapolation for wind speed time series
- * gauss distribution
- * estimation of turbulence intensity by roughness length
- * retrieve power curves from Open Energy Database
+ * :py:func:`~windpowerlib.power_curves.smooth_power_curve` for taking into account the spatial distribution of wind speed
+ * :py:func:`~windpowerlib.power_curves.wake_losses_to_power_curve`: application of wake losses to a power curve
+ * :py:func:`~windpowerlib.wake_losses.reduce_wind_speed`: application of wake losses to a wind speed time series by using wind efficiency curves which are provided in the data directory
+ * :py:func:`~windpowerlib.tools.logarithmic_interpolation_extrapolation` for wind speed time series
+ * :py:func:`~windpowerlib.tools.gauss_distribution` needed for power curve smoothing
+ * :py:func:`~windpowerlib.tools.estimate_turbulence_intensity` by roughness length
+ * :py:func:`~windpowerlib.wind_turbine.get_turbine_data_from_oedb` for retrieving power curves from `OpenEnergy Database <https://openenergy-platform.org/dataedit/>`_
 
 
 Testing
@@ -36,10 +41,10 @@ Documentation
 API changes
 ###########
 
- * renamed attribute 'turbine_name' of WindTurbine object to 'name' to match with 'name' attribute of WindFarm and WindTurbineCluster
+ * 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 `run_basic_example()` to `run_example()`
+ * 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,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)"
@@ -523,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()"
    ]