test: Run tutorials in tests

docs/examples/ch03NiModelling/solutions/diffpy-cmi/fitBulkNi.py

@@ -33,7 +33,7 @@
 # First we store the absolute directory of this script,
 # then two directories above this,with the directory
 # 'data' appended
-PWD = Path(__file__).parent.absolute()
+PWD = Path(__file__).parent.resolve()
 DPATH = PWD.parent.parent / "data"
 
 # 3: Give an identifying name for the refinement, similar

docs/examples/ch03NiModelling/solutions/diffpy-cmi/fitNPPt.py

@@ -87,7 +87,9 @@
     print("The Ni example refines instrument parameters\n")
     print("The instrument parameters are necessary to run this fit\n")
     print("Please run the Ni example first\n")
-
+    print("Setting Q_damp and Q_broad to the refined values\n")
+    QDAMP_I = 0.045298
+    QBROAD_I = 0.016809
 # If we want to run using multiprocessors, we can switch this to 'True'.
 # This requires that the 'psutil' python package installed.
 RUN_PARALLEL = False

docs/examples/ch08NPRefinement/solutions/diffpy-cmi/fitCdSeNP.py

@@ -447,10 +447,6 @@ def plot_results(recipe, fig_name):
 
     # Change some style details of the plot
     mpl.rcParams.update(mpl.rcParamsDefault)
-    if (PWD.parent.parent.parent / "utils" / "billinge.mplstyle").exists():
-        plt.style.use(
-            str(PWD.parent.parent.parent / "utils" / "billinge.mplstyle")
-        )
 
     # Create a figure and an axis on which to plot
     fig, ax1 = plt.subplots(1, 1)

docs/examples/ch11ClusterXYZ/solutions/diffpy-cmi/fitCdSeNP.py

@@ -199,9 +199,6 @@ def plot_results(recipe, figname):
     diff = g - gcalc + diffzero
 
     mpl.rcParams.update(mpl.rcParamsDefault)
-    plt.style.use(
-        str(PWD.parent.parent.parent / "utils" / "billinge.mplstyle")
-    )
 
     fig, ax1 = plt.subplots(1, 1)
 

news/example-ci.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* Add tests that run PDF example scripts
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

requirements/tests.txt

@@ -8,3 +8,4 @@ pytest-env
 pytest-mock
 freezegun
 DeepDiff
+psutil

tests/conftest.py

@@ -1,8 +1,32 @@
 import json
+import shutil
 from pathlib import Path
 
+import matplotlib
 import pytest
 
+PROJECT_ROOT = Path(__file__).resolve().parents[1]
+EXAMPLES_ROOT = PROJECT_ROOT / "docs" / "examples"
+
+
+@pytest.fixture(scope="session")
+def tmp_examples(tmp_path_factory):
+    """Copy the entire examples/ tree into a temp directory once per
+    test session.
+
+    Returns the path to that copy.
+    """
+    tmpdir = tmp_path_factory.mktemp("examples")
+    tmp_examples = tmpdir / "examples"
+    shutil.copytree(EXAMPLES_ROOT, tmp_examples)
+    yield tmp_examples
+
+
+@pytest.fixture(scope="session", autouse=True)
+def use_headless_matplotlib():
+    """Force matplotlib to use a headless backend during tests."""
+    matplotlib.use("Agg")
+
 
 @pytest.fixture
 def user_filesystem(tmp_path):

tests/test_examples.py

@@ -0,0 +1,8 @@
+import runpy
+
+
+def test_all_examples(tmp_examples):
+    scripts = list(tmp_examples.rglob("**/solutions/diffpy-cmi/*.py"))
+    for script_path in scripts:
+        print(f"Testing {script_path.relative_to(tmp_examples)}")
+        runpy.run_path(str(script_path), run_name="__main__")