Merge pull request #258 from lettlini/notebook_workflow

Actions for Generating and Checking Jupyter Notebooks

.github/workflows/check_notebooks.yml

@@ -0,0 +1,34 @@
+name: Jupyter Notebooks CI
+on: [push, pull_request]
+jobs:
+  Check-Notebooks:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - name: check out repository code
+        uses: actions/checkout@v3
+      - name: set up conda environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          auto-activate-base: false
+          activate-environment: notebook-env
+      - name: Install tobac dependencies
+        run: |
+          conda install -c conda-forge --yes ffmpeg gcc jupyter pytables
+          conda install -c conda-forge --yes --file requirements.txt
+      - name: Install tobac
+        run: |
+          pip install .
+      - name: Find all notebook files
+        run: |
+          find . -type f -name '*.ipynb' > nbfiles.txt
+          cat nbfiles.txt
+      - name: Execute all notebook files
+        run: |
+          while IFS= read -r nbpath; do
+            jupyter nbconvert --inplace --ClearMetadataPreprocessor.enabled=True --clear-output $nbpath
+            jupyter nbconvert --to notebook --inplace --execute $nbpath
+          done < nbfiles.txt

.github/workflows/generate_notebooks.yml

@@ -0,0 +1,48 @@
+name: Generate Jupyter Notebooks
+on:
+  pull_request:
+    types:
+      - closed
+  workflow_dispatch:
+jobs:
+  Generate-Notebooks:
+    if: (github.event.pull_request.merged == true) || (github.event_name == 'workflow_dispatch')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - name: check out repository code
+        uses: actions/checkout@v3
+      - name: set up conda environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          auto-activate-base: false
+          activate-environment: notebook-env
+      - name: Install tobac dependencies
+        run: |
+          conda install -c conda-forge --yes ffmpeg gcc jupyter pytables
+          conda install -c conda-forge --yes --file requirements.txt
+      - name: Install tobac
+        run: |
+          pip install .
+      - name: Find all notebook files
+        run: |
+          find . -type f -name '*.ipynb' > nbfiles.txt
+          cat nbfiles.txt
+      - name: Execute all notebook files
+        run: |
+          while IFS= read -r nbpath; do
+            jupyter nbconvert --inplace --ClearMetadataPreprocessor.enabled=True --clear-output $nbpath
+            jupyter nbconvert --to notebook --inplace --execute $nbpath
+          done < nbfiles.txt
+      - name: Commit changed notebooks
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          find . -type f -name "*.ipynb" -exec git add {} +
+          git commit -m "Generated Notebooks"
+          git push

README.md

@@ -1,11 +1,11 @@
 tobac - Tracking and Object-based Analysis of Clouds
 ======
-[![Documentation Status](https://readthedocs.org/projects/tobac/badge/?version=latest)](https://tobac.readthedocs.io/en/latest/?badge=latest)[![Download Counter](https://anaconda.org/conda-forge/tobac/badges/downloads.svg)](https://anaconda.org/conda-forge/tobac/)
+[![Release Version](https://img.shields.io/conda/vn/conda-forge/tobac.svg)](https://anaconda.org/conda-forge/tobac)[![Download Counter](https://img.shields.io/conda/dn/conda-forge/tobac.svg)](https://anaconda.org/conda-forge/tobac)[![Documentation Status](https://readthedocs.org/projects/tobac/badge/?version=latest)](https://tobac.readthedocs.io/en/latest/?badge=latest)
 
 What is it?
 -----------
 
-*tobac* is a Python package for identifiying, tracking and analysing of clouds and other meteorological phenomena in different types of gridded datasets. *tobac* is unique in its ability to track phenomena using **any** variable on **any** grid, including radar data, satellite observations, and numerical model output. *tobac* has been used in a variety of peer-reviewed [publications](https://tobac.readthedocs.io/en/rc_v1.4.0/publications.html) and is an international, multi-institutional collaboration. 
+*tobac* is a Python package for identifiying, tracking and analysing of clouds and other meteorological phenomena in different types of gridded datasets. *tobac* is unique in its ability to track phenomena using **any** variable on **any** grid, including radar data, satellite observations, and numerical model output. *tobac* has been used in a variety of peer-reviewed [publications](https://tobac.readthedocs.io/en/latest/publications.html) and is an international, multi-institutional collaboration. 
 
 Documentation
 -------------