UFS Short-Range Weather App Users Guide

• 1. Introduction
  • 1.1. How to Use This Document
  • 1.2. Prerequisites for Using the SRW Application
    • 1.2.1. Background Knowledge Prerequisites
    • 1.2.2. Software/Operating System Requirements
  • 1.3. SRW App Components Overview
    • 1.3.1. Pre-Processor Utilities and Initial Conditions
    • 1.3.2. Forecast Model
    • 1.3.3. Unified Post-Processor (UPP)
    • 1.3.4. METplus Verification Suite
    • 1.3.5. Build System and Workflow
  • 1.4. Code Repositories and Directory Structure
    • 1.4.1. Hierarchical Repository Structure
    • 1.4.2. Directory Structure
    • 1.4.3. Experiment Directory Structure
  • 1.5. User Support, Documentation, and Contributions to Development
  • 1.6. Future Direction
• 2. Quick Start Guide
  • 2.1. Install the HPC-Stack
  • 2.2. Building and Running the UFS SRW Application
• 3. Container-Based Quick Start Guide
  • 3.1. Download the Container
    • 3.1.1. Prerequisites:
    • 3.1.2. Working in the Cloud or on HPC Systems
    • 3.1.3. Build the Container
    • 3.1.4. Allocate a Compute Node
    • 3.1.5. Start Up the Container
  • 3.2. Download and Stage the Data
  • 3.3. Generate the Forecast Experiment
    • 3.3.1. Activate the Regional Workflow
    • 3.3.2. Configure the Workflow
    • 3.3.3. Generate the Workflow
    • 3.3.4. Troubleshooting
  • 3.4. New Experiment
• 4. Building the SRW App
  • 4.1. Install the Prerequisite Software Stack
    • 4.1.1. Background
    • 4.1.2. Instructions
  • 4.2. Download the UFS SRW Application Code
  • 4.3. Check Out External Components
  • 4.4. Set Up the Environment and Build the Executables
    • 4.4.1. devbuild.sh Approach
    • 4.4.2. CMake Approach
    • 4.4.3. Additional Details for Building on MacOS or Generic Linux
  • 4.5. Run an Experiment
• 5. Running the SRW App
  • 5.1. Download and Stage the Data
  • 5.2. Grid Configuration
  • 5.3. Generate the Forecast Experiment
    • 5.3.1. Load the Conda/Python Environment for the Regional Workflow
    • 5.3.2. Set Experiment Configuration Parameters
    • 5.3.3. Generate the Regional Workflow
    • 5.3.4. Description of Workflow Tasks
  • 5.4. Run the Workflow
    • 5.4.1. Run the Workflow Using Rocoto
    • 5.4.2. Run the Workflow Using Stand-Alone Scripts
• 6. Tutorials
  • 6.1. Sample Forecast #1: Severe Weather Over Indianapolis
    • 6.1.1. Weather Summary
    • 6.1.2. Data
    • 6.1.3. Load the Regional Workflow
    • 6.1.4. Configuration
    • 6.1.5. Compare and Analyze Results
    • 6.1.6. Try It!
  • 6.2. Sample Forecast #2: Cold Air Damming
    • 6.2.1. Weather Summary
    • 6.2.2. Tutorial Content
  • 6.3. Sample Forecast #3: Southern Plains Winter Weather Event
    • 6.3.1. Weather Summary
    • 6.3.2. Tutorial Content
  • 6.4. Sample Forecast #4: Halloween Storm
    • 6.4.1. Weather Summary
    • 6.4.2. Tutorial Content
  • 6.5. Sample Forecast #5: Hurricane Barry
    • 6.5.1. Weather Summary
    • 6.5.2. Tutorial Content
• 7. Air Quality Modeling (SRW-AQM)
  • 7.1. Quick Start Guide (SRW-AQM)
    • 7.1.1. Download the Code
    • 7.1.2. Checkout Externals
    • 7.1.3. Build the SRW App with AQM
    • 7.1.4. Load the workflow_tools Environment
    • 7.1.5. Configure and Experiment
    • 7.1.6. Generate the Workflow
    • 7.1.7. Run the Workflow
  • 7.2. WE2E Test for AQM
  • 7.3. Additional Tasks for AQM
    • 7.3.1. Structure of SRW-AQM
    • 7.3.2. Pre-processing Tasks of SRW-AQM
    • 7.3.3. Post-processing Tasks of SRW-AQM
• 8. SRW Application Components
  • 8.1. Pre-processor Utilities and Initial Conditions
  • 8.2. Forecast Model
  • 8.3. Post Processor
  • 8.4. METplus Verification Suite
  • 8.5. Build System and Workflow
• 9. Input and Output Files
  • 9.1. Input Files
    • 9.1.1. Initial and Boundary Condition Files
    • 9.1.2. Pre-processing (UFS_UTILS)
    • 9.1.3. UFS Weather Model
    • 9.1.4. Unified Post Processor (UPP)
    • 9.1.5. Workflow
  • 9.2. Output Files
    • 9.2.1. Initial and boundary condition files
    • 9.2.2. Pre-processing (UFS_UTILS)
    • 9.2.3. UFS Weather Model
    • 9.2.4. Unified Post Processor (UPP)
  • 9.3. Downloading and Staging Input Data
    • 9.3.1. Static Files
    • 9.3.2. Initial Condition/Lateral Boundary Condition File Formats and Source
    • 9.3.3. Initial and Lateral Boundary Condition Organization
    • 9.3.4. Default Initial and Lateral Boundary Conditions
    • 9.3.5. Running the App for Different Dates
    • 9.3.6. Staging Initial Conditions Manually
    • 9.3.7. Coexistence of Multiple Files for the Same Date
    • 9.3.8. Best Practices for Conserving Disk Space and Keeping Files Safe
