Command Line Interface#

The ROMPY Command Line Interface (CLI) provides a comprehensive set of tools for generating, running, and processing ocean, wave, and hydrodynamic model configurations with support for multiple execution backends.

Overview#

ROMPY CLI provides a comprehensive command structure:

rompy <command> [options] [arguments]

Commands#

run#

Execute a model configuration using a Pydantic backend configuration.

rompy run [<config-file>] --backend-config <backend-config-file> [OPTIONS]

Options:

--backend-config PATH#: Required. YAML/JSON file with backend configuration

--dry-run#: Generate inputs only, don’t run the model

--config-from-env#: Load configuration from ROMPY_CONFIG environment variable instead of file

Examples:

# Run with local backend configuration
rompy run model.yml --backend-config local_backend.yml

# Run with Docker backend configuration
rompy run model.yml --backend-config docker_backend.yml

# Dry run (generate only, don't execute)
rompy run model.yml --backend-config local_backend.yml --dry-run

# Load configuration from environment variable
export ROMPY_CONFIG="$(cat model.yml)"
rompy run --config-from-env --backend-config local_backend.yml

backends#

Manage execution backend configurations.

rompy backends <subcommand> [OPTIONS]

Subcommands:

list: List available backends and configuration types
validate: Validate a backend configuration file
schema: Generate JSON schema for backend configurations
create: Create template backend configuration files

Examples:

# List available backends
rompy backends list

# Validate configuration
rompy backends validate my_config.yml --backend-type local

# Generate schema
rompy backends schema --backend-type docker --format json

# Create template
rompy backends create --backend-type local --output local_template.yml

pipeline#

Run the complete model pipeline: generate → run → postprocess.

rompy pipeline [<config-file>] [OPTIONS]

Options:

--run-backend TEXT#: Execution backend for run stage (default: local)

--processor TEXT#: Postprocessor to use (default: noop)

--cleanup-on-failure, --no-cleanup#: Clean up outputs on pipeline failure (default: False)

--validate-stages, --no-validate#: Validate each stage before proceeding (default: True)

--config-from-env#: Load configuration from ROMPY_CONFIG environment variable instead of file

Example:

rompy pipeline config.yaml --run-backend docker --processor analysis

generate#

Generate model input files without running the model.

rompy generate [<config-file>] [OPTIONS]

Options:

--output-dir PATH#: Override output directory from configuration

--config-from-env#: Load configuration from ROMPY_CONFIG environment variable instead of file

Example:

rompy generate config.yaml --output-dir ./test_inputs

validate#

Validate model configuration without execution.

rompy validate [<config-file>]

Options:

--config-from-env#: Load configuration from ROMPY_CONFIG environment variable instead of file

Examples:

rompy validate config.yaml

# Validate configuration from environment variable
export ROMPY_CONFIG="$(cat config.yaml)"
rompy validate --config-from-env

Configuration Sources#

ROMPY CLI commands support loading configuration from two sources:

File-based Configuration:

rompy validate config.yaml
rompy run config.yaml --backend-config local.yml

Environment Variable Configuration:

export ROMPY_CONFIG="$(cat config.yaml)"
rompy validate --config-from-env
rompy run --config-from-env --backend-config local.yml

Important Notes:

You cannot specify both a config file and --config-from-env simultaneously
The ROMPY_CONFIG environment variable must contain valid JSON or YAML
Environment variable configuration is ideal for containers, CI/CD, and cloud deployments
All commands that accept configuration support both methods

schema#

Show configuration schema information.

rompy schema [OPTIONS]

Options:

--model-type TEXT#: Show schema for specific model type

Example:

rompy schema --model-type swan

Backend Configuration Files#

Backend configurations are defined in YAML or JSON files with a type field indicating the backend type:

Local Backend Configuration:

type: local
timeout: 3600
env_vars:
  OMP_NUM_THREADS: "4"
  MODEL_DEBUG: "true"
command: "python run_model.py --verbose"
shell: true
capture_output: true

Docker Backend Configuration:

type: docker
image: "swan:latest"
cpu: 4
memory: "2g"
timeout: 7200
env_vars:
  SWAN_THREADS: "4"
volumes:
  - "/data/input:/app/input:ro"
  - "/data/output:/app/output:rw"
executable: "/usr/local/bin/swan"

For complete configuration options, see Backend Reference.

Global Options#

All commands support these common options:

-v, --verbose#: Increase verbosity (can be used multiple times: -v, -vv)

--log-dir PATH#: Directory to save log files

--show-warnings, --hide-warnings#: Show or hide Python warnings (default: hide)

--ascii-only, --unicode#: Use ASCII-only characters in output (default: unicode)

--simple-logs, --detailed-logs#: Use simple log format without timestamps and module names (default: detailed)

--config-from-env#: Load configuration from ROMPY_CONFIG environment variable instead of file

--version#: Show version information and exit

Backend Types#

ROMPY supports multiple execution backends through its plugin architecture:

Run Backends#

Execute models in different environments:

local: Execute directly on the local system
docker: Execute inside Docker containers
slurm: Execute via SLURM job scheduler (if available)
kubernetes: Execute on Kubernetes clusters (if available)

