Draft: Create v0.4

.gitattributes

@@ -1 +1,2 @@
 heron/_version.py export-subst
+*.ipynb filter=jupyternotebook

.github/workflows/documentation.yaml

@@ -0,0 +1,37 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - master
+      - v*-preview
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Build HTML Docs
+      run: |
+        sudo apt install pandoc
+        pip install sphinx sphinx-multiversion
+        pip install kentigern
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+        pip install .
+        cd docs
+        make html
+
+    - name: SCP Deploy HTML Docs
+      uses: horochx/[email protected]
+      with:
+        local: docs/_build/html/*
+        remote: /home/danwilliams/code.daniel-williams.co.uk/heron/${{ github.ref_name }}
+        host: ${{ secrets.sshhost }}
+        user: ${{ secrets.sshuser }}
+        key: ${{ secrets.sshkey }}

.github/workflows/review.yml

@@ -0,0 +1,29 @@
+name: Tests
+on:
+  push:
+    branches:
+      - master
+      - v*-preview
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+        pip install -r requirements_test.txt
+
+    - name: Run Tests
+      run: |
+        python -m unittest discover tests/

.gitlab-ci.yml

@@ -1,14 +1,22 @@
 stages:
   - analysis
   - test
+  - science tests
   - build
   - deploy
 
-image: python:3.6
+image: python:3.9
 
 include:
   - template: Dependency-Scanning.gitlab-ci.yml
 
+documentation-coverage:
+  stage: analysis
+  allow_failure: true
+  script:
+   - pip install docstr-coverage
+   - docstr-coverage -F 60.0 heron
+  coverage: '/Total coverage: (\d+\.\d+%)/'
 
 pylint:
   stage: analysis
@@ -22,47 +30,83 @@ flake8:
   stage: analysis
   allow_failure: false
   before_script:
-    - pip install flake8
+    - pip install flake8 flake8_formatter_junit_xml
   script:
-    - flake8  --count --select=E9,F63,F7,F82 --show-source --statistics heron/
+    - flake8  --count --select=E9,F63,F7,F82 --format junit-xml --verbose heron > report.xml
     # exit-zero treats all errors as warnings.
-    - flake8  --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics heron/
-
-test-python27:
+    - flake8  --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics  heron/
+  artifacts:  
+    reports:
+      junit: report.xml
+
+test-python38:
   stage: test
-  image: python:2.7
-  allow_failure: true
+  image: python:3.8
   script:
     - pip install numpy
     - pip install -r requirements.txt
+    - pip install -r requirements_test.txt
     - python setup.py test
 
-test-python36:
+test-python39:
   stage: test
-  image: python:3.6
+  image: python:3.9
+  before_script:
+    - pip install coverage unittest-xml-reporting
   script:
     - pip install numpy
     - pip install -r requirements.txt
-    - python setup.py test
+    - pip install -r requirements_test.txt
+    - coverage run -m xmlrunner discover tests/ -o junit-reports
+    #- coverage report
+    #- coverage xml
+  # artifacts:
+  #   when: always
+  #   paths:
+  #     - public/coverage.txt
+  #   reports:
+  #     junit: junit-reports/*
+  #     coverage_report:
+  #       coverage_format: cobertura
+  #       path: coverage.xml
+  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+%)/'
 
-test-python37:
+
+test-python310:
   stage: test
-  image: python:3.7
+  image: python:3.10
   script:
     - pip install numpy
     - pip install -r requirements.txt
+    - pip install -r requirements_test.txt
     - python setup.py test
 
-test-python38:
+test-python311:
   stage: test
-  image: python:3.8
+  image: python:3.11
   script:
     - pip install numpy
     - pip install -r requirements.txt
+    - pip install -r requirements_test.txt
     - python setup.py test
+  allow_failure: True
+
+####
+# Science Tests
+####
+
+science-python39:
+  stage: science tests
+  image: python:3.9
+  script:
+    - pip install numpy
+    - pip install -r requirements.txt
+    - pip install -r requirements_test.txt
+    - python -m unittest discover science-tests/
+  allow_failure: True
 
 pages:
-  image: python:3.6
+  image: sphinxdoc/sphinx
   stage: build
   script:
   - pip install numpy
@@ -76,53 +120,3 @@ pages:
     - public
   only:
   - master
-# Build receipe for standalone wheels on Linux
-wheel-27:
-  image: python:2.7
-  stage: build
-  script:
-    - pip install wheel
-    # Build wheel
-    - python setup.py bdist_wheel --universal
-  dependencies: []
-  artifacts:
-    expire_in: 3h
-    paths:
-      - dist
-
-wheel-36:
-  image: python:3.6
-  stage: build
-  script:
-    - pip install wheel
-    # Build wheel
-    - python setup.py bdist_wheel --universal
-  dependencies: []
-  artifacts:
-    expire_in: 3h
-    paths:
-      - dist
-
-wheel-37:
-  image: python:3.7
-  stage: build
-  script:
-    - pip install wheel
-    # Build wheel
-    - python setup.py bdist_wheel --universal
-  dependencies: []
-  artifacts:
-    expire_in: 3h
-    paths:
-      - dist
-
-deploy:wheel:
-  stage: deploy
-  script:
-    - pip install twine
-    - twine upload dist/*
-  rules:
-    - if: '$CI_COMMIT_BRANCH == "master"'
-      if: '$CI_COMMIT_TAG'
-      when: on_success
-    - when: never

Makefile

@@ -65,7 +65,7 @@ docs:
 	rm -f docs/modules.rst
 	sphinx-apidoc -o docs/ heron
 	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
+	$(MAKE) -C docs multihtml
 	$(BROWSER) docs/_build/html/index.html
 
 servedocs: docs

README.rst

@@ -1,4 +1,3 @@
-=====
 Heron
 =====