Tutorial Slides#
The tutorial slide decks are published as PDF files. They are built from the
slide sources in docs/tutorials and copied to the root tutorials folder
with make publish.
Each PDF title page contains a version date generated at build time.
The tutorial scripts generate their data with the core installation. Install the tutorial dependencies when you also want the diagnostic vector-field plots:
pip install -e ".[tutorials]"
Tutorial |
Topic |
|
|---|---|---|
Tutorial 1 |
HPC installation |
|
Tutorial 2 |
Getting started workflow |
|
Tutorial 3 |
Vector-field workflows |
|
Tutorial 4 |
Helical magnet workflow |
|
Tutorial 5 |
Longitudinal helix sweep |
Build Notes#
The published PDFs are served by Sphinx through html_extra_path in
docs/conf.py. This copies the root tutorials folder into the generated
HTML site during the documentation build.
When a slide deck changes, rebuild and publish it from its source folder:
make slides.pdf
make publish
or use:
make final