XBeach

XBeach has a seven-lesson tutorial and seventeen focused examples. The tutorial goes from a first model to a complete storm-impact setup and its YAML configuration; the examples cover one feature each.

Recommended path

Start with the XBeach learning tutorial and follow the lessons in order. The examples are listed on the same page, and the XBeach catalogue provides the complete reference view.

Coverage

The collection covers grids, data sources, bathymetry, wave, wind and water level forcing, physics, sediment and morphology, flow and tide boundaries, outputs, hotstarts, YAML and the rompy CLI, running XBeach locally, with Docker and with MPI, and parameter sweeps. See the coverage matrix.

Note

The notebooks store their outputs, including the results of the XBeach runs made with the public Docker image ghcr.io/rom-py/xbeach. Documentation builds render these outputs without executing the notebooks or XBeach.