Demonstration Notebooks

Thumbnails Gallery

The following demonstration notebooks showcase various aspects of Rompy's functionality:

• Demo Notebook - Basic demonstration of Rompy features
• Templates Demo - Using cookiecutter templates for model setup
• SWAN Declarative Example - Declarative configuration of SWAN models
• SWAN Procedural Example - Procedural configuration of SWAN models
• SWAN Sensitivity Example - Sensitivity analysis with SWAN models
• Oceanum Example - Using Oceanum data sources
• SWAN Config Components - Detailed configuration components for SWAN
• Physics - Physics-based model configurations
• SCHISM Procedural - Procedural configuration of SCHISM models

These notebooks provide practical examples of how to use Rompy for various ocean modeling tasks. Each notebook demonstrates different aspects of the framework, from basic usage to advanced features.

Getting Started

To run these notebooks:

1. Install Rompy with notebook dependencies:

   pip install rompy[notebooks]
   

2. Start Jupyter:

   jupyter notebook
   

3. Open any of the demonstration notebooks and run the cells.

Prerequisites

Some notebooks require additional dependencies:

• SWAN Notebooks: SWAN model installation
• SCHISM Notebooks: SCHISM model installation
• Oceanum Notebooks: Oceanum account and API key

Contributing Examples

To contribute new demonstration notebooks:

1. Create a new notebook in the appropriate directory
2. Follow the existing structure and conventions
3. Include clear explanations and comments
4. Add the notebook to the gallery in this document
5. Submit a pull request

For more information on contributing, see contributing.