Examples¶
Interactive Jupyter notebooks demonstrating rompy-xbeach features.
Notebook Status
Some notebooks may need updates to reflect recent component changes. They are provided for reference and will be updated progressively.
Available Examples¶
Core Concepts¶
| Notebook | Description |
|---|---|
| Grid | Grid creation and configuration |
| Bathymetry | Bathymetry data handling |
| Wave Boundary | Wave boundary condition setup |
Components¶
| Notebook | Description |
|---|---|
| Physics | Physics component configuration |
| Output | Output configuration |
| Forcing | Wind and tide forcing |
Complete Workflows¶
| Notebook | Description |
|---|---|
| Procedural Example | Full model setup using Python objects |
| Declarative Example | Full model setup using YAML 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:
- GitHub: rom-py/rompy-notebooks (xbeach branch)