-
Notifications
You must be signed in to change notification settings - Fork 284
Container and community platform support for UFS WM build-and-test workflow #3268
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
base: develop
Are you sure you want to change the base?
Changes from 14 commits
2aa3c11
b87ac8f
a75aa07
8ef0804
8c2753e
af077d1
ce7d16e
e270b12
e677a80
a6bb69d
157f1eb
a95e742
6ea1bf9
3184ea9
7c41638
e6cc992
96e29b8
fe9d8f4
8f01087
d1f095e
eed178f
ff500e9
d8db98b
6c2df4d
2097a75
1c24262
472cae0
7a0d8e5
e343e7e
b2ef04c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,17 @@ | |||||||||||||||
| Building and Running the UFS Weather Model | ||||||||||||||||
| ****************************************** | ||||||||||||||||
|
|
||||||||||||||||
| .. note:: | ||||||||||||||||
|
|
||||||||||||||||
| For instructions on using software containers to build and run the UFS Weather Model | ||||||||||||||||
| on any community platform, see :numref:`Chapter %s <container-rt-tests>`. | ||||||||||||||||
| The container workflow provides a portable, reproducible software environment and | ||||||||||||||||
| does not require a site-specific software stack. The Regression Test (RT) framework | ||||||||||||||||
| is adopted there as a convenient starting point for compiling the model and running | ||||||||||||||||
| test cases. Users will likely need to modify the testing configuration for their own | ||||||||||||||||
| computing platform, and are encouraged to tailor it further to suit their own modeling | ||||||||||||||||
| goals beyond running pre-defined tests. | ||||||||||||||||
|
|
||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @natalie-perlin I would move this note to the bottom of the "Supported Platforms & Compilers" section (i.e., after current line 28), since it relates to where/how users choose to build & run the model. I'd also delete the info about the RT framework because it is already in the container chapter and is more relevant there. Better to keep the note short and to-the-point.
Suggested change
|
||||||||||||||||
| =================================== | ||||||||||||||||
| Supported Platforms & Compilers | ||||||||||||||||
| =================================== | ||||||||||||||||
|
|
@@ -145,9 +156,11 @@ Compiling the model will take place within the ``ufs-weather-model`` directory c | |||||||||||||||
| Building the Weather Model | ||||||||||||||||
| ========================== | ||||||||||||||||
|
|
||||||||||||||||
| .. note:: | ||||||||||||||||
| .. note:: | ||||||||||||||||
|
|
||||||||||||||||
| The most straightforward way to run the UFS WM is to use the regression testing (RT) framework. The RT framework will load modulefiles, build (compile) the desired WM configuration, and run the test(s). Users can create new tests or modify existing tests to correspond to the WM configuration(s) they wish to run. This section is provided for those who do not want to use the RT framework to run the WM. However, most users should skip to :numref:`Section %s <rt-config>` to learn more about RT configuration or :numref:`Section %s <run-wm>` to build/run the WM with the RT framework. | ||||||||||||||||
|
natalie-perlin marked this conversation as resolved.
Outdated
|
||||||||||||||||
|
|
||||||||||||||||
| The most straightforward way to run the UFS WM is to use the regression testing (RT) framework. The RT framework will load modulefiles, build (compile) the desired WM configuration, and run the test(s). Users can create new tests or modify existing tests to correspond to the WM configuration(s) they wish to run. This section is provided for those who do not want to use the RT framework to run the WM. However, most users should skip to :numref:`Section %s <rt-config>` to learn more about RT configuration or :numref:`Section %s <run-wm>` to build/run the WM with the RT framework. | ||||||||||||||||
| A container-based workflow is also available (see :numref:`Chapter %s <container-rt-tests>`). It follows a similar RT framework but uses the container-oriented scripts ``rt_container.sh`` and ``rt_container.conf`` in place of ``rt.sh`` and ``rt.conf``. The container workflow is suitable for use on any community platform and expects users to adapt the configuration file, runtime modulefiles, and batch submission scripts to fit their compute environment. | ||||||||||||||||
|
natalie-perlin marked this conversation as resolved.
Outdated
|
||||||||||||||||
|
|
||||||||||||||||
| ---------------------------- | ||||||||||||||||
| Loading the Required Modules | ||||||||||||||||
|
|
||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.