-
-
Notifications
You must be signed in to change notification settings - Fork 67
Add a tutorial walkthrough notebook and documentation page #242
Open
Description
Problem Statement
The example scripts in examples/ are complete, runnable simulations, but they are reference material rather than teaching material: a new user's first contact with the package is reverse-engineering a finished script from its comments. There is no guided walkthrough that introduces the workflow one object at a time and explains why each step exists, and the documentation website has no tutorial page.
Location(s): examples/, docs/website/
Proposed Solution
- Write a tutorial as a Jupyter notebook that builds a simulation from scratch, introducing each object as it is created (the geometry classes, the operating point, the problem, and the solver) and ending with solving, logging results, and visualization.
- Render the notebook as a page on the documentation website so it is readable without downloading or running anything.
- Decide how to keep the tutorial from drifting: either execute the notebook during the documentation build or add it to the outputs regenerated by
scripts/regenerate_example_outputs.py, so an API change that breaks the tutorial is caught rather than shipped.