2. User Guide

Important

The driver, the run-configuration file, and the run sequence file are host-specific. Where applicable, differences between CESM/NorESM and UFS are called out in host-specific sections.

The mediator itself is shared across applications, so the Overview and Developer Guide are not host-specific.

A coupled run is driven by two key inputs that the NUOPC driver ingests at start-up:

• the run sequence — the ordered recipe of component runs, mediator phases and field transfers, together with the coupling intervals (The run sequence); and

• the run configuration — the ESMF attributes the driver reads at initialization and makes available to the mediator and the other components (NUOPC attributes (CESM/NorESM)).

The pages below describe each of these two inputs in turn, and then show how CESM/NorESM and UFS cases are configured to produce them.

• 2.1. The run sequence
  • 2.1.1. Anatomy of a run sequence
  • 2.1.2. A worked example
• 2.2. NUOPC attributes (CESM/NorESM)
  • 2.2.1. Attributes the mediator queries
• 2.3. NUOPC attributes (UFS)
• 2.4. Configuring and running a case (CESM/NorESM)
  • 2.4.1. Where settings live: xml versus user_nl_cpl
  • 2.4.2. Setting the coupling intervals
  • 2.4.3. Controlling the mediator through user_nl_cpl
  • 2.4.4. How it fits together
  • 2.4.5. Branch runs and the coupler restart pointer
• 2.5. Configuring and running a case (UFS)
• 2.6. Fields and the field dictionary
  • 2.6.1. The field dictionary
  • 2.6.2. The naming convention
  • 2.6.3. Where you encounter field names
  • 2.6.4. Adding a new field