Postprocessors#

Handle model output analysis and transformation:

noop: No-operation processor (validation only)
analysis: Statistical analysis and metrics calculation
visualization: Generate plots and animations
netcdf: NetCDF output processing and compression

Pipeline Backends#

Orchestrate complete workflows:

local: Execute all stages locally
hpc: HPC-optimized pipeline execution
cloud: Cloud-native pipeline execution

Examples#

Modern Workflow Examples#

Execute a SWAN model with typed backend configuration:

rompy run swan_config.yaml --backend-config local_backend.yml

Complete pipeline with analysis:

rompy pipeline ocean_model.yaml \
    --run-backend local \
    --processor analysis \
    --validate-stages

Development workflow:

# Validate configuration
rompy validate config.yaml

# Generate inputs only
rompy generate config.yaml --output-dir ./test_run

# Test run with dry-run
rompy run config.yaml --backend-config local.yml --dry-run

Configuration Files#

Enhanced Configuration Structure#

The modern CLI supports enhanced configuration files with run and pipeline settings:

# Basic model configuration
run_id: my_ocean_model
period:
  start: 20230101T00
  end: 20230102T00
  interval: 3600
output_dir: ./outputs

config:
  model_type: schism
  # ... model-specific configuration

# Run configuration (optional)
run:
  backend: local
  local:
    env_vars:
      OMP_NUM_THREADS: "4"
    timeout: 3600

# Pipeline configuration (optional)
pipeline:
  backend: local
  local:
    run_backend: docker
    processor: analysis
    cleanup_on_failure: false

Environment Variables#

Configuration Loading#

Load configuration from environment variables instead of files:

# Set configuration in environment variable (JSON format)
export ROMPY_CONFIG='{
  "run_id": "env_example",
  "output_dir": "./output",
  "period": {"start": "20230101T000000", "duration": "1d"},
  "config": {"model_type": "swanconfig"}
}'

# Use environment variable configuration
rompy validate --config-from-env
rompy generate --config-from-env
rompy run --config-from-env --backend-config local.yml

# YAML format is also supported
export ROMPY_CONFIG="
run_id: env_yaml_example
output_dir: ./output
period:
  start: 20230101T000000
  duration: 1d
config:
  model_type: swanconfig
"

Global Settings#

Set default values using environment variables:

export ROMPY_LOG_DIR="./logs"
export ROMPY_ASCII_ONLY="1"
export ROMPY_SIMPLE_LOGS="1"

rompy run config.yaml --backend-config local.yml  # Uses environment settings

Container and CI/CD Usage#

Environment variable configuration is particularly useful for containerized deployments:

# Docker usage
docker run -e ROMPY_CONFIG="$(cat config.yml)" rompy:latest \
  rompy validate --config-from-env

# Kubernetes ConfigMap
kubectl create configmap rompy-config --from-file=ROMPY_CONFIG=config.yml
# Then reference in pod spec as environment variable

# CI/CD Pipeline
export ROMPY_CONFIG="$(envsubst < config_template.yml)"
rompy pipeline --config-from-env --run-backend docker

Monitoring and Debugging#

Verbose Output#

Use multiple -v flags for increased verbosity:

rompy run config.yaml --backend-config local.yml -v      # INFO level
rompy run config.yaml --backend-config local.yml -vv     # DEBUG level

Log Files#

Save detailed logs to files:

rompy pipeline config.yaml --log-dir ./logs --verbose

Backend Information#

Inspect available backends:

rompy backends list

Validation and Testing#

Validate configurations before running:

rompy validate config.yaml
rompy backends validate backend_config.yml --backend-type local

Exit Codes#

The CLI uses standard exit codes:

0: Success
1: Execution error
2: Configuration or argument error

Troubleshooting#

Common Issues#

Configuration Validation Errors:

rompy validate config.yaml
rompy backends validate backend_config.yml --backend-type local

# Test environment variable configuration
export ROMPY_CONFIG="$(cat config.yaml)"
rompy validate --config-from-env

Backend Not Available:

rompy backends list

Execution Failures:

rompy run config.yaml --backend-config local.yml --verbose --log-dir ./debug_logs

Docker Issues:

# Check if Docker backend is available
rompy backends list | grep docker

# Test with local backend first
rompy run config.yaml --backend-config local_backend.yml

Getting Help#

Use --help with any command for detailed options
Check the developer documentation for architectural details
Use verbose logging for debugging execution issues
Validate configurations before running production jobs

rompy --help
rompy run --help
rompy pipeline --help
rompy backends --help

Table of Contents

Command Line Interface#

Overview#

Commands#

run#

backends#

pipeline#

generate#

validate#

Configuration Sources#

schema#

Backend Configuration Files#

Global Options#

Backend Types#

Run Backends#

Postprocessors#

Pipeline Backends#

Examples#

Modern Workflow Examples#

Configuration Files#

Enhanced Configuration Structure#

Environment Variables#

Configuration Loading#

Global Settings#

Container and CI/CD Usage#

Monitoring and Debugging#

Verbose Output#

Log Files#

Backend Information#

Validation and Testing#

Exit Codes#

Troubleshooting#

Common Issues#

Getting Help#

This Page