UFS Short-Range Weather (SRW) App Documentation (develop)

• User’s Guide
  • 1. Background Information
    • 1.1. Introduction
    • 1.2. Technical Overview
    • 1.3. SRW Application Components
  • 2. Building, Running, and Testing the SRW App
    • 2.1. Quick Start Guide
    • 2.2. Container-Based Quick Start Guide
    • 2.3. Building the SRW App
    • 2.4. Running the SRW App
    • 2.5. Testing the SRW App
    • 2.6. Tutorials
    • 2.7. METplus Verification Sample Cases
    • 2.8. Air Quality Modeling (SRW-AQM)
  • 3. Customizing the Workflow
    • 3.1. Workflow Parameters: Configuring the Workflow in config.yaml and config_defaults.yaml
    • 3.2. Input and Output Files
    • 3.3. Limited Area Model (LAM) Grids: Predefined and User-Generated Options
    • 3.4. Defining an SRW App Workflow
    • 3.5. Template Variables
  • 4. Reference
    • 4.1. Rocoto Introductory Information
    • 4.2. FAQ
    • 4.3. Glossary
• Technical Documentation
  • tests
    • WE2E
  • ush
    • UFS_plot_domains module
    • calculate_cost module
    • check_python_version module
    • config_utils module
    • create_aqm_rc_file module
    • create_diag_table_file module
    • create_model_configure_file module
    • create_ufs_configure_file module
    • generate_FV3LAM_wflow module
    • get_crontab_contents module
    • link_fix module
    • mrms_pull_topofhour module
    • python_utils package
    • retrieve_data module
    • run_srw_tests module
    • set_cycle_dates module
    • set_gridparams_ESGgrid module
    • set_gridparams_GFDLgrid module
    • set_predef_grid_params module
    • setup module
    • update_input_nml module
• Contributor’s Guide
  • Introduction
    • Background
  • Contributing to the SRW App
    • Fork and PR Overview
    • Development and Testing Process
    • Opening an Issue
    • Making a Pull Request
    • Merging
    • Need Help?
  • Code and Configuration Standards
    • General Policies
    • SRW Application Guidelines
  • Testing
    • Testing on Jenkins
  • Working with Git Submodules
    • What Are Git Submodules?
    • Key Benefits
    • How Submodules Are Linked
    • Adding a Submodule
    • Cloning a Repository with Submodules
    • Updating a Submodule
    • Switching Branches With Submodules
  • Documentation
    • Locally Building and Previewing Documentation
    • Viewing Online Documentation
    • Documentation Guidelines