Welcome to CEFI-regional-MOM6’s documentation!

CEFI-regional-MOM6 contains essential tools, XML files, and source codes for collaborators of the Climate, Ecosystems, and Fisheries Initiative (CEFI) to conduct ocean physical-biogeochemical simulations for climate-scale applications, including seasonal predictions (12 months), decadal predictions (10 years), and multi-decadal projections (to the end of the 21st century).

Code managers

• Yi-Cheng Teng - @yichengt900 / yi-cheng.teng@noaa.gov

Contents:

• 1. Introduction
  • 1.1. Disclaimer
  • 1.2. References
• 2. Build the MOM6-SIS2-COBALT
  • 2.1. Install the Prerequisite Softwares
  • 2.2. Download the CEFI-regional-MOM6 Code
  • 2.3. Set Up the Environment and Build the Executables
  • 2.4. Run an Experiment
• 3. Container-Based Quick Start Guide
  • 3.1. Prerequisites
    • 3.1.1. Install Docker on Windows/macOS
    • 3.1.2. Install Singularity/Apptainer
  • 3.2. Build and run 1-D example using Docker
  • 3.3. Build and run 1-D example using Singularity/Apptainer container
• 4. Data: Input, Model Configuration, and Output Files
  • 4.1. Input files
    • 4.1.1. Static Datasets (i.e., fix files)
    • 4.1.2. Grid Description files
    • 4.1.3. Time-dependent files
    • 4.1.4. Model_configure files
  • 4.2. Outputs
    • 4.2.1. Title Section
    • 4.2.2. File Section
    • 4.2.3. Field Section
    • 4.2.4. Parameter Files
• 5. Run the MOM6-COBALT-NWA12 example
  • 5.1. MOM6-COBALT-NWA12 v1.0 example
  • 5.2. Download the model input dataset
  • 5.3. Run NWA12 Experiment
• 6. Analysis output
  • 6.1. Prerequisite
  • 6.2. Diagnostics for Physical Components
  • 6.3. Diagnostics for Biogeochemical Components
• 7. API Reference
  • 7.1. Modules
    • 7.1.1. fms_coupler_util module reference
    • 7.1.2. g_tracer_utils module reference
    • 7.1.3. generic_cobalt module reference
    • 7.1.4. generic_tracer module reference
    • 7.1.5. mom_generic_tracer module reference
    • 7.1.6. mom_tracer_flow_control module reference
    • 7.1.7. MOM_tracer_flow_control module reference
    • 7.1.8. mom_tracer_registry module reference
    • 7.1.9. mom_tracer_types module reference
    • 7.1.10. mom_tracer_z_init module reference