Merge branch 'release/v0.0.2'

.gitignore

@@ -59,9 +59,5 @@ target/
 # IDE
 .idea
 
-# data from Franzi
-CSP_data/
-CSP_results/
-
 # results
-examples/flat_plate_collector/results/
+examples/**/results

.travis.yml

@@ -18,12 +18,14 @@ matrix:
 install:
   - pip install -r tests/test_requirements.txt
   - pip install -e .
+  - pip install pytest-cov
+  - pip install coveralls
 
 # commands to run tests 
 script:
   - flake8
   - pylint */*.py
-  - pytest
+  - pytest --cov=src/oemof/thermal tests/
 #jobs:
 #  include:
 #    - stage: "Tests"                # naming the Tests stage
@@ -48,3 +50,6 @@ script:
 #  only:
 #  - branch_name1
 #  - branch_name2
+
+after_success:
+  - coveralls

README.rst

@@ -1,3 +1,5 @@
+|badge_pypi| |badge_travis| |badge_docs| |badge_coverage| |link-latest-doi|
+
 #############
 oemof.thermal
 #############
@@ -74,3 +76,24 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+
+.. |badge_pypi| image:: https://badge.fury.io/py/oemof.thermal.svg
+    :target: https://badge.fury.io/py/oemof.thermal
+    :alt: PyPI version
+
+.. |badge_docs| image:: https://readthedocs.org/projects/oemof-thermal/badge/?version=stable
+    :target: https://oemof-thermal.readthedocs.io/en/stable/
+    :alt: Documentation status
+
+.. |badge_coverage| image:: https://coveralls.io/repos/github/oemof/oemof-thermal/badge.svg?branch=dev&service=github
+    :target: https://coveralls.io/github/oemof/oemof-thermal?branch=dev
+    :alt: Test coverage
+
+.. |badge_travis| image:: https://travis-ci.org/oemof/oemof.svg?branch=dev
+    :target: https://travis-ci.org/oemof/oemof-thermal
+    :alt: Build status
+
+.. |link-latest-doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3606385.svg
+    :target: https://doi.org/10.5281/zenodo.3606385
+    :alt: Zenodo DOI

VERSION

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.0.2"

docs/_pics/README.rst

@@ -0,0 +1,12 @@
+Handling figures and images
+----------------------------
+
+Requirements towards formats of images have to be met with regard to chosen download:
+
+- **pdf**: png, jpeg, pdf
+- **html**: please check your browser compatibility
+- **epub**: png, jpeg, gif, svg
+
+In order to match the compatibility of every download source, png should be preferred. Please ensure a resolution of 300 - 600 dpi as a guide value.
+
+If your original image is a vector graphics (e.g. svg), it is advised to upload the original file to keep it possible to make adaptions at a later point in time.