XBeach Model Guide

[!NOTE] This documentation page is a placeholder. XBeach model support in Rompy is under active development, and comprehensive documentation is still being created.

Installation

To use the XBeach model with Rompy, install the dedicated plugin:

pip install rompy-xbeach

Overview

XBeach is a numerical model for the simulation of nearshore and coastal processes. It is designed to compute wave propagation, sediment transport, and morphological changes in the coastal zone. With Rompy, you can configure XBeach simulations using Python objects that are validated with Pydantic, ensuring consistent and reproducible model setups.

Detailed Documentation

For comprehensive documentation on using XBeach with Rompy, visit: https://rom-py.github.io/rompy-xbeach

Worked Examples

For practical, hands-on examples of how to use XBeach with Rompy, please see the following notebooks:

• XBeach Procedural Example: A basic demonstration of a procedural XBeach run.
• XBeach Grid Demo: Examples of XBeach grid configuration and usage.
• XBeach Bathymetry Demo: Examples of how to set up bathymetry for XBeach models.
• XBeach Forcing Demo: Examples of how to set up forcing conditions for XBeach models.
• XBeach Output Demo: Examples of how to configure and process XBeach outputs.

Next Steps

• Review the Backends Guide for detailed execution options
• Learn about Configuration Deep Dive for detailed configuration options
• Check the Progressive Tutorials for practical examples