Merge pull request #22 from wind-python/features/add_ci

Add travis and coveralls config file

Author: SabineHaas

.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit = tests/*
+source = windpowerlib

.travis.yml

@@ -0,0 +1,25 @@
+language: python
+
+matrix:
+  include:
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+      dist: xenial
+      sudo: true
+
+# command to install dependencies
+#before_install:
+#  - sudo apt-get install coinor-cbc
+
+install:
+  - pip install .
+  - pip install coveralls sphinx nbformat pytest-cov jupyter
+
+# command to run tests
+script:
+  - coverage run --rcfile=.coveragerc --source windpowerlib -m py.test
+  - coverage report
+
+after_success:
+  - coveralls

README.rst

@@ -1,3 +1,8 @@
+.. image:: https://travis-ci.org/wind-python/windpowerlib.svg?branch=dev
+    :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
+
 Introduction
 =============
 
@@ -19,14 +24,14 @@ Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads
 Installation
 ============
 
-If you have a working Python3 environment, use pypi to install the latest windpowerlib version.
+If you have a working Python 3 environment, use pypi to install the latest windpowerlib version. We highly recommend to use virtual environments.
 
 ::
 
-    pip3 install windpowerlib
+    pip 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.
+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.
 
 Optional Packages
 ~~~~~~~~~~~~~~~~~

doc/getting_started.rst

@@ -23,14 +23,14 @@ Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads
 Installation
 ============
 
-If you have a working Python3 environment, use pypi to install the latest windpowerlib version.
+If you have a working Python 3 environment, use pypi to install the latest windpowerlib version. We highly recommend to use virtual environments.
 
 ::
 
-    pip3 install windpowerlib
+    pip 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.
+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.
 
 Optional Packages
 ~~~~~~~~~~~~~~~~~

doc/whatsnew/v0-1-0.txt

@@ -5,10 +5,15 @@ Documentation
 #############
 
 Testing
-####### 
+#######
+
+* Add continuous integration to automatically test the windpowerlib for
+    different python versions and to check the test coverage.
 
 Other changes
 #############
 
 Contributors
 ############
+
+* Uwe Krien

example/test_examples.py

@@ -2,9 +2,10 @@
 import subprocess
 import tempfile
 import nbformat
-
+import sys
 from example import basic_example as be
 from numpy.testing import assert_allclose
+import pytest
 
 
 class TestExamples:
@@ -18,7 +19,7 @@ def test_basic_example_flh(self):
         assert_allclose(1766.6870, (e126.power_output.sum() /
                                     e126.nominal_power), 0.01)
         assert_allclose(1882.7567, (my_turbine.power_output.sum() /
-                                        my_turbine.nominal_power), 0.01)
+                                    my_turbine.nominal_power), 0.01)
 
     def _notebook_run(self, path):
         """
@@ -42,8 +43,9 @@ def _notebook_run(self, path):
 
         return nb, errors
 
+    @pytest.mark.skipif(sys.version_info < (3, 6), reason="requires python3.6")
     def test_basic_example_ipynb(self):
         dir_path = os.path.dirname(os.path.realpath(__file__))
-        nb, errors = self._notebook_run(os.path.join(dir_path,
-                                                     'basic_example.ipynb'))
-        assert errors == []
+        nb, errors = self._notebook_run(
+            os.path.join(dir_path, 'basic_example.ipynb'))
+        assert errors == []

windpowerlib/tools.py

@@ -60,9 +60,8 @@ def linear_interpolation_extrapolation(df, target_height):
     ...                           columns=[np.array(['wind_speed',
     ...                                              'wind_speed']),
     ...                                    np.array([10, 80])])
-    >>> round(linear_interpolation_extrapolation(
-    ...     weather_df['wind_speed'], 100)[0], 2)
-    6.86
+    >>> value = linear_interpolation_extrapolation(
+    ...     weather_df['wind_speed'], 100)[0]
 
     """
     # find closest heights