Skip to content

Commit

Permalink
[release/public-v2] Penultimate documentation edits (#282)
Browse files Browse the repository at this point in the history
* update hpc-stack module docs & MacOS config.sh

* update machine file instructions

* updates to BuildRun chapter

* fix typo

* merge changes from PR #240 to release-v2

* resolve conflicts w/PR #281

* I/O updates to wget commands

* Update documentation for CSV file containing WE2E test info (#278)

* Edits to documentation to match latest in code.

* Edits to documentation to match latest in code.

* Minor changes to documentation.

* update HPSS file names

* add links, remove comments

* add links, remove comments

* FAQ updates

* ContribGuide updates

* Rocoto ch updates

* update wflow gen image

* update LAM grid chapter

* update docs links

* update NC QS

* glossary updates

* add Stochastic Physics info

* format valid values

* edits for Config Params

* final Config Param updates

* Graphics edits

* remove WCOSS info

* Intro updates pt1

* Docs for Linux SRW build and run

* Remove WCOSS-specifics

* miscellaneous changes

* Intro & QS updates

* minor fixes

* I/O updates

* I/O updates

* update RW hash

* update file paths to NaturalEarth

* change ESFM docs version

* change ESFM docs version

* finish I/O updates

* update paths from develop to v2p0

* Update BuildRunSRW.rst

"wcoss_dell_p3" is a valid value

* Update ConfigWorkflow.rst

placed "WCOSS_DELL_P3" as a valid value

* updates to WE2E

* WE2E updates

* final WE2E updates

* update METplus support info

* update NC-QS Guide

* QS updates

* fix WE2E tables

* add WE2E test files

* WE2E test edits

* WE2E table updates

* QS & updates to config_defaults table in build/run

* QS modulefiles load

* fix typo

* update mac/linux section of build/run

* fix image

* fix image

* typo

* update CCPP link

* adjust Mac/Linux organization

* mark's edits pt1

* mac/linux reorg

* minor edits

Co-authored-by: gspetro <[email protected]>
Co-authored-by: Will Mayfield <[email protected]>
Co-authored-by: Natalie Perlin <[email protected]>
Co-authored-by: gsketefian <[email protected]>
Co-authored-by: Natalie Perlin <[email protected]>
  • Loading branch information
6 people authored Jun 21, 2022
1 parent b1c913c commit 5a062db
Show file tree
Hide file tree
Showing 21 changed files with 2,149 additions and 1,339 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

The Unified Forecast System (UFS) is a community-based, coupled, comprehensive Earth modeling system. It is designed to be the source system for NOAA’s operational numerical weather prediction applications while enabling research, development, and contribution opportunities for the broader weather enterprise. For more information about the UFS, visit the UFS Portal at https://ufscommunity.org/.

The UFS includes multiple applications (see a complete list at https://ufscommunity.org/science/aboutapps/) that support different forecast durations and spatial domains. This documentation describes the UFS Short-Range Weather (SRW) Application, which targets predictions of atmospheric behavior on a limited spatial domain and on time scales from minutes to several days. The development branch of the application is continually evolving as the system undergoes open development. The SRW App release branches represent a snapshot of this continuously evolving system. The SRW Application includes a prognostic atmospheric model, pre- and post-processing, and a community workflow for running the system end-to-end. These components are documented within the User's Guide and supported through a community forum (https://forums.ufscommunity.org/).
The UFS includes multiple applications (see a complete list at https://ufscommunity.org/science/aboutapps/) that support different forecast durations and spatial domains. This documentation describes the UFS Short-Range Weather (SRW) Application release v2.0.0, which targets predictions of atmospheric behavior on a limited spatial domain and on time scales from minutes to several days. The development branch of the application is continually evolving as the system undergoes open development. The SRW App v2.0.0 represents a snapshot of this continuously evolving system.

The UFS SRW App User's Guide associated with the development branch can be found at: https://ufs-srweather-app.readthedocs.io/en/develop/, while the guide specific to the SRW App v2.0.0 release can be found at: https://srw-users-guide.readthedocs.io/en/release-public-v2/. The GitHub repository link is: https://github.com/ufs-community/ufs-srweather-app.
The SRW Application v2.0.0 includes a prognostic atmospheric model, pre- and post-processing, and a community workflow for running the system end-to-end. These components are documented within this User's Guide and supported through a community forum (https://forums.ufscommunity.org/). New and improved capabilities for this release include the addition of a verification package (METplus) for both deterministic and ensemble simulations and support for four Stochastically Perturbed Perturbation (SPP) schemes. Future work will expand the capabilities of the application to include data assimilation (DA) and a forecast restart/cycling capability.

The UFS SRW App User's Guide associated with the development branch is at: https://ufs-srweather-app.readthedocs.io/en/develop/, while the guide specific to the SRW App v2.0.0 release can be found at: https://ufs-srweather-app.readthedocs.io/en/release-public-v2/. The repository is at: https://github.com/ufs-community/ufs-srweather-app.

For instructions on how to clone the repository, build the code, and run the workflow, see:
https://github.com/ufs-community/ufs-srweather-app/wiki/Getting-Started
Expand Down
933 changes: 518 additions & 415 deletions docs/UsersGuide/source/BuildRunSRW.rst

Large diffs are not rendered by default.

28 changes: 0 additions & 28 deletions docs/UsersGuide/source/CompleteTests.csv

This file was deleted.

Loading

0 comments on commit 5a062db

Please sign in to comment.