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] Penultimate documentation edits #282

Merged
merged 283 commits into from
Jun 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
283 commits
Select commit Hold shift + click to select a range
77d565d
QS updates
gspetro Feb 25, 2022
2e1a03f
updates to InputOutput and QS
gspetro Feb 25, 2022
80519d4
fix I/O doc typos
gspetro Feb 25, 2022
6f11030
pull updates to hpc-stack docs
gspetro Feb 28, 2022
999a417
pull updates to hpc-stack docs
gspetro Mar 1, 2022
f07fe8a
fix table wrapping
gspetro Mar 1, 2022
14db051
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Mar 3, 2022
b58d661
updates to QS for cloud
gspetro Mar 3, 2022
301ff5f
Merge branch 'develop' of github.com:gspetro-NOAA/ufs-srweather-app i…
gspetro Mar 3, 2022
0b50e04
fix QS export statements
gspetro Mar 3, 2022
8786b32
fix QS export statements
gspetro Mar 3, 2022
3a442d6
QS edits on bind, config
gspetro Mar 3, 2022
0cae160
add bullet points to notes
gspetro Mar 4, 2022
27247a5
running without rocoto
gspetro Mar 4, 2022
805bb81
add HPC-Stack submodule w/docs
gspetro Mar 4, 2022
29cf292
split QS into container/non-container approaches
gspetro Mar 8, 2022
3e30098
added filepath changes for running in container on Orion, et al.
gspetro Mar 9, 2022
53807fa
edits to overview and container QS
gspetro Mar 10, 2022
93bfe9b
moved CodeReposAndDirs.rst info to the Introduction & deleted file
gspetro Mar 11, 2022
eb00397
continued edits to SRWAppOverview
gspetro Mar 11, 2022
f4d2043
combine overview w/non-container docs
gspetro Mar 15, 2022
d1addf8
finish merging non-container guide & SRWOverview, rename/remove files…
gspetro Mar 16, 2022
fc1a1d4
minor edits for Intro & QS
gspetro Mar 17, 2022
acb77c8
updates to BuildRun doc through 3.8.1
gspetro Mar 17, 2022
70a051b
edits to Build/Run and Components
gspetro Mar 17, 2022
99127e7
remove .gitignore
gspetro Mar 18, 2022
b01268d
fix Ch 3 title, 4 supported platform levels note
gspetro Mar 18, 2022
da35184
fix typos, add term links
gspetro Mar 18, 2022
1302868
other minor fixes/suggestions implemented
gspetro Mar 18, 2022
a704a2f
updated Intro based on feedback; changed SRW to SRW App throughout
gspetro Mar 21, 2022
7fc263d
update comment to Intro citation
gspetro Mar 21, 2022
496fcb3
Merge branch 'develop' into develop
gspetro-NOAA Mar 22, 2022
10de71f
add user-defined vertical levels to future work
gspetro Mar 22, 2022
16b0c1a
Merge branch 'develop' of github.com:gspetro-NOAA/ufs-srweather-app i…
gspetro Mar 22, 2022
e294020
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Mar 23, 2022
92bddca
Add instructions for srw_common module load
gspetro Mar 23, 2022
698613b
Pull changes from upstream
gspetro Mar 23, 2022
6fa5074
fix typo
gspetro Mar 23, 2022
a5ae76e
update Intro & BuildRunSRW based on Mark's feedback
gspetro Mar 23, 2022
ea17b19
minor intro updates
gspetro Mar 23, 2022
1aa9322
1st round of jwolff's edits
gspetro Mar 25, 2022
3d1cddb
2nd round of jwolff updates
gspetro Mar 28, 2022
173b838
update QS intro
gspetro Mar 29, 2022
09581c8
fix minor physics details
gspetro Mar 29, 2022
a714d43
update citation and physics suite name
gspetro Mar 29, 2022
4757b40
add compute node allocation info to QS
gspetro Mar 29, 2022
2c68823
add authoritative hpc-stack docs to Intro
gspetro Mar 29, 2022
a9702bb
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Mar 30, 2022
5cb4c2c
edit config intro & platform environment sections
gspetro Mar 30, 2022
96123bb
Merge remote-tracking branch 'origin/develop' into textonly/config
gspetro Mar 30, 2022
0f3598f
edit sections on cron & directory parameters, platform & parameters f…
gspetro Mar 30, 2022
4a53366
edit NCO, file-separator, filename params, add some METplus and model…
gspetro Mar 31, 2022
c425bc5
ConfigWorkflow.rst revisions, added METplus to Components, grid info
gspetro Apr 1, 2022
f596267
add grid config details
gspetro Apr 4, 2022
fb0bc01
changes to readme.md
gspetro Apr 6, 2022
8bb70b1
RTD readme.md edits
gspetro Apr 6, 2022
9d9e079
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Apr 6, 2022
091574a
create MacOS install/build instructions
gspetro Apr 6, 2022
a5fced9
Merge branch 'develop' of github.com:gspetro-NOAA/ufs-srweather-app i…
gspetro Apr 7, 2022
a73c456
update task run and grid parameters
gspetro Apr 8, 2022
ab13f55
fixed file params & workflow task params
gspetro Apr 8, 2022
1335a4d
1st draft of ConfigParameters.inc
gspetro Apr 12, 2022
19a91cc
Merge branch 'ufs-community:develop' into textonly/config
gspetro-NOAA Apr 12, 2022
563fd8b
minor edits
gspetro Apr 12, 2022
e77110d
Merge branch 'develop' into textonly/config
gspetro Apr 12, 2022
9518b2f
Merge branch 'textonly/config' of github.com:gspetro-NOAA/ufs-srweath…
gspetro Apr 12, 2022
07f4d6e
add stochastic physics var details
gspetro Apr 12, 2022
3070272
update FVCOM, thread affinity params
gspetro Apr 13, 2022
63d2a86
halo_blend, ens, crtm, custom post, subhourly updates
gspetro Apr 13, 2022
7dcb3e7
update HPC-Stack submodule/docs
gspetro Apr 13, 2022
cf0dab0
Merge branch 'develop' into textonly/config
gspetro Apr 13, 2022
0763542
remove extra macinstall document
gspetro Apr 13, 2022
2b4d74e
Rocoto WF tasks & params
gspetro Apr 13, 2022
ef234d9
workflow tasks/params, debug, verbose, pre-existing dir, predefined grid
gspetro Apr 14, 2022
7de4653
move Stochastic physics to CCP section; write component edits
gspetro Apr 14, 2022
a552b00
comp'l forecast, grid gen, NOMADS, user-staged files
gspetro Apr 14, 2022
d8d217b
METplus, model config & forecast params, separator
gspetro Apr 15, 2022
43ecc81
2nd draft complete
gspetro Apr 15, 2022
a51165f
physics updates
gspetro Apr 15, 2022
928417a
remove MacInstall empty file
gspetro Apr 15, 2022
a1ad723
undo hpc-stack submodule update (save for separate PR)
gspetro Apr 15, 2022
9241039
undo hpc-stack install doc update (save for separate PR)
gspetro Apr 15, 2022
580f641
revert hpc-stack submodule update
gspetro Apr 15, 2022
b9d8087
revisions to SPP & LSM physics
gspetro Apr 19, 2022
987abbd
minor edits
gspetro Apr 19, 2022
aaacfe7
update comments in LAM Grid chapter
gspetro Apr 20, 2022
2956ffc
update LSM_SPP_EACH_STEP
gspetro Apr 20, 2022
4939629
revert LSM_SPP_EACH_STEP to original definition
gspetro Apr 26, 2022
c28b32c
combine config info into one doc instead of two
gspetro Apr 26, 2022
ab2fb78
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Apr 26, 2022
427afb0
Merge branch 'ufs-community:develop' into textonly/vx
gspetro-NOAA Apr 26, 2022
639443c
remove ConfigParameters.inc (contents now appear in ConfigWorkflow.rst)
gspetro Apr 26, 2022
b83a363
update hpc-stack docs submodule
gspetro Apr 26, 2022
104b834
odds & ends
gspetro Apr 27, 2022
4a86c25
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Apr 27, 2022
0b4e2da
add VX tables, config info, & Rocoto output tables
gspetro Apr 27, 2022
7ba1352
add module use/load statements, fix typos
gspetro Apr 27, 2022
fa05f2c
Merge branch 'ufs-community:develop' into textonly/vx
gspetro-NOAA Apr 28, 2022
41d2195
varied minor details
gspetro Apr 28, 2022
676a351
add workflow svg diagram
gspetro Apr 28, 2022
f316df2
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Apr 28, 2022
41527b7
edits to rocoto ch
gspetro Apr 28, 2022
c351daa
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA Apr 29, 2022
c510845
update citation & readme
gspetro Apr 29, 2022
dbfcddf
adjust comment in Intro
gspetro Apr 29, 2022
0591d60
updates to Rocoto chapter
gspetro Apr 29, 2022
50018dd
fix minor formatting/wording issues
gspetro Apr 29, 2022
60fdef2
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA May 2, 2022
5e28faf
updates to LAMgrid chapter
gspetro May 2, 2022
24b2e69
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA May 2, 2022
eaec3c4
Merge branch 'ufs-community:develop' into textonly/other
gspetro-NOAA May 3, 2022
43cd2ea
LAM Grid edits
gspetro May 3, 2022
6b66abb
Merge branch 'textonly/other' of github.com:gspetro-NOAA/ufs-srweathe…
gspetro May 3, 2022
d2ca2b8
LAM ch: user-defined grid section
gspetro May 3, 2022
a707fc1
add UPP Product tables ch 6
gspetro May 3, 2022
b48d495
I/O edits & glossary terms
gspetro May 4, 2022
2477527
I/O Pt2
gspetro May 5, 2022
7ca1e52
I/O changes
gspetro May 5, 2022
5d2922a
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA May 5, 2022
271bb1a
include updated images
gspetro May 6, 2022
bcf8de7
update docs to reflect changes in PR #238
gspetro May 6, 2022
a900874
Graphics Ch-1st pass
gspetro May 9, 2022
a708016
minor updates to Graphics
gspetro May 10, 2022
0f1c223
minor updates to Graphics
gspetro May 10, 2022
975bce9
edit ConfigNewPlatform sections 1-4
gspetro May 10, 2022
3ae46d9
ConfigNewPlatform edits
gspetro May 11, 2022
1836bef
Merge branch 'ufs-community:release/public-v2' into release/public-v2
gspetro-NOAA May 11, 2022
5833d41
update to match head of develop
gspetro May 11, 2022
563cc68
resolve merge conflicts
gspetro May 11, 2022
e866ccd
I/O ch edits
gspetro May 11, 2022
bc93840
I/O edits
gspetro May 12, 2022
525dcb5
more I/O edits
gspetro May 12, 2022
4a4642d
hpc-stack submodule updates
gspetro May 12, 2022
1871716
add HPC-Stack MacOs info
gspetro May 12, 2022
6a49c8d
WE2E edits & tables
gspetro May 13, 2022
2e178a0
Merge branch 'ufs-community:develop' into textonly/other
gspetro-NOAA May 16, 2022
8570d6a
fix typo
gspetro May 16, 2022
8a9df5e
Merge branch 'textonly/other' of github.com:gspetro-NOAA/ufs-srweathe…
gspetro May 16, 2022
fc1d87c
minor grammar/typos
gspetro May 16, 2022
f143c44
merge conflict resolution
gspetro May 17, 2022
7ae19db
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA May 17, 2022
4f939ff
merge conflict resolution
gspetro May 17, 2022
aebc0ea
fix grid name
gspetro May 17, 2022
8377f21
remove resolved comments
gspetro May 17, 2022
39e62e4
add compact grids
gspetro May 18, 2022
c09769d
file path updates & info for HPC-Stack
gspetro May 18, 2022
5364e99
add SRW prereqs to Intro
gspetro May 18, 2022
f51bb57
change ConfigNewPlatform to a non-container quickstart
gspetro May 18, 2022
3df0596
clean up non-container quickstart
gspetro May 18, 2022
7f6e4e8
update build options for non-container QS
gspetro May 19, 2022
25851cb
update file paths & WE2E
gspetro May 19, 2022
e99cc1d
minor fixes
gspetro May 20, 2022
2bbd9b8
update I/O & Gaea file paths
gspetro May 20, 2022
b666899
update error in non-container QS
gspetro May 20, 2022
90e355e
add warning for users w/o Rocoto
gspetro May 20, 2022
5250e86
add UPP Satellite Product instructions
gspetro May 20, 2022
a2cb4b7
Xlink for UPP satellite output info
gspetro May 20, 2022
0b8a808
clarify compiler prereqs
gspetro May 20, 2022
1f704b4
Merge branch 'ufs-community:develop' into develop
gspetro-NOAA May 20, 2022
7f2d1e9
update textonly/other to be even with develop
gspetro May 20, 2022
3974b48
add list of fix files for release
gspetro May 20, 2022
18fcd90
Merge branch 'release/public-v2' of github.com:gspetro-NOAA/ufs-srwea…
gspetro May 23, 2022
abb9710
update branch w/latest changes
gspetro May 23, 2022
cd7cdb6
fix typo
gspetro May 24, 2022
17af289
update input data file names
gspetro May 24, 2022
79d6b20
remove resolved comments
gspetro May 25, 2022
e3b46c5
minor fix
gspetro May 26, 2022
ab64517
Merge branch 'ufs-community:release/public-v2' into release/public-v2
gspetro-NOAA May 26, 2022
c24e277
update CCPP version typo
gspetro May 26, 2022
e27c9e5
Merge branch 'release/public-v2' of github.com:gspetro-NOAA/ufs-srwea…
gspetro May 26, 2022
0518b97
minor fixes
gspetro May 27, 2022
1168ccf
Merge branch 'ufs-community:release/public-v2' into release/public-v2
gspetro-NOAA May 27, 2022
054e8cf
fix typo, add comments
gspetro May 27, 2022
a53c040
Merge branch 'release/public-v2' of github.com:gspetro-NOAA/ufs-srwea…
gspetro May 27, 2022
fac36aa
update UPP links
gspetro May 27, 2022
795bf6e
update links, add comments
gspetro May 28, 2022
90c25d2
add build/run alt text
gspetro May 31, 2022
bb5f16e
Merge branch 'ufs-community:release/public-v2' into release/public-v2
gspetro-NOAA Jun 1, 2022
2385ce4
update HPC-Stack module to point to its srw release branch
gspetro Jun 1, 2022
1b94f7c
update links
gspetro Jun 1, 2022
2f8b9f2
update QS container commands
gspetro Jun 1, 2022
ba6aba1
QS updates
gspetro Jun 2, 2022
e8b7225
Merge branch 'ufs-community:release/public-v2' into release/public-v2
gspetro-NOAA Jun 2, 2022
0b87c54
Include documentation for building/running SRW App on Mac (#240)
gspetro-NOAA May 26, 2022
9f48b56
merge changes from PR #240 to release-v2
natalie-perlin Jun 2, 2022
299469f
resolve conflicts w/PR #281
natalie-perlin Jun 2, 2022
121c631
I/O updates to wget commands
gspetro Jun 2, 2022
1ade6ba
Update documentation for CSV file containing WE2E test info (#278)
gsketefian May 27, 2022
d86e3c1
update HPSS file names
gspetro Jun 2, 2022
ea827ee
add links, remove comments
gspetro Jun 2, 2022
f861109
add links, remove comments
gspetro Jun 3, 2022
7c33560
FAQ updates
gspetro Jun 3, 2022
9a0b62c
ContribGuide updates
gspetro Jun 3, 2022
4047050
Rocoto ch updates
gspetro Jun 3, 2022
c159700
update wflow gen image
gspetro Jun 3, 2022
19a4973
update LAM grid chapter
gspetro Jun 3, 2022
b481e33
update docs links
gspetro Jun 3, 2022
fdcebd4
update NC QS
gspetro Jun 3, 2022
6ad9d57
glossary updates
gspetro Jun 3, 2022
a817eb6
add Stochastic Physics info
gspetro Jun 4, 2022
f227302
format valid values
gspetro Jun 4, 2022
31a2eba
edits for Config Params
gspetro Jun 7, 2022
ec55512
final Config Param updates
gspetro Jun 8, 2022
1e00ab6
Graphics edits
gspetro Jun 8, 2022
2585d68
remove WCOSS info
gspetro Jun 8, 2022
2f473ea
Intro updates pt1
gspetro Jun 8, 2022
ba6bc6f
Docs for Linux SRW build and run
natalie-perlin Jun 8, 2022
9d7a696
Remove WCOSS-specifics
natalie-perlin Jun 8, 2022
9982f76
miscellaneous changes
gspetro Jun 8, 2022
34823cd
Intro & QS updates
gspetro Jun 9, 2022
90c6101
minor fixes
gspetro Jun 9, 2022
e9d255a
Merge branch 'release/public-v2' into release/public-v2
gspetro-NOAA Jun 9, 2022
78c1d31
Merge branch 'release/public-v2' into release/public-v2-nowcoss
natalie-perlin Jun 10, 2022
c453aee
I/O updates
gspetro Jun 10, 2022
6a455b8
I/O updates
gspetro Jun 10, 2022
90fe04a
update RW hash
gspetro Jun 13, 2022
861e0b4
Merge branch 'release/public-v2' into release/public-v2
gspetro-NOAA Jun 13, 2022
923a360
update file paths to NaturalEarth
gspetro Jun 13, 2022
c415708
change ESFM docs version
gspetro Jun 13, 2022
fd8dc58
change ESFM docs version
gspetro Jun 13, 2022
8677726
finish I/O updates
gspetro Jun 13, 2022
4e233b9
update paths from develop to v2p0
gspetro Jun 13, 2022
1f4bb94
Update BuildRunSRW.rst
natalie-perlin Jun 14, 2022
ebac070
Update ConfigWorkflow.rst
natalie-perlin Jun 14, 2022
6ed2ce5
updates to WE2E
gspetro Jun 14, 2022
798cd3d
WE2E updates
gspetro Jun 15, 2022
35bc3d5
final WE2E updates
gspetro Jun 15, 2022
82c3793
update METplus support info
gspetro Jun 15, 2022
779cca4
update NC-QS Guide
gspetro Jun 15, 2022
d11ed59
QS updates
gspetro Jun 15, 2022
d38ecda
Merge pull request #4 from gspetro-NOAA/release/public-v2-nowcoss
gspetro-NOAA Jun 16, 2022
25ddc0d
fix WE2E tables
gspetro Jun 16, 2022
92d9531
Merge branch 'release/public-v2' of github.com:gspetro-NOAA/ufs-srwea…
gspetro Jun 16, 2022
0de6378
add WE2E test files
gspetro Jun 16, 2022
c694621
WE2E test edits
gspetro Jun 16, 2022
e4e0d15
WE2E table updates
gspetro Jun 16, 2022
777ef07
QS & updates to config_defaults table in build/run
gspetro Jun 17, 2022
f71c9de
Merge branch 'release/public-v2' into release/public-v2
gspetro-NOAA Jun 17, 2022
6ad8cae
QS modulefiles load
gspetro Jun 17, 2022
558f393
Merge branch 'release/public-v2' of github.com:gspetro-NOAA/ufs-srwea…
gspetro Jun 17, 2022
c411644
fix typo
gspetro Jun 17, 2022
e87b0d1
update mac/linux section of build/run
gspetro Jun 17, 2022
f44a59c
fix image
gspetro Jun 17, 2022
9bd2c78
fix image
gspetro Jun 17, 2022
94e0813
typo
gspetro Jun 17, 2022
4d09f72
update CCPP link
gspetro Jun 17, 2022
19e8e45
adjust Mac/Linux organization
gspetro Jun 17, 2022
fe17d95
mark's edits pt1
gspetro Jun 17, 2022
3ed0d3f
mac/linux reorg
gspetro Jun 21, 2022
afada63
minor edits
gspetro Jun 21, 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
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