Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release/public-v2.1.0] Documentation Updates #483

Merged
merged 68 commits into from
Nov 17, 2022
Merged
Show file tree
Hide file tree
Changes from 66 commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
ff24b5f
update some links/version references; add list of v2.1.0 features
gspetro Nov 3, 2022
0a9f221
add citation
gspetro Nov 3, 2022
5c2e68b
add not re: spack-stack support
gspetro Nov 3, 2022
17a2ecf
update most links for release
gspetro Nov 7, 2022
4abea1c
edit Glossary
gspetro Nov 8, 2022
75e8082
document devclean, update FAQ
gspetro Nov 8, 2022
5d25612
change config.sh to .yaml
gspetro Nov 8, 2022
3b80683
reorder FAQ
gspetro Nov 8, 2022
ea7bb29
FAQ updates
gspetro Nov 8, 2022
08ccde5
FAQ updates
gspetro Nov 8, 2022
f65c814
Rocoto Ch edits
gspetro Nov 8, 2022
138db9f
Quickstart edits
gspetro Nov 9, 2022
64cea29
add table label/Xlink
gspetro Nov 9, 2022
0b048cc
update FAQ cycle-ind tasks
gspetro Nov 9, 2022
f993a37
fix code-block format
gspetro Nov 9, 2022
d398b0b
update WM links
gspetro Nov 9, 2022
e660a9e
Graphics, I/O updates, other minor
gspetro Nov 9, 2022
c255f98
minor updates to Graphics & Intro
gspetro Nov 10, 2022
798a2a3
minor intro fixes
gspetro Nov 10, 2022
720beb6
QS updates
gspetro Nov 10, 2022
a0f2635
misc minor edits
gspetro Nov 11, 2022
37faacb
edits to FV3LAM
gspetro Nov 11, 2022
f02e89c
Update user-defined grid example & some config params
gspetro Nov 14, 2022
934ac9d
update components ch and version #'s throughout
gspetro Nov 14, 2022
497af68
update container name, minor I/O updates
gspetro Nov 14, 2022
17400bb
minor container updates
gspetro Nov 14, 2022
3dcf2ac
several minor fixes
gspetro Nov 14, 2022
21bec9c
update I/O input path image
gspetro Nov 14, 2022
afb9635
update I/O input path image
gspetro Nov 14, 2022
05e228f
I/O updates esp for UPP
gspetro Nov 15, 2022
27a2fb5
edits for loading graphics env
gspetro Nov 15, 2022
3ab716b
graphics env changes; I/O python syntax update
gspetro Nov 15, 2022
56ce2bf
I/O & graphics updates
gspetro Nov 15, 2022
6350a9d
Documentation updates for Mac and Linux
natalie-perlin Nov 15, 2022
ea270eb
misc updates
gspetro Nov 15, 2022
b7b2512
add draft of CCPP updates
gspetro Nov 15, 2022
dc92c0c
misc updates
gspetro Nov 16, 2022
a71d8ad
Merge branch 'ufs-community:release/public-v2.1.0' into release/publi…
gspetro-NOAA Nov 16, 2022
3dc5559
Merge branch 'release/public-v2.1.0' of github.com:gspetro-NOAA/ufs-s…
gspetro Nov 16, 2022
9f732bb
misc updates
gspetro Nov 16, 2022
3485ec7
rm old img
gspetro Nov 16, 2022
9577cbb
add updated img
gspetro Nov 16, 2022
931bd35
fix img
gspetro Nov 16, 2022
69c399c
fix img
gspetro Nov 16, 2022
a7afdea
minor updates to WE2E & CCPP note
gspetro Nov 16, 2022
573d2cf
readme edits
gspetro Nov 16, 2022
a9e7438
update readme & intro
gspetro Nov 16, 2022
2fd90c7
add predefined vs custom grid note
gspetro Nov 16, 2022
85101e5
add wrapper commands, LAM custom grid notes, remove comments throughout
gspetro Nov 16, 2022
fba6876
add note to manual/wrapper run section
gspetro Nov 16, 2022
6fcd990
Update BuildSRW.rst
natalie-perlin Nov 16, 2022
e63c83d
Update RunSRW.rst
natalie-perlin Nov 16, 2022
d50d1f2
add hpc-stack doc link; other minor updates
gspetro Nov 16, 2022
077d0bd
update links & remove comments
gspetro Nov 16, 2022
7d26c2f
Merge pull request #1 from natalie-perlin/srw-v2.1-docs
gspetro-NOAA Nov 16, 2022
e532ef5
minor edits to build/run
gspetro Nov 16, 2022
52c0b93
BuildSRW edits
gspetro Nov 16, 2022
cb415a8
BuildSRW updates
gspetro Nov 16, 2022
f74e435
BuildSRW updates
gspetro Nov 16, 2022
dea63cc
Added documentation notes for generic Linux
Nov 16, 2022
8f6fa7b
Formatting corrections
Nov 16, 2022
694727b
final I/O edits, RunSRW
gspetro Nov 16, 2022
f4a14e1
Merge branch 'release/public-v2.1.0' into srw-v2.1-docs
gspetro-NOAA Nov 16, 2022
ff352bb
Merge pull request #2 from natalie-perlin/srw-v2.1-docs
gspetro-NOAA Nov 16, 2022
bbd3e59
final Build/Run edits for mac/linux
gspetro Nov 17, 2022
7f9f2ba
minor corrections
gspetro Nov 17, 2022
62b8b8e
remove Contributor's Guide
gspetro Nov 17, 2022
919f924
fix */ for cron
gspetro Nov 17, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
# UFS Short-Range Weather Application

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 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 development branch of 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 latest SRW App release (v2.0.0) represents a snapshot of this continuously evolving system.
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 v2.1.0 release branch of 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 latest SRW App release (v2.1.0) represents a snapshot of this continuously evolving system.

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.
This v2.1.0 release includes:

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
* Bug fixes since the v2.0.0 release
* Conversion to a Python workflow (from the former shell workflow)
* Improved container support, including the option to run across compute nodes using Rocoto
* Updates to CCPP that target the top of the `main` branch (which is ahead of CCPP v6.0.0).
* Support for the UPP inline post option
* Addition of a multi-purpose code clean-up script (`devclean.sh`)
* Documentation updates to reflect the changes above

