Tutorials

Notebooks under tutorials/. Click tags to filter: tags of one category widen the selection, tags of different categories narrow it.

component model 3 system-model 3 numerical-system-model 3 solver 3

model swe 2 sme 2

task simulation 4

backend amrex 1 numpy 3

method fv 4

clear

::::{grid} 1 2 2 2

gutter:

3

:::{grid-item-card} AMReX: from symbolic model to generated C++

class-card:

zt-card

link:

ipynb/amrex/minimal

link-type:

doc

A 1-D dam break printed as C++ headers for AMReX, built, run and read back.

tutorials/amrex/minimal.ipynb

component:system-model component:numerical-system-model component:solver model:swe task:simulation backend:amrex method:fv :::

:::{grid-item-card} Zoomy in your browser

class-card:

zt-card

link:

../jupyter-lite/_output/lab/index.html?path=pyodide.ipynb

link-type:

url

SME(2) dam break in Pyodide: Model, SystemModel, NSM, generated C++, a NumPy solve and the velocity profile.

tutorials/pyodide/pyodide.ipynb

component:model component:system-model component:numerical-system-model component:solver model:sme task:simulation backend:numpy method:fv :::

:::{grid-item-card} Shallow moments in 2-D

class-card:

zt-card

link:

ipynb/sme/moments_2d

link-type:

doc

Write a bed-drag closure, inject it into SME, run in 2-D and read the vertical velocity profile back.

tutorials/sme/moments_2d.ipynb

component:model model:sme task:simulation backend:numpy method:fv :::

:::{grid-item-card} Shallow water in 1-D

class-card:

zt-card

link:

ipynb/swe/simple_numpy

link-type:

doc

The whole pipeline once: model, operators, scheme, solve and plot, in 1-D on the NumPy reference solver.

tutorials/swe/simple_numpy.ipynb

component:model component:system-model component:numerical-system-model component:solver model:swe task:simulation backend:numpy method:fv :::

::::

Adding a notebook

Put the notebook under tutorials/, add metadata.zoomy (title, summary, tags, optional "status": "legacy") and run python docs/scripts/generate_tutorial_index.py. Tag categories:

• component: model / system-model / numerical-system-model / solver

• model: swe / sme / vam / euler

• task: analysis / simulation / ad / coupling

• backend: jax / foam / amrex / numpy

• method: fv / lsq / mood / imex / chorin

To publish the rendered notebook in the book, add it to PUBLISHED_TUTORIALS in docs/scripts/generate_ci_test_report.py and to _toc.yml.