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. Test Configuration
    • 3.6.1. default_vars.sh
    • 3.6.2. Test Files
    • 3.6.3. Creating New Tests
    • 3.6.4. The rt.conf File
  • 3.7. Running the Model
    • 3.7.1. Using the Regression Test Script
    • 3.7.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. CICE6
    • 4.1.4. WW3
    • 4.1.5. CDEPS
    • 4.1.6. GOCART
    • 4.1.7. UFS AQM
    • 4.1.8. NOAH-MP (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. fd_ufs.yaml
    • 4.2.6. The Suite Definition File (SDF) File
    • 4.2.7. datm.streams
    • 4.2.8. datm_in
    • 4.2.9. Namelist file input.nml
  • 4.3. Output files
    • 4.3.1. UFSAtm
    • 4.3.2. MOM6
    • 4.3.3. CICE6
    • 4.3.4. WW3
    • 4.3.5. 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. Hierarchical System Development (HSD) Cases
  • 5.1. July 2020 CAPE Case
    • 5.1.1. Obtaining Data for the July 2020 CAPE Case
    • 5.1.2. Running the July 2020 CAPE Case
  • 5.2. Baroclinic Instability Case
    • 5.2.1. Obtaining Data for HSD Cases
    • 5.2.2. Running the Baroclinic Wave Case
  • 5.3. Idealized, Regional Tropical Cyclone Case
    • 5.3.1. Obtaining Data for HSD Cases
    • 5.3.2. Running the Idealized Tropical Cyclone Test Case
  • 5.4. Aquaplanet Test Case
    • 5.4.1. Obtaining Data for HSD Cases
    • 5.4.2. Running the Aquaplanet Case
    • 5.4.3. Plotting Script
    • 5.4.4. Advanced: Setting Up the Aquaplanet Experiment from Scratch
  • 5.5. General Guidelines for Adding a Test Case to the UFS HSD Framework
    • 5.5.1. General Steps to Add a Test Case
    • 5.5.2. Model Compile Options
    • 5.5.3. Physics
    • 5.5.4. Input Data
    • 5.5.5. Configuration Files
    • 5.5.6. Fix Files
    • 5.5.7. Running the Test Case
  • 5.6. Running UFS WM Idealized Cases in a Container
    • 5.6.1. Prerequisites
    • 5.6.2. Build the Container
    • 5.6.3. Get Data
    • 5.6.4. Run the Container
• 6. Technical Documentation for tests-dev
  • 6.1. create_log module
    • finish_log()
    • get_timestamps()
  • 6.2. create_xml module
    • make_loghead()
    • rocoto_create_compile_task()
    • rocoto_create_entries()
    • write_compile_env()
    • write_metatask_begin()
    • write_metatask_end()
    • write_runtest_env()
    • xml_loop()
  • 6.3. ufs_test_utils module
    • create_yaml()
    • delete_files()
    • get_testcase()
    • get_testdep()
    • link_new_baselines()
    • machine_check_off()
    • parse_line()
    • rrmdir()
    • string_clean()
    • sync_testscripts()
    • update_testyaml()
    • update_testyaml_b()
    • update_testyaml_n()
    • write_logfile()
• 7. Configuration Parameters
  • 7.1. Build Configuration Parameters
    • 7.1.1. Configuration Options
    • 7.1.2. Physics Options
    • 7.1.3. Other Build Options
• 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. UFSATM
    • 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 get the UFS WM to output physics tendencies?
  • 8.7. How can I output a particular variable (e.g., accumulated precipitation) from the UFS WM atmospheric model (FV3)?
  • 8.8. Where can I find up-to-date documentation for the diag_table variables used in the UFS Weather Model?
  • 8.9. Where can I find more information about previous public releases of the UFS Weather Model?
  • 8.10. What is the most recent public release of the UFS Weather Model? What has been updated in the release?
• 9. Acronyms
• 10. Glossary