Notebook Execution Matrix

July 29, 2026 · View on GitHub

This matrix records how each notebook is expected to run, which extras it needs, and whether the current CI path executes it.

Execution Policy

Repository CI currently validates notebooks on Python 3.12 with:

pip install --require-hashes --no-deps -r requirements/dev-lock.txt
pip install --no-deps -e .
jupyter nbconvert --execute --to notebook notebooks/*.ipynb --ExecutePreprocessor.timeout=120

All 21 committed notebooks use the python3 kernel metadata and ship without stored execution counts or outputs. CI executes transient copies; generated notebook output is test evidence, not a tracked release artefact.

For local work, install notebook extras and run from the repository root:

python -m pip install -e ".[dev,notebook,plot]"
jupyter lab notebooks/

Matrix

NotebookPrimary surfaceRequired extrasCI expectationRuntime classNotes
01_queuewaves_retry_storm.ipynbQueueWavesdev, notebook, plot, queuewavesexecutedshortservice-queue retry storm and supervisor trace
02_minimal_domain.ipynbDomain authoringdev, notebook, plotexecutedshortsmallest complete binding workflow
03_geometry_walk.ipynbSymbolic channeldev, notebook, plotexecutedshortgraph-walk phases and geometry coupling
04_bio_stub.ipynbBiologydev, notebook, plotexecutedshortmulti-scale biological oscillator mapping
05_manufacturing_spc.ipynbManufacturingdev, notebook, plotexecutedshortSPC sensor mapping and policy behaviour
06_stuart_landau_amplitude.ipynbUPDEdev, notebook, plotexecutedshortphase-amplitude dynamics and PAC
07_policy_petri_net.ipynbSupervisordev, notebook, plotexecutedshortpolicy DSL, regimes, and Petri net sequencing
08_audit_replay.ipynbAuditdev, notebook, plotexecutedshortdeterministic replay and hash-chain checks
09_binding_spec.ipynbBindingdev, notebook, plotexecutedshortschema walkthrough and validation
10_reporting_adapters.ipynbReporting/adaptersdev, notebook, plot, full when bridge deps are usedexecutedmediumexternal bridge patterns; optional bridge imports may need full
11_identity_coherence.ipynbSSGFdev, notebook, plotexecutedmediumidentity coherence, chimera, and plasticity
12_autotune_pipeline.ipynbAutotunedev, notebook, plotexecutedmediumfrequency identification and coupling estimation
13_ssgf_closure.ipynbSSGFdev, notebook, plotexecutedmediumfree-energy closure loop
14_chimera_detection.ipynbMonitordev, notebook, plotexecutedmediumchimera detection workflow
15_spectral_analysis.ipynbCouplingdev, notebook, plotexecutedmediumspectral alignment analysis
16_sleep_staging.ipynbMonitor/domainpackdev, notebook, plotexecutedmediumsleep-stage phase dynamics
17_power_grid_stability.ipynbPower systemsdev, notebook, plotexecutedmediuminertial Kuramoto transient
18_market_regime_detection.ipynbFinancedev, notebook, plotexecutedmediumHilbert phase extraction and market regimes
19_swarmalator_dynamics.ipynbRoboticsdev, notebook, plotexecutedmediumspatial and phase swarmalator dynamics
20_honest_early_warning_auditor.ipynbEvaluationdev, notebookexecutedfastmatched-false-alarm + permutation audit of a detector
21_control_engineer_onboarding.ipynbOnboardingdev, notebook, plotexecutedmedium15-minute golden path: validate, coupling sweep, audit and replay

Runtime classes:

ClassExpected local behaviour
shortshould complete within the CI 120-second per-notebook timeout on normal CI hardware
mediummay approach the timeout on slower machines; prefer interactive execution when debugging
local-onlynot currently used by the 21 shipped notebooks; reserve for future GPU, quantum, or external-service notebooks

Maintenance Rules

When adding or changing a notebook:

  1. Add or update its row in this matrix.
  2. State required extras and whether external data or services are needed.
  3. Keep default cell counts and step counts suitable for the CI timeout.
  4. Prefer deterministic seeds for simulations.
  5. Link a terminal example or guide that covers the same workflow.
  6. If a notebook cannot run in CI, mark it local-only and explain why.

Local Failure Recovery

Use the Troubleshooting notebook section when imports, optional dependencies, or timeouts fail.