Welcome to the UFS Weather Model User’s Guide

• 1. Introduction
• 2. Code Overview
  • 2.1. UFS Weather Model Hierarchical Repository Structure
  • 2.2. Directory Structure
• 3. Building and Running the UFS Weather Model
  • 3.1. Supported Platforms & Compilers
  • 3.2. Prerequisite Libraries
  • 3.3. Downloading the Weather Model Code
  • 3.4. Building the Weather Model
    • 3.4.1. Loading the Required Modules
    • 3.4.2. Setting the CMAKE_FLAGS and CCPP_SUITES Environment Variables
    • 3.4.3. Building the Model
  • 3.5. Running the Model
    • 3.5.1. Using the Regression Test Script
    • 3.5.2. Using the Operational Requirement Test Script
• 4. Data: Input, Model Configuration, and Output Files
  • 4.1. Input files
    • 4.1.1. ATM
    • 4.1.2. MOM6
    • 4.1.3. HYCOM
    • 4.1.4. CICE6
    • 4.1.5. WW3
    • 4.1.6. CDEPS
    • 4.1.7. GOCART
    • 4.1.8. AQM (CMAQ)
  • 4.2. Model configuration files
    • 4.2.1. diag_table file
    • 4.2.2. field_table file
    • 4.2.3. model_configure file
    • 4.2.4. nems.configure file
    • 4.2.5. The Suite Definition File (SDF) File
    • 4.2.6. datm.streams
    • 4.2.7. datm_in
    • 4.2.8. blkdat.input
    • 4.2.9. Namelist file input.nml
  • 4.3. Output files
    • 4.3.1. FV3Atm
    • 4.3.2. MOM6
    • 4.3.3. HYCOM
    • 4.3.4. CICE6
    • 4.3.5. WW3
    • 4.3.6. CMEPS
  • 4.4. Additional Information about the FMS Diagnostic Manager
    • 4.4.1. Diagnostic Manager Namelist
  • 4.5. Additional Information about the Write Component
• 5. Configuration Parameters
  • 5.1. Build Configuration Parameters
    • 5.1.1. Configuration Options
    • 5.1.2. Physics Options
    • 5.1.3. Other Build Options
• 6. Automated Testing
  • 6.1. CI/CD
  • 6.2. Auto RT
    • 6.2.1. AutoRT Workflow
• 7. FAQ
  • 7.1. How do I build and run a single test of the UFS Weather Model?
  • 7.2. How do I change the length of the model run?
  • 7.3. How do I select the file format for the model output (netCDF or NEMSIO)?
  • 7.4. How do I set the output history interval?
  • 7.5. How do I set the total number of tasks for my job?
• 8. Acronyms
• 9. Glossary