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.

Sign up for GitHub

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

Jump to bottom

[develop] Updating ConfigWorkflow.rst file to reflect changes to Config defaults #1157

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

[develop] Updating ConfigWorkflow.rst file to reflect changes to Config defaults #1157

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c01f8ff
Updating ConfigWorkflow.rst file to reflect changes to Config defaults
jdkublnick Nov 21, 2024
48caf82
Formatting change to fix doc generation
jdkublnick Nov 21, 2024
b04b852
Update doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst
jdkublnick Nov 25, 2024
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
14 changes: 11 additions & 3 deletions doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The following is a list of the parameters in the ``config_defaults.yaml`` file.

.. _user:

USER Configuration Parameters
=================================
USER-Related Configuration Parameters
======================================

If non-default parameters are selected for the variables in this section, they should be added to the ``user:`` section of the ``config.yaml`` file.

Expand Down Expand Up @@ -360,6 +360,9 @@ Set File Name Parameters
``AQM_RC_TMPL_FN``: (Default: "aqm.rc")
Template file name of resource file for NOAA Air Quality Model (AQM).

``FIRE_NML_FN_``: (Default: "namelist.fire")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
``FIRE_NML_FN_``: (Default: "namelist.fire")
``FIRE_NML_FN``: (Default: "namelist.fire")

Name of namelist file for UFS_FIRE capability.

Set File Path Parameters
----------------------------

Expand Down Expand Up @@ -390,6 +393,8 @@ Set File Path Parameters
``AQM_RC_TMPL_FP``: (Default: ``'{{ [user.PARMdir, AQM_RC_TMPL_FN]|path_join }}'``)
Path to the ``AQM_RC_TMPL_FN`` file.

``FIRE_NML_BASE_FP``: (Default: ``'{{ [user.PARMdir, FIRE_NML_FN]|path_join }}'``)
Path to the ``FIRE_NML_BASE_FP`` file.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Path to the ``FIRE_NML_BASE_FP`` file.
Path to the ``FIRE_NML_FN`` file in the ``parm`` directory.


*Experiment Directory* Files and Paths
------------------------------------------
Expand All @@ -411,6 +416,9 @@ This section contains files and paths to files that are staged in the experiment
``FV3_NML_STOCH_FP``: (Default: ``'{{ [EXPTDIR, [FV3_NML_FN, "_stoch"]|join ]|path_join }}'``)
Path to a namelist file that includes stochastic physics namelist parameters.

``FIRE_NML_FP``: (Default: ``'{{ [EXPTDIR, FIRE_NML_FN]|path_join }}'``)
Path to the ``FIRE_NML_FP`` in the experiment directory.
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA Nov 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Path to the ``FIRE_NML_FP`` in the experiment directory.
Path to the ``FIRE_NML_FN`` file in the experiment directory.


``FCST_MODEL``: (Default: "ufs-weather-model")
Name of forecast model. Valid values: ``"ufs-weather-model"`` | ``"fv3gfs_aqm"``

Expand Down Expand Up @@ -1134,7 +1142,7 @@ Write-Component (Quilting) Parameters
``PRINT_ESMF``: (Default: false)
Flag that determines whether to output extra (debugging) information from :term:`ESMF` routines. Note that the write component uses ESMF library routines to interpolate from the native forecast model grid to the user-specified output grid (which is defined in the model configuration file ``model_configure`` in the forecast run directory). Valid values: ``True`` | ``False``

``PE_MEMBER01``: (Default: ``'{{ OMP_NUM_THREADS_RUN_FCST * (LAYOUT_Y * LAYOUT_X + WRTCMP_write_groups * WRTCMP_write_tasks_per_group) if QUILTING else OMP_NUM_THREADS_RUN_FCST * (LAYOUT_Y * LAYOUT_X)}}'``)
``PE_MEMBER01``: (Default: ``'{{ OMP_NUM_THREADS_RUN_FCST * (LAYOUT_Y * LAYOUT_X + WRTCMP_write_groups * WRTCMP_write_tasks_per_group) + fire.FIRE_NUM_TASKS if QUILTING else OMP_NUM_THREADS_RUN_FCST * (LAYOUT_Y * LAYOUT_X) + fire.FIRE_NUM_TASKS}}'``)
The number of MPI processes required by the forecast. When QUILTING is true, it is calculated as:

.. math::
Expand Down
Loading