Examples

The examples/ directory is a literate tutorial sequence. Every checked-in example is executable Julia, every example is included in this documentation, and every example writes at least one CairoMakie plot and one CairoMakie-recorded MP4 animation.

Run any example from the repository root:

julia --startup-file=no --project=. examples/hasselmann_inertial_oscillation.jl

Use small mode for CI-speed runs:

RIPPLE_EXAMPLE_MODE=small julia --startup-file=no --project=. examples/hasselmann_inertial_oscillation.jl

By default plots and animations are written under joinpath(tempdir(), "ripple_example_outputs", example_name). Set RIPPLE_EXAMPLE_OUTPUT_DIR to collect them somewhere specific.

The smoke harness runs every checked-in example and verifies finite model state, validation results, plot files, animation files, and the literate docs manifest:

julia --startup-file=no --project=. test/examples_smoke/run_examples.jl

The tutorial order starts with field construction, then adds source-only columns, bounded-domain WENO transport, finite-volume source semantics, and current-coupling projections.

• Product Field Basics
• Source-Only Fetch-Limited Growth
• Bounded Wave Packet Dispersion
• Hasselmann Column Growth
• CWCM Q-Transform With A Sheared Current
• Frequency-Direction Source Package
• Exact Finite-Volume Source Rates
• Wave Refraction Through A Barotropic Vortex