Welcome to the UFS Weather Model User’s Guide

• 1. Introduction
• 2. Technical Overview
  • 2.1. Supported Platforms and Compilers for Running the UFS Weather Model
    • 2.1.1. Level 1 Systems
    • 2.1.2. Level 2-4 Systems
  • 2.2. UFS Weather Model Hierarchical Repository Structure
  • 2.3. Directory Structure
• 3. Building and Running the UFS Weather Model
  • 3.1. Supported Platforms & Compilers
  • 3.2. Prerequisite Libraries
    • 3.2.1. Common Modules
  • 3.3. Get Data
  • 3.4. Downloading the Weather Model Code
  • 3.5. Building the Weather Model
    • 3.5.1. Loading the Required Modules
    • 3.5.2. Setting the CMAKE_FLAGS and CCPP_SUITES Environment Variables
    • 3.5.3. Building the Model
  • 3.6. Running the Model
    • 3.6.1. Using the Regression Test Script
    • 3.6.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.1.9. LND
  • 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. ufs.configure file
    • 4.2.5. The Suite Definition File (SDF)
    • 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. Configurations
  • 5.1. Background
  • 5.2. Atmospheric Model Configurations
    • 5.2.1. ATM - Standalone Atmospheric Model
    • 5.2.2. ATMW
    • 5.2.3. ATMAERO
    • 5.2.4. ATMAQ
    • 5.2.5. ATML
  • 5.3. Rapid Refresh Forecast System (RRFS)
  • 5.4. LND
  • 5.5. Seasonal to Subseasonal (S2S) Configurations
  • 5.6. NG-GODAS
  • 5.7. Hurricane Analysis and Reforecast System Configurations
• 6. Configuration Parameters
  • 6.1. Build Configuration Parameters
    • 6.1.1. Configuration Options
    • 6.1.2. Physics Options
    • 6.1.3. Other Build Options
• 7. Automated Testing
  • 7.1. CI/CD
  • 7.2. Auto RT
    • 7.2.1. AutoRT Workflow
• 8. FAQ
  • 8.1. How do I build and run a single test of the UFS Weather Model?
  • 8.2. How do I change the length of the model run?
  • 8.3. How do I set the output history interval?
  • 8.4. How do I turn off IO for the components of the coupled model?
    • 8.4.1. FV3atm restart and history files
    • 8.4.2. MOM6, CICE6 and CMEPS restart files
    • 8.4.3. MOM6 history files
    • 8.4.4. CICE history files
    • 8.4.5. GOCART history files
    • 8.4.6. WW3 history and restart files
  • 8.5. How do I set the total number of tasks for my job?
    • 8.5.1. FV3atm
    • 8.5.2. GOCART
    • 8.5.3. CMEPS
    • 8.5.4. MOM6
    • 8.5.5. CICE
    • 8.5.6. WW3
    • 8.5.7. Example: 5-component ufs.configure
  • 8.6. How can I run with the same physics as the operational GFS/HAFS/etc.?
• 9. Acronyms
• 10. Glossary