Merge pull request #14 from GeoStat-Framework/develop

Release v1.1.1

.github/workflows/main.yml

@@ -0,0 +1,123 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - "master"
+      - "develop"
+    tags:
+      - "*"
+  pull_request:
+    branches:
+      - "develop"
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  # needed by coveralls
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  CIBW_BUILD: "cp35-* cp36-* cp37-* cp38-* cp39-*"
+  CIBW_BEFORE_BUILD: "pip install numpy==1.17.3 cython>=0.29.14 setuptools"
+  CIBW_TEST_REQUIRES: "pytest"
+  CIBW_TEST_COMMAND: "pytest -v {project}/tests"
+
+jobs:
+  build_wheels:
+    name: wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+
+      - name: Set up Python
+        uses: actions\setup-python@v2
+        with:
+          python-version: "3.8"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install cibuildwheel==1.7.0
+      - name: Build wheels
+        run: |
+          python -m cibuildwheel --output-dir dist
+
+      - uses: actions/upload-artifact@v2
+        with:
+          path: ./dist/*.whl
+
+  build_sdist:
+    name: sdist on ${{ matrix.os }} with py ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions\setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_setup.txt
+          pip install -r requirements.txt
+          pip install -r requirements_test.txt
+          pip install coveralls>=3.0.0
+
+      - name: Build sdist
+        run: |
+          python setup.py sdist -d dist
+          python setup.py build_ext --inplace
+
+      - name: Run tests
+        run: |
+          python -m pytest --cov pentapy --cov-report term-missing -v tests/
+          python -m coveralls --service=github
+
+      - uses: actions/upload-artifact@v2
+        # if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.9'
+        with:
+          path: dist/*.tar.gz
+
+  upload_to_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifact
+          path: dist
+
+      - name: Publish to Test PyPI
+        # only if working on develop
+        if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop'
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.test_pypi_password }}
+          repository_url: https://test.pypi.org/legacy/
+          skip_existing: true
+
+      - name: Publish to PyPI
+        # only if tagged
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_password }}

CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to **pentapy** will be documented in this file.
 
 
+## [1.1.1] - 2021-02
+
+### Enhancements
+- Python 3.9 support
+
+### Changes
+- GitHub Actions for CI
+
+
 ## [1.1.0] - 2020-03-22
 
 ### Enhancements
@@ -47,6 +56,7 @@ This is the first release of pentapy, a python toolbox for solving pentadiagonal
 The solver is implemented in cython, which makes it really fast.
 
 
+[1.1.1]: https://github.com/GeoStat-Framework/gstools/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/GeoStat-Framework/gstools/compare/v1.0.3...v1.1.0
 [1.0.3]: https://github.com/GeoStat-Framework/gstools/compare/v1.0.0...v1.0.3
 [1.0.0]: https://github.com/GeoStat-Framework/gstools/compare/v0.1.1...v1.0.0

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Sebastian Mueller
+Copyright (c) 2021 Sebastian Mueller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -3,11 +3,15 @@
 [![status](https://joss.theoj.org/papers/57c3bbdd7b7f3068dd1e669ccbcf107c/status.svg)](https://joss.theoj.org/papers/57c3bbdd7b7f3068dd1e669ccbcf107c)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2587158.svg)](https://doi.org/10.5281/zenodo.2587158)
 [![PyPI version](https://badge.fury.io/py/pentapy.svg)](https://badge.fury.io/py/pentapy)
-[![Build Status](https://travis-ci.com/GeoStat-Framework/pentapy.svg?branch=master)](https://travis-ci.com/GeoStat-Framework/pentapy)
-[![Coverage Status](https://coveralls.io/repos/github/GeoStat-Framework/pentapy/badge.svg?branch=master)](https://coveralls.io/github/GeoStat-Framework/pentapy?branch=master)
-[![Documentation Status](https://readthedocs.org/projects/pentapy/badge/?version=stable)](https://geostat-framework.readthedocs.io/projects/pentapy/en/stable/?badge=stable)
+[![Build Status](https://github.com/GeoStat-Framework/pentapy/workflows/Continuous%20Integration/badge.svg?branch=develop)](https://github.com/GeoStat-Framework/pentapy/actions)
+[![Coverage Status](https://coveralls.io/repos/github/GeoStat-Framework/pentapy/badge.svg?branch=develop)](https://coveralls.io/github/GeoStat-Framework/pentapy?branch=develop)
+[![Documentation Status](https://readthedocs.org/projects/pentapy/badge/?version=latest)](https://geostat-framework.readthedocs.io/projects/pentapy/en/latest/?badge=latest)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
+<p align="center">
+<img src="https://github.com/GeoStat-Framework/GeoStat-Framework.github.io/raw/master/docs/source/pics/pentapy.png" alt="pentapy-LOGO" width="251px"/>
+</p>
+
 
 ## Purpose
 
@@ -57,7 +61,7 @@ presented by [Askar et al. 2015][ref_link].
 
 ## Documentation and Examples
 
-You can find the documentation under [geostat-framework.readthedocs.io][doc_link].
+You can find the documentation under [https://pentapy.readthedocs.org][doc_link].
 
 ### Solving a pentadiagonal linear equation system
 
@@ -123,7 +127,7 @@ You can contact us via <[email protected]>.
 
 ## License
 
-[MIT][licence_link] © 2019 - 2020
+[MIT][licence_link] © 2019 - 2021
 
 [ref_link]: http://dx.doi.org/10.1155/2015/232456
 [pip_link]: https://pypi.org/project/pentapy

docs/source/conf.py

@@ -172,12 +172,14 @@ def setup(app):
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "pentapydoc"
-
+# logos for the page
+html_logo = "pics/pentapy_150.png"
+html_favicon = "pics/pentapy.ico"
 
 # -- Options for LaTeX output ---------------------------------------------
 # latex_engine = 'lualatex'
 # logo to big
-# latex_logo = "pics/gstools_150.png"
+latex_logo = "pics/pentapy_150.png"
 
 # latex_show_urls = 'footnote'
 # http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output

docs/source/index.rst

@@ -2,6 +2,11 @@
 pentapy Quickstart
 ==================
 
+.. image:: /pics/pentapy.png
+   :width: 150px
+   :align: center
+
+
 pentapy is a toolbox to deal with pentadiagonal matrices in Python and solve
 the corresponding linear equation systems.