Notebooks

The example notebooks are kept in the repository-root notebooks/ directory so that users can browse them directly on GitHub without going through the docs site.

For the published docs, each notebook is also exported to a generated Markdown page under docs/notebooks/.

Source notebooks in the repository

The repository source notebooks are:

• notebooks/01_basic_compute.ipynb
• notebooks/02_periodic_graph.ipynb
• notebooks/03_locate_and_ghost.ipynb
• notebooks/04_powerfit.ipynb
• notebooks/05_visualization.ipynb
• notebooks/06_powerfit_reports.ipynb
• notebooks/07_powerfit_infeasibility.ipynb
• notebooks/08_powerfit_active_path.ipynb

Published notebook pages

The generated documentation pages are:

• 01 basic compute
• 02 periodic graph
• 03 locate and ghost cells
• 04 powerfit workflow
• 05 visualization
• 06 powerfit reports
• 07 powerfit infeasibility
• 08 active-set path diagnostics

Regeneration

To refresh the generated pages after editing notebooks:

python tools/export_notebooks.py

To validate notebook executability against the installed pyvoro2 package in the current environment:

python tools/check_notebooks.py

If you are using the wheel-overlay developer workflow and want notebook imports to resolve from repo/src, use:

python tools/check_notebooks.py --use-src