Skip to content

rompy-notebooks

Tutorials and examples for setting up and running ocean and coastal models with rompy and its model plugins for SWAN, XBeach and SCHISM.

Rompy describes a model run as validated Python objects (or a YAML file), turns datasets into the model's input files, and runs the model locally, in Docker or on a cluster. The notebooks here show how, model by model.

How to use this site

  1. What rompy does: the problem rompy solves and the big picture, in a few minutes. The hands-on notebook then goes through a complete run with a toy model.
  2. Installation and using the notebooks: get the notebooks running on your machine.
  3. Concepts: the ideas behind every model, in more depth: configuration and validation, data, the run lifecycle and plugins.
  4. Learning tutorials: an ordered path through one model, from a first run to a complete setup: SWAN, XBeach or SCHISM.
  5. Notebook catalogue: every notebook by model and by topic, for when you need a specific feature.

New to rompy? Start with step 1. If you already know rompy, go straight to a learning tutorial or the catalogue.

Note

The pages show the outputs stored in the notebooks. Building this site does not run the notebooks or any model.