OMXMerge branch 'dev' into features/tools

Author: SabineHaas

.gitignore

@@ -91,3 +91,6 @@ ENV/
 
 # Rope project settings
 .ropeproject
+
+# tests
+.pytest_cache

README.rst

@@ -1,36 +1,19 @@
-windpowerlib
-==============
-
-The windpowerlib is designed to calculate feedin time series of wind power plants. The windpowerlib is an out-take from the 
-`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) to build up a community concentrating on wind power models.
-
-.. contents:: `Table of contents`
-    :depth: 1
-    :local:
-    :backlinks: top
-
 Introduction
-============
+=============
 
-Having weather data sets you can use the windpowerlib to calculate the electrical output of common wind turbines. 
-Basic parameters for many manufacturers are provided with the library so that you can start directly using one of these parameter sets. Of course you are free to add your own parameter set.
-For a quick start download the example weather data and basic example file and execute it:
+The windpowerlib is a library that provides a set of functions and classes to calculate the power output of wind turbines. It was originally part of the 
+`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
 
-https://github.com/wind-python/windpowerlib/tree/master/example
+For a quick start see the `Examples and basic usage <http://windpowerlib.readthedocs.io/en/latest/getting_started.html#examplereference-label>`_ section.
 
-Documentation
-==============
 
-Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org/en/latest/>`_. Use the project site of readthedocs to choose the version of the documentation. 
-
-Contributing
+Documentation
 ==============
 
-Clone/Fork: https://github.com/wind-python/windpowerlib
+Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org>`_.
 
-If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
-As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same 
-`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
+Use the `project site <http://readthedocs.org/projects/windpowerlib>`_ of readthedocs to choose the version of the documentation. 
+Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads/>`_ to download different versions and formats (pdf, html, epub) of the documentation.
 
 
 Installation
@@ -40,18 +23,63 @@ If you have a working Python3 environment, use pypi to install the latest windpo
 
 ::
 
-    pip install windpowerlib
+    pip3 install windpowerlib
 
-So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7 
-and for newer versions. 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 on your operating system.
+So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7. 
+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 on your operating system.
 
-  
 Optional Packages
 ~~~~~~~~~~~~~~~~~
 
-To see the plots of the example file you should install the matplotlib package.
+To see the plots of the windpowerlib example in the `Examples and basic usage <http://windpowerlib.readthedocs.io/en/latest/getting_started.html#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.
+
+
+.. _examplereference-label:
+
+Examples and basic usage
+=========================
+
+The basic usage of the windpowerlib is shown `here <http://windpowerlib.readthedocs.io/en/latest/basic_example_notebook.html>`_. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
+
+ * `Python script <https://raw.githubusercontent.com/wind-python/windpowerlib/dev/example/basic_example.py>`_
+ * `Jupyter notebook <https://raw.githubusercontent.com/wind-python/windpowerlib/features/revise_example/example/basic_example.ipynb>`_
+ * `Example data file <https://raw.githubusercontent.com/wind-python/windpowerlib/dev/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.
+
+
+Contributing
+==============
+
+Clone/Fork: https://github.com/wind-python/windpowerlib
+
+If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
+As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same 
+`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
+
+Citing the windpowerlib
+========================
+
+We use the zenodo project to get a DOI for each version. `Search zenodo for the right citation of your windpowerlib version <https://zenodo.org/search?page=1&size=20&q=windpowerlib>`_.
+
+License
+============
+
+Copyright (C) 2017 oemof developing group
 
-Matplotlib can be installed using pip3 but some Linux users reported that it is easier and more stable to use the pre-built packages of your Linux distribution.
+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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-http://matplotlib.org/users/installing.html
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see http://www.gnu.org/licenses/.

VERSION

@@ -0,0 +1 @@
+../example/basic_example.ipynb

doc/basic_example_notebook.ipynb

@@ -38,7 +38,8 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.imgmath',
     'sphinx.ext.napoleon',
-    'sphinx.ext.autosummary'
+    'sphinx.ext.autosummary',
+    'nbsphinx'
 
 ]
 
@@ -60,7 +61,7 @@
 # General information about the project.
 project = u'windpowerlib'
 copyright = u'2016, oemof developer group'
-author = u'Uwe Krien, oemof developing group'
+author = u'oemof developing group'
 
 import windpowerlib
 
@@ -284,7 +285,7 @@
 
 # Bibliographic Dublin Core info.
 epub_title = u'windpowerlib'
-epub_author = u'Uwe Krien, oemof developing group'
+epub_author = u'oemof developing group'
 epub_publisher = u'oemof developing group'
 epub_copyright = u'2016, oemof developing group'
 

doc/conf.py

@@ -0,0 +1,10 @@
+.. currentmodule:: example
+
+.. autosummary::
+   :toctree: temp/
+
+   basic_example.get_weather_data
+   basic_example.initialise_wind_turbines
+   basic_example.calculate_power_output
+   basic_example.plot_or_print
+   basic_example.run_basic_example

doc/example.rst

@@ -2,4 +2,87 @@
 Getting started
 ~~~~~~~~~~~~~~~~~~~~~~
 
-.. include:: ../README.rst
+Introduction
+=============
+
+The windpowerlib is a library that provides a set of functions and classes to calculate the power output of wind turbines. It was originally part of the 
+`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
+
+For a quick start see the :ref:`examplereference-label` section.
+
+
+Documentation
+==============
+
+Full documentation can be found at `readthedocs <http://windpowerlib.readthedocs.org>`_.
+
+Use the `project site <http://readthedocs.org/projects/windpowerlib>`_ of readthedocs to choose the version of the documentation. 
+Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads/>`_ to download different versions and formats (pdf, html, epub) of the documentation.
+
+
+Installation
+============
+
+If you have a working Python3 environment, use pypi to install the latest windpowerlib version.
+
+::
+
+    pip3 install windpowerlib
+
+So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7. 
+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 on your operating system.
+
+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.
+
+
+.. _examplereference-label:
+
+Examples and basic usage
+=========================
+
+The basic usage of the windpowerlib is shown :ref:`here <basic_example_notebook.ipynb>`. The presented example is available as jupyter notebook and python script. You can download them along with example weather data:
+
+ * :download:`Python script <../example/basic_example.py>`
+ * :download:`Jupyter notebook <../example/basic_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.
+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.
+
+
+Contributing
+==============
+
+Clone/Fork: https://github.com/wind-python/windpowerlib
+
+If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
+As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same 
+`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
+
+Citing the windpowerlib
+========================
+
+We use the zenodo project to get a DOI for each version. `Search zenodo for the right citation of your windpowerlib version <https://zenodo.org/search?page=1&size=20&q=windpowerlib>`_.
+
+License
+============
+
+Copyright (C) 2017 oemof developing 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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see http://www.gnu.org/licenses/.

doc/example_documentation.rst

@@ -8,8 +8,9 @@ Contents:
    :glob:   
 
    getting_started
+   basic_example_notebook
    whats_new
-   modules.rst
+   modules
 
 
 Indices and tables