• 10. Limited Area Model (LAM) Grids: Predefined and User-Generated Options
  • 10.1. Predefined Grids
    • 10.1.1. Predefined 3-km CONUS Grid
    • 10.1.2. Predefined SUBCONUS Grid Over Indianapolis
    • 10.1.3. Predefined 13-km Grid
    • 10.1.4. Predefined 25-km Grid
  • 10.2. Creating User-Generated Grids
    • 10.2.1. Code Example
• 11. Workflow Parameters: Configuring the Workflow in config.yaml and config_defaults.yaml
  • 11.1. USER Configuration Parameters
  • 11.2. PLATFORM Configuration Parameters
    • 11.2.1. Machine-Dependent Parameters
    • 11.2.2. Parameters for Running Without a Workflow Manager
    • 11.2.3. METplus Parameters
    • 11.2.4. Test Directories
  • 11.3. WORKFLOW Configuration Parameters
    • 11.3.1. Cron-Associated Parameters
    • 11.3.2. Directory Parameters
    • 11.3.3. Pre-Processing File Separator Parameters
    • 11.3.4. Set File Name Parameters
    • 11.3.5. CCPP Parameter
    • 11.3.6. Grid Generation Parameters
    • 11.3.7. Forecast Parameters
    • 11.3.8. Pre-Existing Directory Parameter
    • 11.3.9. Verbose Parameter
    • 11.3.10. Debug Parameter
    • 11.3.11. Compiler
    • 11.3.12. Verification Parameters
  • 11.4. NCO-Specific Variables
  • 11.5. MAKE_GRID Configuration Parameters
    • 11.5.1. Basic Task Parameters
    • 11.5.2. ESGgrid Settings
    • 11.5.3. GFDLgrid Settings
  • 11.6. MAKE_OROG Configuration Parameters
  • 11.7. MAKE_SFC_CLIMO Configuration Parameters
  • 11.8. GET_EXTRN_ICS Configuration Parameters
    • 11.8.1. Basic Task Parameters
    • 11.8.2. File and Directory Parameters
    • 11.8.3. NOMADS Parameters
  • 11.9. GET_EXTRN_LBCS Configuration Parameters
    • 11.9.1. Basic Task Parameters
    • 11.9.2. File and Directory Parameters
    • 11.9.3. NOMADS Parameters
  • 11.10. MAKE_ICS Configuration Parameters
    • 11.10.1. Basic Task Parameters
    • 11.10.2. FVCOM Parameter
  • 11.11. MAKE_LBCS Configuration Parameters
  • 11.12. FORECAST Configuration Parameters
    • 11.12.1. Basic Task Parameters
    • 11.12.2. Model Configuration Parameters
    • 11.12.3. Computational Parameters
    • 11.12.4. Write-Component (Quilting) Parameters
    • 11.12.5. Predefined Grid Parameters
    • 11.12.6. Aerosol Climatology Parameter
    • 11.12.7. Fixed File Parameters
  • 11.13. RUN_POST Configuration Parameters
    • 11.13.1. Basic Task Parameters
    • 11.13.2. Subhourly Post Parameters
    • 11.13.3. Customized Post Configuration Parameters
  • 11.14. RUN_PRDGEN Configuration Parameters
    • 11.14.1. Basic Task Parameters
  • 11.15. PLOT_ALLVARS Configuration Parameters
  • 11.16. Global Configuration Parameters
    • 11.16.1. Community Radiative Transfer Model (CRTM) Parameters
    • 11.16.2. Ensemble Model Parameters
    • 11.16.3. Stochastic Physics Parameters
    • 11.16.4. Halo Blend Parameter
• 12. Rocoto Introductory Information
  • 12.1. rocotorun
  • 12.2. rocotostat
  • 12.3. rocotocheck
  • 12.4. rocotorewind
  • 12.5. rocotoboot
• 13. Defining an SRW App Workflow
  • 13.1. The Jinja2 Template
  • 13.2. The rocoto section of config.py
  • 13.3. The tasks Subsection
  • 13.4. Defining a Task
  • 13.5. Defining Dependencies
  • 13.6. Defining a Metatask
  • 13.7. SRW-Defined Jinja2 Filters Used by YAML Interface
  • 13.8. SRW-Defined PyYAML Constructors Used by YAML Interface
  • 13.9. Order of Precedence
• 14. Workflow End-to-End (WE2E) Tests
  • 14.1. Running the WE2E Tests
  • 14.2. Checking test status and summary
  • 14.3. WE2E Test Information File
  • 14.4. Modifying the WE2E System
    • 14.4.1. Modifying an Existing Test
    • 14.4.2. Adding a New Test
• 15. Template Variables
  • 15.1. Generic Example
  • 15.2. Graphics Plotting Example
• 16. Verification Sample Cases
  • 16.1. Introduction
  • 16.2. Prerequisites
  • 16.3. Indianapolis Severe Weather Case
    • 16.3.1. Description
    • 16.3.2. Set Up Verification
    • 16.3.3. Compare
• 17. FAQ
  • 17.1. How do I define an experiment name?
  • 17.2. How do I change the Physics Suite Definition File (SDF)?
  • 17.3. How do I change the grid?
  • 17.4. How do I turn on/off the cycle-independent workflow tasks?
  • 17.5. How do I restart a DEAD task?
  • 17.6. How can I clean up the SRW App code if something went wrong?
  • 17.7. How can I run a new experiment?
• 18. Glossary