reviewed github actions

.github/actions/dynamic_matrix.py

@@ -0,0 +1,48 @@
+import sys
+import urllib.request
+import json
+import datetime
+# minimal python script that returns a strategy matrix, for given github.event_name
+
+
+with urllib.request.urlopen('https://endoflife.date/api/python.json') as f:
+    python_versions = json.loads(f.read().decode('utf-8'))
+
+now = datetime.datetime.now().strftime('%Y-%m-%d')
+python_supported_versions = [ v['cycle'] for v in python_versions if v['eol'] > now and v['cycle'] != '3.7' ]
+
+python_default_version = python_supported_versions[1]
+
+matrix = {
+    'default': {
+        'os': ['ubuntu-latest'],
+        'python_version': [python_default_version],
+    },
+    'pull_request': {
+        'os': ['ubuntu-latest'],
+        'python_version': [python_default_version],
+    },
+    'schedule': {
+        'os': ['ubuntu-latest', 'macos-latest', 'windows-latest'],
+        'python_version': python_supported_versions,
+    },
+    'release': {
+        'os': ['ubuntu-latest', 'macos-latest', 'windows-latest'],
+        'python_version': python_supported_versions,
+    },
+    'pull_request_review': {
+        'os': ['ubuntu-latest', 'macos-latest', 'windows-latest'],
+        'python_version': python_supported_versions,
+    }
+}
+
+if __name__ == "__main__":
+    try:
+        event = sys.argv[1]
+    except IndexError:
+        event = 'default'
+    if event not in matrix:
+        event = 'default'
+
+    print('::set-output name=os_matrix::%s' % str(matrix[event]['os']))
+    print('::set-output name=python_version_matrix::%s' % str(matrix[event]['python_version']))

.github/workflows/install-test.yml

@@ -0,0 +1,120 @@
+name: Install test
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+  schedule:
+    - cron: '25 16 * * 0'
+  release:
+    types:
+      - published
+  pull_request_review:
+    types:
+      - submitted
+
+env:
+  CACHE_NUMBER: 0  # increase to reset cache manually
+
+jobs:
+  dynamic-matrix:
+# from https://michaelheap.com/dynamic-matrix-generation-github-actions/
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - id: get-matrix
+        run: |
+          echo "get matrix for event ${{ github.event_name }}"
+          echo "::echo::on"
+          python .github/actions/dynamic_matrix.py ${{ github.event_name }}
+    outputs:
+      os_matrix: ${{ steps.get-matrix.outputs.os_matrix }}
+      python_version_matrix: ${{ steps.get-matrix.outputs.python_version_matrix }}
+
+  build:
+    needs: dynamic-matrix
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ${{ fromJson(needs.dynamic-matrix.outputs.os_matrix) }}
+        python-version: ${{ fromJson(needs.dynamic-matrix.outputs.python_version_matrix) }}
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -l {0}
+    name: python ${{ matrix.python-version }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+
+      # cache conda from https://dev.to/epassaro/caching-anaconda-environments-in-github-actions-5hde
+      # and https://github.com/conda-incubator/setup-miniconda#caching
+      - name: Setup Mambaforge
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          activate-environment: xsar
+          python-version: ${{ matrix.python-version }}
+          condarc-file: condarc.yml
+          use-mamba: true
+          use-only-tar-bz2: true
+
+      - name: Set cache date
+        run: |
+          echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/conda_pkgs_dir
+          key: conda-cache-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('environment.yml') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
+        id: cache
+
+      - name: Cache found
+        run: echo Cache found
+        if: steps.cache.outputs.cache-hit == 'true'
+
+      # update conda. Cache will be used if available
+      # we remove python from environment.yml, because we want the version from  matrix.python-version
+      - name: update conda
+        run: |
+          cat environment.yml | egrep -vw 'python' > ~/environment-nopython.yml
+          mamba env update -n xsar -f ~/environment-nopython.yml 
+
+      - name: List Packages
+        run: |
+          python -V
+          conda info
+          conda list
+
+      - name: Minimal install
+        run: pip install -e .
+
+      - name: Minimal pytest
+        run: |
+          pip install pytest dill
+          pytest
+
+      # check if docs has changed
+      - uses: dorny/paths-filter@v2
+        id: changes
+        if: github.event_name != 'schedule'
+        with:
+          filters: |
+            docs:
+              - 'docs/**'
+          # run only if some file in 'doc' folder was changed
+      - name: Complete notebook install
+        if: github.event_name == 'schedule' || steps.changes.outputs.docs  == 'true'
+        run: pip install -r requirements.txt
+
+      - name: Documetation test
+        if: github.event_name == 'schedule' || steps.changes.outputs.docs  == 'true'
+        run: |
+          cd docs
+          make html
+
+
+

condarc.yml

@@ -0,0 +1,4 @@
+always_yes: true
+quiet: true
+
+

docs/Makefile

@@ -17,4 +17,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	pip install -r ../requirements_doc.txt
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/scripts/conda_install_minimal

@@ -1 +1 @@
-conda install -c conda-forge xsar 'rioxarray>=0.10' 'python<3.10'
+conda install -c conda-forge xsar

docs/scripts/conda_install_recommended

@@ -1 +1 @@
-conda install -c conda-forge xsar 'rioxarray>=0.10' jupyterlab geoviews cartopy_offlinedata holoviews datashader 'shapely<1.8.0' nbsphinx pandoc jq docutils pip git lxml 'python<3.10'
+conda install -c conda-forge xsar 'rioxarray>=0.10' jupyterlab geoviews cartopy_offlinedata holoviews datashader 'shapely<1.8.0' pandoc jq docutils pip git lxml python