UFS Development Team. (2022, June 23). Unified Forecast System (UFS) Short-Range Weather (SRW) Application (Version v2.0.0). Zenodo. https://doi.org/10.5281/zenodo.6505854
Future work will expand the capabilities of the application to include data assimilation (DA) and a forecast restart/cycling capability.

For instructions on how to clone the repository, build the code, and run the workflow, view the instructions in the SRW App User's Guide. The UFS SRW App User's Guide specific to the SRW App v2.1.0 release can be found at: https://ufs-srweather-app.readthedocs.io/en/release-public-v2.1.0/, while the documentation for the development branch is at: https://ufs-srweather-app.readthedocs.io/en/develop/. The repository is at: https://github.com/ufs-community/ufs-srweather-app.

The SRW App v2.1.0 citation is as follows and should be used when presenting results based on research conducted with the App:

UFS Development Team. (2022, Nov. 17). Unified Forecast System (UFS) Short-Range Weather (SRW) Application (Version v2.1.0). Zenodo. https://doi.org/10.5281/zenodo.7277602

[![Python unittests](https://github.com/ufs-community/ufs-srweather-app/actions/workflows/python_unittests.yaml/badge.svg)](https://github.com/ufs-community/ufs-srweather-app/actions/workflows/python_unittests.yaml)
[![Python functional tests](https://github.com/ufs-community/ufs-srweather-app/actions/workflows/python_func_tests.yaml/badge.svg)](https://github.com/ufs-community/ufs-srweather-app/actions/workflows/python_func_tests.yaml)
Expand Down
Loading