diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 50d343f57..447373cbe 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -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. @@ -252,7 +252,7 @@ WORKFLOW Configuration Parameters If non-default parameters are selected for the variables in this section, they should be added to the ``workflow:`` section of the ``config.yaml`` file. -``WORKFLOW_ID``: (Default: ``''``) +``WORKFLOW_ID``: (Default: "") Unique ID for the workflow run that will be set in ``setup.py``. ``RELATIVE_LINK_FLAG``: (Default: "--relative") @@ -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") + Name of namelist file for UFS_FIRE capability. + Set File Path Parameters ---------------------------- @@ -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_FN`` file in the ``parm`` directory. *Experiment Directory* Files and Paths ------------------------------------------ @@ -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_FN`` file in the experiment directory. + ``FCST_MODEL``: (Default: "ufs-weather-model") Name of forecast model. Valid values: ``"ufs-weather-model"`` | ``"fv3gfs_aqm"`` @@ -994,7 +1002,7 @@ Vertical Coordinate Parameters ``LEVP``: (Default: 65) Number of vertical levels in the atmosphere. In order to change this number, the user will additionally need to create a vertical coordinate - distribution file; this process is described in :numref:`Section %s ` + distribution file; this process is described in :numref:`Section %s `. This value should be the same in both ``make_ics`` and ``make_lbcs``. ``VCOORD_FILE``: (Default: ``"{{ workflow.FIXam }}/global_hyblev.l65.txt"``) @@ -1020,7 +1028,7 @@ Vertical Coordinate Parameters ``LEVP``: (Default: 65) Number of vertical levels in the atmosphere. In order to change this number, the user will additionally need to create a vertical coordinate - distribution file; this process is described in :numref:`Section %s ` + distribution file; this process is described in :numref:`Section %s `. This value should be the same in both ``make_ics`` and ``make_lbcs``. ``VCOORD_FILE``: (Default: ``"{{ workflow.FIXam }}/global_hyblev.l65.txt"``) @@ -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:: @@ -2134,7 +2142,7 @@ Non-default parameters for the Community Fire Behavior Model (CFBM) in SRW are s to calculate the logarithmic surface layer wind profile ``FIRE_LSM_ZCOUPLING_REF`` (Default: 60.0) - Reference height from which the velocity at FIRE_WIND_HEIGHT is calculated using a logarithmic profile + Reference height from which the velocity at ``FIRE_WIND_HEIGHT`` is calculated using a logarithmic profile ``FIRE_NUM_IGNITIONS`` (Default: 1) @@ -2143,7 +2151,7 @@ Non-default parameters for the Community Fire Behavior Model (CFBM) in SRW are s .. note:: If ``FIRE_NUM_IGNITIONS > 1``, the following variables should be lists with one entry for each ignition -``FIRE_IGNITION_ROS`` (Default: 0.0) +``FIRE_IGNITION_ROS`` (Default: 0.05) Ignition rate of spread (Rothermel parameterization) ``FIRE_IGNITION_START_LAT`` (Default: 40.609) @@ -2164,7 +2172,7 @@ Non-default parameters for the Community Fire Behavior Model (CFBM) in SRW are s ``FIRE_IGNITION_START_TIME`` (Default: 6480) Start time of ignition(s) in seconds (counting from the beginning of the simulation) -``FIRE_IGNITION_START_TIME`` (Default: 7000) +``FIRE_IGNITION_END_TIME`` (Default: 7000) End time of ignition(s) in seconds (counting from the beginning of the simulation)