Merge pull request #62 from wind-python/refactor_v0.2.0_branch

Refactor WindTurbine class

Author: birgits

.gitignore

@@ -98,8 +98,3 @@ ENV/
 
 # tests
 .pytest_cache
-
-# oedb data dump
-/windpowerlib/data/turbine_data_oedb.h5
-/windpowerlib/data/oedb_power_coefficient_curves.csv
-/windpowerlib/data/oedb_power_curves.csv

doc/getting_started.rst

@@ -32,31 +32,38 @@ 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
 ~~~~~~~~~~~~~~~~~
 
 To see the plots of the windpowerlib example in the :ref:`examplereference-label` section you should `install the matplotlib package <http://matplotlib.org/users/installing.html>`_.
-Matplotlib can be installed using pip3 though some Linux users reported that it is easier and more stable to use the pre-built packages of your Linux distribution.
+Matplotlib can be installed using pip3:
+
+::
 
+    pip install matplotlib
 
 .. _examplereference-label:
 
 Examples and basic usage
 =========================
 
-The basic usage of the windpowerlib is shown in the ModelChain example. 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 that is available as jupyter notebook and python script:
 
  * :download:`ModelChain example (Python script) <../example/modelchain_example.py>`
  * :download:`ModelChain example (Jupyter notebook) <../example/modelchain_example.ipynb>`
- * :download:`Example data file <../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.
+To run the example you need the example weather and turbine data used:
+
+ * :download:`Example weather data file <../example/weather.csv>`
+ * :download:`Example power curve data file <../example/data/example_power_curves.csv>`
+ * :download:`Example power coefficient curve data file <../example/data/example_power_coefficient_curves.csv>`
+ * :download:`Example nominal power data file <../example/data/example_turbine_data.csv>`
+
+Furthermore, you have to install the windpowerlib and to run the notebook you also need to install `notebook` using pip3. To launch jupyter notebook type ``jupyter notebook`` in the 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 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.
+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 and turbine 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>`
@@ -107,7 +114,7 @@ We use the zenodo project to get a DOI for each version. `Search zenodo for the
 License
 ============
 
-Copyright (C) 2017 oemof developing group
+Copyright (C) 2017 oemof developer group
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

doc/modules.rst

@@ -67,9 +67,8 @@ power curve or power coefficient curve needed by the :py:class:`~.wind_turbine.W
 .. autosummary::
    :toctree: temp/
 
-   wind_turbine.WindTurbine.fetch_turbine_data
    wind_turbine.get_turbine_data_from_file
-   wind_turbine.get_turbine_data_from_oedb
+   wind_turbine.get_oedb_turbine_data
    wind_turbine.load_turbine_data_from_oedb
    wind_turbine.get_turbine_types
 

doc/whatsnew/v0-2-0.txt

@@ -3,22 +3,37 @@ v0.2.0 ()
 
 New features
 ############
+* get_turbine_types() can now be used to get provided turbine types of oedb turbine_library as well as provided turbine types of local files
+
+Documentation
+#############
+
+
+Testing
+#######
+
 
 Bug fixes
 #########
 
+
 API changes
-###########
+#############
+* Removed unnecessary `wake_losses_model` parameter in :py:func:`~.power_curves.wake_losses_to_power_curve`. Whether a constant wind farm efficiency or a wind farm efficiency curve is used is decided by the type of the wind farm efficiency.
+* Combined options 'constant_efficiency' and 'power_efficiency_curve' of `wake_losses_model` parameter in :py:func:`~.turbine_cluster_modelchain.TurbineClusterModelChain` to 'wind_farm_efficiency'. Therefore, default value of `wake_losses_model` in :py:func:`~.wind_farm.WindFarm.assign_power_curve` and :py:func:`~.wind_turbine_cluster.WindTurbineCluster.assign_power_curve` changed to 'wind_farm_efficiency'.
+* Removed `overwrite` parameter from :py:func:`~.wind_turbine.get_turbine_data_from_oedb`
+* Removed `data_source` and `fetch_curve` parameters from :py:func:`~.wind_turbine.WindTurbine` and :py:func:`~.wind_turbine.WindTurbine.fetch_turbine_data`. Now the source and if a curve is fetched or not is specified by the parameters `power_curve`, `power_coefficient_curve` and `nominal_power`. See :py:func:`~.wind_turbine.WindTurbine.fetch_turbine_data` for a description.
 
 Other changes
 #############
+* Power curves and nominal power of wind turbines are now saved in file in W instead of kW.
+* Restructured csv reading for offline usage of windpowerlib. The nominal power of wind turbines is now saved to a separate file along with other turbine data from the oedb turbine library.
 
-Testing
-#######
 
 Deprecations
 ############
 
-
 Contributors
 ############
+* Sabine Haas
+

example/data/example_power_coefficient_curves.csv

@@ -0,0 +1,3 @@
+turbine_type,0,0.5,1,1.5,2,2.5,3,3.5,4,4.5,5,5.5,6,6.5,7,7.5,8,8.5,9,9.5,10,10.5,11,11.5,12,12.5,13,13.5,14,14.5,15,15.5,16,16.5,17,17.5,18,18.5,19,19.5,20,20.5,21,21.5,22,22.5,23,23.5,24,24.5,25,25.5,26
+DUMMY 1,0,,0,,0,,0,0,0.13,,0.38,,0.46,,0.48,,0.47,,0.44,,0.4,,0.36,,0.31,,0.26,,0.23,,0.2,,0.18,,0.14,,0.11,,0.1,,0.09,,0.07,,0.05,,0.04,,0.04,,0.03,,0
+DUMMY 2,0,,0,,0,,0.16,0.29,0.35,0.38,0.4,0.41,0.42,0.43,0.43,0.44,0.44,0.44,0.44,0.43,0.42,0.39,0.36,0.32,0.29,0.26,0.23,0.2,0.18,0.16,0.15,0.14,0.12,0.11,0.1,0.09,0.09,0.08,0.07,0.07,0.06,0.06,0.05,0.05,0.05,0.04,0.04,0.04,0.04,0.03,0.03,0,0

example/data/example_power_curves.csv

@@ -0,0 +1,3 @@
+turbine_type,0,0.5,1,1.5,2,2.5,3,3.5,4,4.5,5,5.5,6,6.5,7,7.5,8,8.5,9,9.5,10,10.5,11,11.5,12,12.5,13,13.5,14,14.5,15,15.5,16,16.5,17,17.5,18,18.5,19,19.5,20,20.5,21,21.5,22,22.5,23,23.5,24,24.5,25,25.5,26
+DUMMY 3,0,0,0,0,0,0,0,18000,34000,70000,10000,150000,190000,260000,330000,420000,510000,620000,740000,880000,1020000,1180000,1330000,1420000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,1500000,0,
+DUMMY 4,0,,0,,0,,0,,4000,,22000,,46000,,76000,,111000,,147000,,184000,,219000,,249000,,274000,,290000,,297000,,302000,,307000,,307000,,305000,,295000,,280000,,260000,,240000,,230000,,225000,0,

example/data/power_coefficient_curves.csv

@@ -0,0 +1,5 @@
+turbine_type,nominal_power
+DUMMY 1,4200000
+DUMMY 2,4200000
+DUMMY 3,1500000
+DUMMY 4,225000