SalishSeaCmd
  • SalishSeaCmd Package Installation
  • SalishSeaCmd Changes That Break Backward Compatibility
  • salishsea Sub-Commands
  • Run Description File Structure
    • NEMO-3.6 Run Description File
    • NEMO-3.6 Run Description File for AGRIF Runs
    • Segmented Runs
  • SalishSeaCmd API
  • SalishSeaCmd Package Development
SalishSeaCmd
  • Run Description File Structure
  • View page source

Run Description File Structure

salishsea run description files are written in YAML. They contain key-value pairs that define the names and locations of files and directories that salishsea uses to manage SalishSeaCast NEMO runs and their results.

Run description files are typically stored in a sub-directory of your clone of the SS-run-sets.

  • NEMO-3.6 Run Description File
    • Example Run Description YAML File
    • Basic Run Configuration
    • paths Section
    • grid Section
    • forcing Section
      • Atmospheric Forcing File Checks
    • restart Section
    • namelists Section
    • output Section
    • vcs revisions Section
  • NEMO-3.6 Run Description File for AGRIF Runs
    • Example AGRIF Run Description YAML File
    • Basic Run Configuration
    • AGRIF Section
    • paths Section
    • grid Section
    • forcing Section
    • restart Section
    • namelists Section
    • output Section
  • Segmented Runs
    • Segmented Runs YAML File Restrictions
    • How Segmented Runs Work
    • Restarting After a Segment Failure
Previous Next

© Copyright 2013 – present, SalishSeaCast Project Contributors and The University of British Columbia. Last updated on Jun 15, 2026.

Built with Sphinx using a theme provided by Read the Docs.