Skip to content

Examples

Interactive Jupyter notebooks demonstrating rompy-xbeach features.

Getting Started

Start here to learn the full rompy-xbeach workflow:

Notebook Description
Procedural Workflow Step-by-step model setup using Python code
Declarative Workflow Model setup using YAML configuration

These notebooks provide a complete overview of setting up an XBeach model, from grid definition through to generating the model workspace.

Data Interface Tutorials

Learn how to prepare input data for XBeach models:

Notebook Description
Grid Define computational grids with various configurations
Sources Load data from NetCDF, GeoTIFF, and other formats
Bathymetry Interpolate and extend bathymetry onto the model grid
Wave Boundary Generate wave boundary conditions from spectral or parametric data
Forcing Set up wind and tide forcing from geolocated sources
Timeseries Forcing Use CSV/DataFrame timeseries for forcing

Component Tutorials

Configure XBeach physics and output parameters:

Notebook Description
Physics Wave breaking, friction, and flow numerics
Sediment Sediment transport and morphology
Output Output variables and timing
Boundary Conditions Flow boundary condition types
Hotstart Restart simulations from saved state
MPI Parallel execution configuration

Running Notebooks Locally

To run these notebooks yourself:

# Clone the notebooks repository
git clone -b xbeach https://github.com/rom-py/rompy-notebooks.git

# Navigate to XBeach notebooks
cd rompy-notebooks/notebooks/xbeach

# Start Jupyter
jupyter lab

Source Repository

These notebooks are maintained in a separate repository to keep rompy-xbeach lightweight: