Home - ufs-community/ufs-srweather-app GitHub Wiki
Welcome to the UFS Short-Range Weather (SRW) Application Wiki!
See the SRW App v2.2.0 release page for information on the most recent SRW App release, which took place on October 31, 2023. It corresponds to the ufs-srw-v2.2.0 tag (e2ea410) of the release/public-v2.2.0 branch. For a guide to building and running the SRW App v2.2.0, view the SRW App v2.2.0 User's Guide. Visit the NOAA EPIC website for more information about the release.
This repository contains the model code and external links needed to build the UFS Short-Range Weather(SRW) Application, which focuses on predictions of atmospheric behavior from less than an hour to about two days. The application includes a user-friendly workflow, with pre-processing (preparation of inputs), a forecast model, and post-processing. The forecast model used in this application is the UFS Weather Model.
This wiki includes a Getting Started section below with recommendations for new users. It also includes information for developers on code management procedures and contributions to the SRW App.
Contact Us
- Lead Code Manager: Michael Lueken ([email protected])
- User Support: Gillian Petro (post questions under Discussions or email [email protected])
Getting Started
Before running the SRW App, users should determine which of the four levels of support is applicable to their system. Generally, Level 1 & 2 systems are restricted to those with access through NOAA and its affiliates. These systems are named (e.g., Hera, Orion, Derecho). Level 3 & 4 systems include certain personal computers or non-NOAA-affiliated HPC systems.
The Quick Start Chapter provided in the User's Guide is an excellent place for new users to begin. It provides details on how to clone the SRW App, build it, and run a forecast.
Documentation and User Support
The SRW App User's Guide has the most comprehensive information on the SRW App, including links to more thorough technical documentation for its components. Users may need different versions of the User's Guide depending on their goals:
| Version | Description |
|---|---|
| Develop Branch | Documentation for the head of the development branch. This may have gaps and errors. |
| Release v2.2.0 | Documentation for the most recent release (v2.2.0). |
| Release v2.1.0 | Documentation for the v2.1.0 release. |
| Release v2.0.0 | Documentation for the v2.0.0 release (no longer supported). |
| Release v1.0.1 | Documentation for the v1.0.1 release (no longer supported). |
| Release v1.0.0 | Documentation for the v1.0.0 release (no longer supported). |
Users can also get expert help through the UFS Community Forums.
Information for Code Developers and Reviewers
- The SRW App Hierarchical Repository Structure page provides information on the SRW App structure, its submodules, and points of contact for each.
- The Code Contributor's Guide describes how to contribute and test code for the
ufs-srweather-apprepository. Among other topics, it includes:- A chapter on Working with Git Submodules
- An overview of the PR process
- A documentation chapter that outlines processes and expectations regarding SRW App documentation.
- The Code Manager's Guide provides information on how to review pull requests (PRs).
- Developers wanting to move development from forks of the old
regional_workflowrepository can find information on this page.
Releases
The latest public release of the SRW App is v2.2.0. See the Releases page for more information on current and past releases.