[develop] Updating ConfigWorkflow.rst file to reflect changes to Config defaults #1157
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdkublnick
requested review from
mkavulich,
gsketefian,
JeffBeck-NOAA,
RatkoVasic-NOAA,
BenjaminBlake-NOAA,
ywangwof,
chan-hoo,
panll,
christinaholtNOAA,
christopherwharrop-noaa,
danielabdi-noaa,
mark-a-potts,
jkbk2004,
willmayfield,
dmwright526,
gspetro-NOAA,
natalie-perlin,
EdwardSnyder-NOAA,
MichaelLueken,
rickgrubin-noaa and
BruceKropp-Raytheon
as code owners
MichaelLueken
changed the title
MichaelLueken
requested changes
Nov 21, 2024
MichaelLueken
approved these changes
Nov 21, 2024
Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com>
| @@ -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") | |||
There was a problem hiding this comment.
Suggested change
| ``FIRE_NML_FN_``: (Default: "namelist.fire") | |
| ``FIRE_NML_FN``: (Default: "namelist.fire") |
| @@ -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. | |||
There was a problem hiding this comment.
Suggested change
| Path to the ``FIRE_NML_FP`` in the experiment directory. | |
| Path to the ``FIRE_NML_FN`` file in the experiment directory. |
| @@ -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. | |||
There was a problem hiding this comment.
Suggested change
| Path to the ``FIRE_NML_BASE_FP`` file. | |
| Path to the ``FIRE_NML_FN`` file in the ``parm`` directory. |
|
In the RST, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIPTION OF CHANGES:
Updated ConfigWorkflow.rst to reflect recent changes to config_defaults.yaml in order to keep documentation up to date.
Type of change
[X ] This change requires a documentation update
TESTS CONDUCTED:
None required for documentation. The docs build successfully on my fork and can be viewed at: https://ufs-srweather-app-joshua-kublnick.readthedocs.io/en/text-us-404/
DEPENDENCIES:
N/A
DOCUMENTATION:
All documentation
ISSUE:
Issue #1132
CHECKLIST
[X ] My code follows the style guidelines in the Contributor's Guide
[X ] I have performed a self-review of my own code using the Code Reviewer's Guide
I have commented my code, particularly in hard-to-understand areas
[X ] My changes need updates to the documentation. I have made corresponding changes to the documentation
My changes do not require updates to the documentation (explain).
[X ] My changes generate no new warnings
New and existing tests pass with my changes
[ X] Any dependent changes have been merged and published
LABELS (optional):
A Code Manager needs to add the following labels to this PR:
[X ] documentation