Getting Started
For a guide to building and running the Short-Range Weather (SRW) Application, see the SRW App User's Guide.
This repository contains the model code and external links needed to build the UFS Short-Range Weather Application, which focuses on predictions of atmospheric behavior from less than an hour to several 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: https://github.com/ufs-community/ufs-weather-model/wiki
Before running the Short-Range Weather (SRW) Application, 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, Cheyenne). Levels 3 & 4 include some 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. Users can access the documentation for the SRW App version that they plan to run.
The UFS Short-Range Weather Application User's Guide has the most comprehensive information on the SRW App, including links to more thorough technical instructions.
Depending on what you are doing, you may need different versions of the Users Guide:
| Version | Description |
|---|---|
| Develop Branch/Latest | Documentation for the head of the development branch. This may have gaps and errors. |
| Release v2.1.0 | Documentation for the most recent release (v2.0.0). |
| Release v2.0.0 | Documentation for the v2.0.0 release. |
| Tag ufs-v1.0.1 | Documentation for the v1.0.1 release. |
| Tag ufs-v1.0.0 | Documentation for the v1.0.0 release. |
Users can also get expert help through a community forum.
A description of how to contribute, test and review code for the ufs-srweather-app repository can be found here. (Ctrl-click to open in a new tab or window.)