User Guide

This section provides comprehensive documentation for using rompy-oceanum effectively. Whether you’re new to the framework or looking to implement advanced workflows, these guides will help you make the most of the Oceanum Prax pipeline integration.

Basic Usage

Learn the fundamentals of using rompy-oceanum for wave model execution.

Basic Usage
Configuration

Configure rompy-oceanum for your specific needs and environment.

Configuration
Pipeline Backends

Understand and configure different pipeline execution backends.

Pipeline Backends
CLI Reference

Complete command-line interface documentation and examples.

CLI Reference
Troubleshooting

Solve common issues and debug problems effectively.

Troubleshooting
Advanced Workflows

Implement complex modeling workflows and automation.

Advanced Workflows

Overview

rompy-oceanum extends the rompy wave modeling framework with cloud-native execution capabilities through the Oceanum Prax pipeline system. The user guide covers:

Core Concepts

Understanding the plugin architecture, configuration patterns, and execution models.

Getting Started

Step-by-step instructions for your first wave model submission to Prax.

Configuration Management

Environment variables, configuration files, and runtime parameters.

Pipeline Operations

Submitting, monitoring, and managing model execution pipelines, including project management.

Result Management

Downloading outputs, registering in DataMesh, and post-processing workflows.

Best Practices

Performance optimization, error handling, and production deployment strategies.

Quick Navigation

New Users

If you’re new to rompy-oceanum, start with:

  1. Basic Usage - Learn core concepts and simple workflows

  2. Configuration - Set up your environment and authentication

  3. SWAN Workflow Example - Follow a complete SWAN modeling example

Experienced Users

For advanced usage patterns:

  1. Pipeline Backends - Configure custom execution environments

  2. Advanced Workflows - Implement batch processing and automation

  3. API Reference - Explore programmatic interfaces

Administrators

For deployment and management:

  1. Configuration - Environment and security configuration

  2. Troubleshooting - Debugging and monitoring

  3. Architecture - Understanding system design

Common Workflows

The most common rompy-oceanum workflows include:

Single Model Execution

Submit a single wave model configuration for remote execution.

Batch Processing

Process multiple model configurations in parallel or sequence.

Ensemble Modeling

Run multiple model variants with different parameters or forcing data.

Operational Forecasting

Automated model execution for real-time wave forecasting.

Research Workflows

Interactive model development and sensitivity analysis.

Plugin Architecture

rompy-oceanum integrates with rompy through a clean plugin architecture:

Architecture Flow:

rompy ModelRun
     │
     ▼
Pipeline Backend Selection
     │
     ▼
┌─────────────┬─────────────┐
│    local    │    prax     │
│ execution   │  backend    │
└─────────────┴─────────────┘
                   │
                   ▼
           Oceanum Prax API
                   │
                   ▼
           DataMesh Registration

Key benefits of this architecture:

  • Runtime Selection: Choose execution backend when running, not when configuring

  • Configuration Separation: Backend settings don’t pollute model configuration

  • Extensibility: Easy to add new backends and postprocessors

  • Compatibility: Works seamlessly with existing rompy workflows

Environment Setup

Before diving into the guides, ensure your environment is properly configured:

# Essential environment variables
export PRAX_TOKEN="your-authentication-token"
export PRAX_ORG="your-organization"
export PRAX_PROJECT="your-project"
export PRAX_BASE_URL="https://prax.oceanum.science"

Tip

See the Configuration guide for complete environment setup instructions.

Table of Contents

Additional Resources