Skip to content

Commit f6c4135

Browse files
Merge pull request #1 from MichaelLueken/doc/FAQ_update
Update conf.py to address new broken link
2 parents 55f74f8 + 9ff72a5 commit f6c4135

7 files changed

Lines changed: 11 additions & 10 deletions

File tree

Externals.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ protocol = git
1212
repo_url = https://github.com/ufs-community/ufs-weather-model
1313
# Specify either a branch name or a hash but not both.
1414
#branch = develop
15-
hash = 855243a
15+
hash = 826f6ff
1616
local_path = sorc/ufs-weather-model
1717
required = True
1818

doc/UsersGuide/BackgroundInfo/Components.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Build System and Workflow
132132

133133
The SRW Application has a portable, CMake-based build system that packages together all the components required to build the SRW Application. This build system collects the components necessary for running the end-to-end SRW Application, including the UFS Weather Model and the pre- and post-processing software. Additional libraries necessary for the application (e.g., :term:`NCEPLIBS-external` and :term:`NCEPLIBS`) are not included in the SRW Application build system but are available pre-built on pre-configured platforms. On other systems, they can be installed via spack-stack (see :doc:`spack-stack Documentation <spack-stack:index>`). There is a small set of :ref:`prerequisite system libraries <software-prereqs>` and utilities that are assumed to be present on the target computer: the CMake build software; a Fortran, C, and C++ compiler; and an :term:`MPI` library.
134134

135-
Once built, users can generate a Rocoto-based workflow that will run each task in the proper sequence (see :numref:`Chapter %s <RocotoInfo>` or the `Rocoto documentation <https://github.com/christopherwharrop/rocoto/wiki/Documentation>`__ for more information on Rocoto and workflow management). If Rocoto and/or a batch system is not present on the available platform, the individual components can be run in a stand-alone, command line fashion with provided run scripts.
135+
Once built, users can generate a Rocoto-based workflow that will run each task in the proper sequence (see :numref:`Chapter %s <RocotoInfo>` or the `Rocoto documentation <https://github.com/NOAA-GSL/rocoto/wiki/Documentation>`__ for more information on Rocoto and workflow management). If Rocoto and/or a batch system is not present on the available platform, the individual components can be run in a stand-alone, command line fashion with provided run scripts.
136136

137137
The SRW Application allows users to configure various elements of the workflow. For example, users can modify the parameters of the atmospheric model, such as start and end dates, duration, integration time step, and the physics suite used for the simulation. It also allows for configuration of other elements of the workflow; for example, users can choose whether to run some or all of the pre-processing, forecast model, and post-processing steps. More information on how to configure the workflow is available in :numref:`Section %s <UserSpecificConfig>`.
138138

doc/UsersGuide/CustomizingTheWorkflow/DefineWorkflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Defining an SRW App Workflow
66

77
Many predefined workflows with optional variants exist within the Short-Range Weather Application, but the Application also includes the ability to define a new workflow from scratch. This functionality allows users to add tasks to the workflow to meet their scientific exploration needs.
88

9-
Rocoto is the primary workflow manager software used by the UFS SRW App. Rocoto workflows are defined in an XML file (``FV3LAM_wflow.xml``) based on parameters set during experiment generation. The SRW Rocoto XML is built using the UW Tools Rocoto Tool. Reference its documentation `here <https://uwtools.readthedocs.io/en/main/sections/user_guide/yaml/rocoto.html>`__. For more information about Rocoto, check out its `documentation here <http://christopherwharrop.github.io/rocoto/>`_.
9+
Rocoto is the primary workflow manager software used by the UFS SRW App. Rocoto workflows are defined in an XML file (``FV3LAM_wflow.xml``) based on parameters set during experiment generation. The SRW Rocoto XML is built using the UW Tools Rocoto Tool. Reference its documentation `here <https://uwtools.readthedocs.io/en/main/sections/user_guide/yaml/rocoto.html>`__. For more information about Rocoto, check out its `documentation here <https://noaa-gsl.github.io/rocoto/>`_.
1010

1111
Order of Precedence
1212
===================

doc/UsersGuide/Reference/Glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ Glossary
264264
A central location in which files (e.g., data, code, documentation) are stored and managed.
265265

266266
Rocoto
267-
The `Rocoto Workflow Management System <https://github.com/christopherwharrop/rocoto/wiki/documentation>`__ is a Ruby-based tool that manages workflow task dependencies and job submission on :term:`HPC` systems. Rocoto communicates with batch systems to run tasks in the proper sequence based on dependencies and can automatically resubmit failed tasks. The SRW App uses Rocoto to orchestrate the execution of workflow tasks defined in the ``FV3LAM_wflow.xml`` file. For more information, see :numref:`Section %s <RocotoInfo>`.
267+
The `Rocoto Workflow Management System <https://github.com/NOAA-GSL/rocoto/wiki/Documentation>`__ is a Ruby-based tool that manages workflow task dependencies and job submission on :term:`HPC` systems. Rocoto communicates with batch systems to run tasks in the proper sequence based on dependencies and can automatically resubmit failed tasks. The SRW App uses Rocoto to orchestrate the execution of workflow tasks defined in the ``FV3LAM_wflow.xml`` file. For more information, see :numref:`Section %s <RocotoInfo>`.
268268

