ANUGA documentation

ANUGA (pronounced “AHnooGAH”) is open-source software for the simulation of the shallow water equation, in particular it can be used to model tsunamis and floods.

ANUGA is a Python 3 package (Python 3.10 – 3.14) with some C and Cython extensions.

ANUGA was created in a collaboration by Geoscience Australia and Mathematical Sciences Institute at the Australian National University. It is now developed and maintained by a community of volunteers.

Contents:

• Background
• Mathematical Background
  • Shallow Water Wave Equations
  • Finite Volume Method
  • Flux Limiting
  • Slope Limiting
  • References
• Installation
  • Install Python
  • Install ANUGA
  • Install ANUGA for Developers
• Script Structure
  • Creating a Domain
  • Coordinate Reference Systems
  • Setting up Initial Conditions
  • Setting up the Boundaries
  • Operators
  • Setting up the Evolve loop
  • Checkpointing
  • Logging
• Running Scenarios with anuga_run_toml
  • Quick Start
  • Working example — Cairns tsunami scenario
  • Minimal annotated TOML
  • Scenario Directory Layout
  • Configuration File Reference
  • Custom Callbacks: user_functions.py
  • Output Directory Structure
  • Excel Compatibility
• Examples
  • Simple Script Example
  • Simple Notebook Example
  • Simple Example using Create from Regions
  • Example of Creating Domains with River Walls
  • Merewether Flood Case Study Example
  • Tsunami runup example
• Visualisation
  • Domain Plotter
  • SWW Plotter
  • ANUGA Viewer
  • Visualise with QGIS
• Parallelisation
  • OpenMP Parallelisation
  • MPI Parallelisation
  • Mesh-first parallel workflow (distribute_basic_mesh)
  • Choosing an MPI distribution strategy
• API Reference
  • Domain
  • Quantity
  • Region
  • Geo_reference
  • File format reference
  • Validation test suite
• Troubleshooting
  • MPI not available / parallel runs fall back to serial
  • OpenMP threading not activating
  • Rank-0 memory exhaustion on large meshes
  • SWW output errors
  • Boundary tag errors
  • Mesh file errors
  • Installation and import errors
  • Performance issues
  • Getting further help
• Index