CMEPS documentation

The Community Mediator for Earth Prediction Systems (CMEPS) is a NUOPC-compliant mediator used to couple the components of an Earth system model. It is used by, among others, NCAR’s Community Earth System Model (CESM), NorESM, and NOAA’s UFS and HAFS coupled systems.

This documentation is organized into four parts:

• Overview & Concepts introduces what the mediator does and the ideas the rest of the documentation relies on. Start here.

• User Guide is for people configuring and running a coupled system that uses CMEPS. It is specific to CESM and NorESM; other applications (e.g. UFS, HAFS) provide their own user documentation.

• Developer Guide is for people modifying the mediator: its code structure, coupling phases, and how fields are exchanged, mapped and merged.

• Reference collects field-name and attribute tables and a glossary.

• 1. Overview & Concepts
  • 1.1. What is CMEPS?
  • 1.2. Core concepts
  • 1.3. Coupling architecture at a glance
• 2. User Guide
  • 2.1. The run sequence
  • 2.2. NUOPC attributes (CESM/NorESM)
  • 2.3. NUOPC attributes (UFS)
  • 2.4. Configuring and running a case (CESM/NorESM)
  • 2.5. Configuring and running a case (UFS)
  • 2.6. Fields and the field dictionary
• 3. Developer Guide
  • 3.1. Code organization
  • 3.2. Field exchange
  • 3.3. Conservation, area corrections and accumulation
  • 3.4. The phase lifecycle
  • 3.5. Mapping
  • 3.6. Merging
  • 3.7. Surface fractions
  • 3.8. Atmosphere/ocean fluxes
  • 3.9. Ocean albedo
  • 3.10. Water and energy budgets
  • 3.11. History output
  • 3.12. Restarts
  • 3.13. Adding a coupled field
• 4. Reference
  • 4.1. Field names
  • 4.2. Application-independent attributes
  • 4.3. CESM and NorESM attributes
  • 4.4. Glossary