Skip to content
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
2aa3c11
Adding a new container option
Jun 18, 2026
b87ac8f
Updates for container option, add flags to the rt_container.sh
Jun 18, 2026
a75aa07
Updates for container: if no job scheduler, build and run interactively
Jun 18, 2026
8ef0804
container option: set PMI variable to use with MPI launcher command
Jun 18, 2026
8c2753e
update rt_container.sh
Jun 18, 2026
af077d1
updates for container option
Jun 18, 2026
ce7d16e
updates for rt_container* files
Jun 18, 2026
e270b12
update rt_container.sh
Jun 18, 2026
e677a80
updates for container option
Jun 20, 2026
a6bb69d
updates for container option
Jun 20, 2026
157f1eb
Allow to run a container test on a single node if job scheduler=none
Jun 20, 2026
a95e742
updated rt_container.sh to create a run_dir soft link
Jun 21, 2026
6ea1bf9
update container option, for PBS scheduler
Jun 22, 2026
3184ea9
Documentation update for use of containers
Jun 22, 2026
7c41638
Updated Cointainer documentation and minor corrections to the scripts
Jun 25, 2026
e6cc992
Changes for container and community platform option
Jun 27, 2026
96e29b8
Community platform and container option changes: tests/community.sh, …
Jun 29, 2026
fe9d8f4
Changed for community platform and container options, in ./tests dire…
Jun 29, 2026
8f01087
updated job scheduler scripts for container option
Jun 29, 2026
d1f095e
Updates for container and community platform
Jul 1, 2026
eed178f
Updates for container and community platform
Jul 1, 2026
ff500e9
Container and community platform updates: scripts and documentation
Jul 1, 2026
d8db98b
Merge branch 'develop' into feature/container-option
gspetro-NOAA Jul 2, 2026
6c2df4d
Merge develop into feature/container-option
Aug 25, 2026
2097a75
Update a Chapter in UsersGuide ContainerAndCommunity_BuildAndRun.rst
Aug 25, 2026
1c24262
Update a Chapter in BuildingAndRunning.rst, notes on workflows for RT…
Aug 25, 2026
472cae0
Fix formatting issues in run_test.sh
natalie-perlin Aug 26, 2026
7a0d8e5
Fixing super-linter summary errors
Aug 27, 2026
e343e7e
Fixing CI/CI errors that enforce repo standards
Aug 27, 2026
b2ef04c
Docs correction and update: ContainerAndCommunity_BuildAndRun.rst
Sep 3, 2026
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
17 changes: 15 additions & 2 deletions doc/UsersGuide/source/BuildingAndRunning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment thread
natalie-perlin marked this conversation as resolved.
Outdated

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The 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
.. 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.

===================================
Supported Platforms & Compilers
===================================
Expand Down Expand Up @@ -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.
Comment thread
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.
Comment thread
natalie-perlin marked this conversation as resolved.
Outdated

----------------------------
Loading the Required Modules
Expand Down
Loading
Loading