Test notebooks with a separate CI workflow (#151)

* Move test-notebooks job to a new workflow

* Fix read_esri_ascii import

* Fix requested version

* Skip testing terrainbento and pymt notebooks

* Clean up list of ignored notebooks

Author: mdpiper

.github/workflows/test-notebooks.yml

@@ -0,0 +1,32 @@
+name: Test Notebooks
+
+on: [push, pull_request]
+
+jobs:
+
+  test-notebooks:
+
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+
+    name: Test the notebooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: "3.11"
+          miniforge-variant: Miniforge3
+          miniforge-version: latest
+          auto-update-conda: true
+
+      - name: Install nox
+        run: pip install nox
+
+      - name: Test
+        env:
+          MPLBACKEND: "Agg"
+          OPENTOPOGRAPHY_API_KEY: ${{ secrets.OPENTOPOGRAPHY_API_KEY }}
+        run: nox -s test-notebooks --python "3.11"

.github/workflows/test.yml

@@ -37,30 +37,3 @@ jobs:
 
       - name: Test
         run: nox -s test
-
-  test-notebooks:
-
-    if:
-      github.event_name == 'push' ||
-      github.event.pull_request.head.repo.full_name != github.repository
-
-    name: Test the notebooks
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: conda-incubator/setup-miniconda@v3
-        with:
-          python-version: "3.11"
-          miniforge-variant: Miniforge3
-          miniforge-version: latest
-          auto-update-conda: true
-
-      - name: Install nox
-        run: pip install nox
-
-      - name: Test
-        env:
-          MPLBACKEND: "Agg"
-          OPENTOPOGRAPHY_API_KEY: ${{ secrets.OPENTOPOGRAPHY_API_KEY }}
-        run: nox -s test-notebooks --python "3.11"

.pre-commit-config.yaml

@@ -70,7 +70,7 @@ repos:
     files: \.py$
 
 - repo: https://github.com/mcflugen/heartfelt-hooks
-  rev: v1.3.3
+  rev: v0.3.3
   hooks:
   - id: check-whitespace
   # - id: check-mixed-case

lessons/landlab/landlab/overland_flow.ipynb

@@ -40,7 +40,7 @@
    "source": [
     "import numpy as np\n",
     "from landlab.components.overland_flow import OverlandFlow\n",
-    "from landlab.io.esri_ascii import read_esri_ascii\n",
+    "from landlab.io import read_esri_ascii\n",
     "from matplotlib.pyplot import figure"
    ]
   },

pytest.ini

@@ -7,14 +7,14 @@ addopts =
   --strict-markers
   --doctest-modules
   -vvv
+  --ignore=lessons/landlab/landlab-terrainbento
+  --ignore=lessons/pymt
   --ignore-glob=*/practice-your-skills.ipynb
-  --ignore-glob=*/Welcome_to_TerrainBento.ipynb
-  --ignore-glob=*/bedrockLandslides_on_DEMs.ipynb
+  --ignore-glob=*/bedrock_landslides_on_dems.ipynb
   --ignore-glob=*/ku-eml-paleomip.ipynb
   --ignore-glob=*/paleomip-processing.ipynb
   --ignore-glob=*/PFdepth-dependent-diffusion.ipynb
   --ignore-glob=*/create_a_component.ipynb
   --ignore-glob=*/landlab-fault-scarp-for-espin.ipynb
   --ignore-glob=*/intro-to-grids.ipynb
-  --ignore-glob=*/pymt/*.ipynb
   --ignore-glob=*/python/yet_another_oop.ipynb