Add pytest script and CI job to test tutorials

.github/workflows/build_lint.yml

@@ -64,26 +64,3 @@ jobs:
     - if: matrix.os == 'ubuntu'
       name: Codecov
       uses: codecov/codecov-action@v4
-
-  examples:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-        cache: 'pip'
-    - name: Install uv
-      run: pip install uv
-    - name: Install Mesa
-      run: uv pip install --system .[examples]
-    - name: Checkout mesa-examples
-      uses: actions/checkout@v4
-      with:
-        repository: projectmesa/mesa-examples
-        path: mesa-examples
-    - name: Test examples
-      run: |
-        cd mesa-examples
-        pytest -rA -Werror -Wdefault::FutureWarning test_examples.py

.github/workflows/examples.yml

@@ -0,0 +1,61 @@
+name: Examples
+
+on:
+  push:
+    branches:
+    - main
+    - release**
+    - "**maintenance"
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'
+
+jobs:
+  examples:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+        cache: 'pip'
+    - name: Install uv
+      run: pip install uv
+    - name: Install dependencies
+      run: uv pip install --system .[examples]
+    - name: Checkout mesa-examples
+      uses: actions/checkout@v4
+      with:
+        repository: projectmesa/mesa-examples
+        path: mesa-examples
+    - name: Test examples
+      run: |
+        cd mesa-examples
+        pytest -rA -Werror -Wdefault::FutureWarning test_examples.py
+
+  tutorials:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+        cache: 'pip'
+    - name: Install uv
+      run: pip install uv
+    - name: Install Mesa dependencies
+      run: uv pip install --system .
+    - name: Install tutorial dependencies
+      run: uv pip install --system pytest jupyter nbconvert seaborn pandas
+    # Run Pytest on Jupyter Notebooks
+    - name: Test Jupyter Notebooks with Pytest
+      env:
+        JUPYTER_PLATFORM_DIRS: 1
+      run: pytest -rA -Werror -Wdefault::FutureWarning tests/test_tutorials.py

docs/tutorials/visualization_tutorial.ipynb

@@ -208,7 +208,7 @@
     "    # plt.figure(), for thread safety purpose\n",
     "    fig = Figure()\n",
     "    ax = fig.subplots()\n",
-    "    wealth_vals = [agent.wealth for agent in model.agents]\n",
+    "    wealth_vals = [agent.wealth for agent in model.schedule.agents]\n",
     "    # Note: you have to use Matplotlib's OOP API instead of plt.hist\n",
     "    # because plt.hist is not thread-safe.\n",
     "    ax.hist(wealth_vals, bins=10)\n",

tests/test_tutorials.py

@@ -0,0 +1,23 @@
+import glob
+
+import nbformat
+import pytest
+from nbconvert.preprocessors import ExecutePreprocessor
+
+notebooks = glob.glob("docs/**/*.ipynb", recursive=True)
+
+
+@pytest.mark.parametrize("notebook_path", notebooks)
+def test_notebook_execution(notebook_path):
+    # Load the notebook
+    with open(notebook_path) as f:
+        nb = nbformat.read(f, as_version=4)
+
+    # Set up the notebook execution
+    ep = ExecutePreprocessor(timeout=600, kernel_name="python3")
+
+    try:
+        # Execute the notebook and catch any errors
+        ep.preprocess(nb, {"metadata": {"path": "./"}})
+    except Exception as e:
+        pytest.fail(f"Notebook {notebook_path} failed: {e!s}")