Repository navigation
Add a series of getting started tutorials - #47
Merged
Merged
Conversation
Six short notebooks in examples/getting_started/, each showing one thing: running a model, the finned-tube models, the packed-bed models, changing parameter values, plotting, and experiments. The documentation site renders them under a new Getting started section of the examples, and the README and the getting started page point to them. The notebooks are run with their widget state stored, so that the interactive plots appear on the site as well. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Documentation build overview
12 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Six short notebooks in
examples/getting_started/, each showing one thing, as a gentle on-ramp before the capability notebooks:simulation.plot(), reading outputs and their unit twins, the same code on a packed bed.update,"[input]"sweeps, and composing sets from layers (copper fins, a paraffin, a PCM of your own).QuickPlot, the standard plots ofpytes.plotting, your own matplotlib figures, the ember colourmap and the PyTES colour cycle.Inlet,PowerandReststeps, terminations, discharge-rest-charge cycles, and time-varying flow (two draws with idle periods between them).The documentation site renders them under a new Getting started section of the examples (
docs/conf.pynow also copiesexamples/getting_started/), and the README and the getting started page point to them.Notes for review
dynamic_plotfigures appear on the site (with the slider at t = 0). The existing capability notebooks were saved without it, so their interactive plots render blank on the site today; re-running them the same way would fix that (not done here).QuickPlotcalls passspatial_unit="m", as PyBaMM's default is micrometres.Checks
pytest --nbmakepasses on tutorial 3 (the one that reads../data/).sphinx-build -W --keep-goingpasses.ruff checkandruff formatpass on the notebooks.The model documentation pages follow in a separate PR, stacked on this one.
🤖 Generated with Claude Code