Examples

The examples below range from a minimal introductory script through to real-world flood and tsunami validation cases. Each notebook can be downloaded and run locally; the script example is also available in the examples/simple_examples/ directory of the repository.

Example

Description

Level

Simple script

Wave runup on a linearly sloping bed using a rectangular mesh. Introduces the core ANUGA workflow: mesh creation, set_quantity, boundary conditions, and the evolve loop. No external data files required.

Beginner

Simple notebook

The same runup scenario presented as an interactive Jupyter notebook with inline animation via Domain_plotter. A good starting point for exploring ANUGA interactively.

Beginner

Domain from regions

Builds an unstructured mesh from a bounding polygon with multiple tagged boundary segments using create_domain_from_regions. Demonstrates mesh refinement with maximum_triangle_area and multi-tag boundary assignment.

Intermediate

Domain with riverwalls

Adds infinitely-thin levee/riverwall structures to a mesh using breaklines (to align triangle edges with the wall) and create_riverwalls. Compares flow with and without the wall in place.

Intermediate

Flooding example

Real-world urban flood model of Merewether, Newcastle (NSW) driven by DEM topography, an Inlet_operator hydrograph, and building exclusion polygons. Results are compared against benchmark observational data using SWW_plotter.

Advanced

Tsunami benchmark

Okushiri Island tsunami runup (IWTS Benchmark 2) with incoming wave specified via Transmissive_n_momentum_zero_t_momentum_set_stage_boundary and spatially interpolated bathymetry. Simulated water-surface time series are compared against physical model gauge data.

Advanced