File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -10,6 +10,41 @@ This script runs Jupyter notebooks from `docs/source/notebooks/` to validate the
10104 . ** Guards widget updates** — Patches nbclient to ignore display_id assertion errors
11115 . ** Discards outputs** — Only checks for errors, doesn't save results
1212
13+ ## Dependencies
14+
15+ The notebook runner mirrors the CI setup and expects a full docs/test environment.
16+
17+ 1 . ** Install Python dependencies**
18+
19+ ``` bash
20+ pip install -e " .[test,docs]"
21+ ```
22+
23+ This brings in Papermill, Jupyter, nbclient, and notebook-related dependencies.
24+
25+ 2 . ** Install Graphviz (system dependency)**
26+
27+ - macOS:
28+ ``` bash
29+ brew install graphviz
30+ ```
31+ - Ubuntu/Debian:
32+ ` ` ` bash
33+ sudo apt-get update && sudo apt-get install -y graphviz
34+ ` ` `
35+
36+ 3. ** Optional: parallel execution**
37+
38+ ` ` ` bash
39+ pip install joblib
40+ ` ` `
41+
42+ # # Notes
43+
44+ - The runner executes using the ` python3` Jupyter kernel. Ensure your environment
45+ provides that kernel (e.g., from ` ipykernel` installed via the docs extras).
46+ - The CI workflow uses Python 3.12 and installs the same extras.
47+
1348# # Usage
1449
1550` ` ` bash
You can’t perform that action at this time.
0 commit comments