269269
RRFS
270270
The `Rapid Refresh Forecast System <https://gsl.noaa.gov/research/predictions>`_ (RRFS) is NOAA's next-generation convection-allowing, rapidly-updated, ensemble-based data assimilation and forecasting system currently scheduled for operational implementation in 2024. It is designed to run forecasts on a 3-km :term:`CONUS` domain, see also `NOAA Rapid Refresh Forecast System (RRFS) <https://registry.opendata.aws/noaa-rrfs/>`__. Experimental data is currently available from the `AWS S3 NOAA-RRFS <https://noaa-rrfs-pds.s3.amazonaws.com/index.html#rrfs_a/>`__ bucket for deterministic forecasts out to 60 hours at 00, 06, 12, and 18 UTC. Additionally, hourly forecasts out to 18 hours may be available for more recent RRFS model runs; the user needs to verify that data exists for needed dates.

doc/UsersGuide/Reference/RocotoInfo.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Rocoto is a Ruby program that communicates with the batch system on an
99
:term:`HPC` system to run and manage dependencies between the tasks. Rocoto submits jobs to the HPC batch
1010
system as the task dependencies allow and runs one instance of the workflow for a set of user-defined
1111
:term:`cycles <cycle>`. More information about Rocoto can be found on the
12-
`Rocoto Wiki <https://github.com/christopherwharrop/rocoto/wiki/documentation>`__.
12+
`Rocoto Wiki <https://github.com/NOAA-GSL/rocoto/wiki/documentation>`__.
1313

1414
The SRW App workflow is defined in a Jinja-enabled Rocoto XML template called ``FV3LAM_wflow.xml``,
1515
which resides in the ``parm`` directory. When the ``generate_FV3LAM_wflow.py`` script is run,
@@ -19,7 +19,7 @@ and task interdependencies. The generated XML file is then copied to the experim
1919
``$EXPTDIR/FV3LAM_wflow.xml``.
2020

2121
There are a number of Rocoto commands available to run and monitor the workflow; users can find more information in the
22-
complete `Rocoto documentation <http://christopherwharrop.github.io/rocoto/>`__.
22+
complete `Rocoto documentation <https://noaa-gsl.github.io/rocoto/>`__.
2323
Descriptions and examples of commonly used commands are discussed below.
2424

2525
.. _RocotoRunCmd:
@@ -50,7 +50,7 @@ Users will need to include the absolute or relative path to these files when run
5050
It is important to note that the ``rocotorun`` process is iterative; the command must be executed
5151
many times before the entire workflow is completed, usually every 1-10 minutes. This command can be
5252
placed in the user’s :term:`crontab`, and cron will call it with a specified frequency. More information on
53-
this command can be found in the `Rocoto documentation <http://christopherwharrop.github.io/rocoto/>`__.
53+
this command can be found in the `Rocoto documentation <https://noaa-gsl.github.io/rocoto/>`__.
5454

5555
The first time the ``rocotorun`` command is executed for a workflow, the files ``FV3LAM_wflow.db`` and
5656
``FV3LAM_wflow_lock.db`` are created. There is usually no need for the user to modify these files.
@@ -130,7 +130,7 @@ on the grid size and computational resources available), the output of the ``roc
130130
When the workflow runs to completion, all tasks will be marked as SUCCEEDED. The log file for each task
131131
is located in ``$EXPTDIR/log``. If any task fails, the corresponding log file can be checked for error
132132
messages. Optional arguments for the ``rocotostat`` command can be found in the
133-
`Rocoto documentation <http://christopherwharrop.github.io/rocoto/>`__.
133+
`Rocoto documentation <https://noaa-gsl.github.io/rocoto/>`__.
134134

135135
.. _rocotocheck:
136136

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@
127127
r'https://doi.org/10.5281/zenodo.14834682',
128128
r'https://www.naturalearthdata.com/downloads/',
129129
r'https://www.xquartz.org/',
130+
r'https://doi.org/10.5194/gmd-14-5487-2021',
130131
]
131132

132133
# Ignore anchor tags for SRW App data bucket. Shows Not Found even when they exist.

parm/field_table.FV3_RRFS_v1beta

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"TRACER", "atmos_mod", "sphum"
44
"longname", "specific humidity"
55
"units", "kg/kg"
6-
"profile_type", "fixed", "surface_value=1.e30" /
6+
"profile_type", "fixed", "surface_value=3.e-6" /
77
# prognostic cloud water mixing ratio
88
"TRACER", "atmos_mod", "liq_wat"
99
"longname", "cloud water mixing ratio"
@@ -33,7 +33,7 @@
3333
"TRACER", "atmos_mod", "water_nc"
3434
"longname", "cloud liquid water number concentration"
3535
"units", "/kg"
36-
"profile_type", "fixed", "surface_value=1.e30" /
36+
"profile_type", "fixed", "surface_value=0.0" /
3737
# prognostic cloud ice number concentration
3838
"TRACER", "atmos_mod", "ice_nc"
3939
"longname", "cloud ice water number concentration"

0 commit comments

Comments
 (0)