legacy COMPASS

Configuration Of Model for Prediction Across Scales Setups (COMPASS) is an automated system to set up test cases that match the E3SM-Project/E3SM and MALI-Dev/E3SM repositories. All namelists and streams files begin with the default generated from the Registry.xml file, and only the changes relevant to the particular test case are altered in those files.

The following documentation is for the “legacy” version of COMPASS that can be found in the legacy branch on the COMPASS GitHub repo:

https://github.com/MPAS-Dev/compass/tree/legacy

User's guide

• Quick Start
  • Set up a COMPASS repository: for beginners
  • compass conda environment
  • Setting up a test case
  • Running a test case
  • Regression suites
  • Set up a COMPASS repository with worktrees: for advanced users
• Scripts
  • list_testcases.py
  • setup_testcase.py
  • clean_testcase.py
  • manage_regression_suite.py

Ocean

• Introduction
  • Setting config options for ocean test cases
• Ocean test cases
  • Global Ocean
  • Baroclinic Channel
  • ISOMIP+

Machine-specific instructions

• Slurm job queueing
• LANL Institutional Computing
  • grizzly, gnu
  • grizzly, intel 19 with scorpio
  • grizzly, intel 17 and pio 1
  • badger, gnu
  • Building Scorpio on Grizzly
• NERSC
  • cori, gnu
  • cori, intel
  • PIO on cori
  • Jupyter notebook on remote data
• Anvil/Blues
  • intel on anvil
  • SCORPIO on anvil
• Personal Linux/OSX Machine
  • Installation of MPAS dependencies including SCORPIO and the compass conda environment
  • Setup before compiling/running
• Personal OSX Machine
  • Installation of MPAS dependencies except PIO
  • PIO-1.9.23 installation with some modifications
  • MPAS-O installation

Developer's guide

• config
  • How to use pre-defined paths
  • Description of XML file
• driver_script
• template
• regression_suite
• run_config
  • Examples
• Building the Documentation

Versions

• Code and Documentation Versions