From c01f8ff2e068dffad67dbef3cccce1ca61055522 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Thu, 21 Nov 2024 12:55:29 -0500 Subject: [PATCH 01/11] Updating ConfigWorkflow.rst file to reflect changes to Config defaults --- .../CustomizingTheWorkflow/ConfigWorkflow.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 50d343f57e..a29c350d3a 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -14,7 +14,7 @@ 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. @@ -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_BASE_FP`` file. *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_FP`` in the experiment directory. + ``FCST_MODEL``: (Default: "ufs-weather-model") Name of forecast model. Valid values: ``"ufs-weather-model"`` | ``"fv3gfs_aqm"`` @@ -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:: From 48caf824437d574718374465286dd9192eaec6b8 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:26:32 -0500 Subject: [PATCH 02/11] Formatting change to fix doc generation --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index a29c350d3a..7b6c7b25a4 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -15,7 +15,7 @@ The following is a list of the parameters in the ``config_defaults.yaml`` file. .. _user: 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. From b04b852abfd8a6fca424433d0d8f1dec3fa4ae97 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Mon, 25 Nov 2024 16:51:09 -0500 Subject: [PATCH 03/11] Update doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com> --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 7b6c7b25a4..2374fb6db9 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -14,7 +14,7 @@ The following is a list of the parameters in the ``config_defaults.yaml`` file. .. _user: -USER-related 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. From e17817396626999e9370225042eb49614b2253a3 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Mon, 2 Dec 2024 12:06:12 -0500 Subject: [PATCH 04/11] Update doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com> --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 2374fb6db9..ee684b4233 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -360,7 +360,7 @@ 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") +``FIRE_NML_FN``: (Default: "namelist.fire") Name of namelist file for UFS_FIRE capability. Set File Path Parameters From 438f5a01ed54adfd3da4aac5ec8449da6f2c2657 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Mon, 2 Dec 2024 12:06:31 -0500 Subject: [PATCH 05/11] Update doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com> --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index ee684b4233..3ace5087f5 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -417,7 +417,7 @@ This section contains files and paths to files that are staged in the experiment 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. + 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"`` From faaa033ee423eec0121065329ccb2439a238b2df Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Mon, 2 Dec 2024 12:06:38 -0500 Subject: [PATCH 06/11] Update doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com> --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 3ace5087f5..26b32a1909 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -394,7 +394,7 @@ Set File Path Parameters 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. + Path to the ``FIRE_NML_FN`` file in the ``parm`` directory. *Experiment Directory* Files and Paths ------------------------------------------ From 36ae45db824f58868d1db044583ac88a845555a3 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:23:50 -0500 Subject: [PATCH 07/11] Addressed Gillians requested changes --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 26b32a1909..e12a9252f8 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -2172,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) From 33fbd8c624275ecd4dc7c3d3849cdaba41f38832 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 6 Dec 2024 14:55:13 -0500 Subject: [PATCH 08/11] Minor changes requested by Gillian --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index e12a9252f8..561db1f807 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -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") @@ -1002,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"``) From 7fd5248a4c9d7be70d63644d154f08ad8be6bbe3 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 6 Dec 2024 14:57:32 -0500 Subject: [PATCH 09/11] minor changes --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 561db1f807..1bda9ae3d8 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -1028,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"``) From 53d5edbb7f89a7ae621638f521d36be251249e2f Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 6 Dec 2024 15:56:31 -0500 Subject: [PATCH 10/11] Change default value of FIRE_IGNITION_ROS --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 1bda9ae3d8..7e34702779 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -2151,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.5) Ignition rate of spread (Rothermel parameterization) ``FIRE_IGNITION_START_LAT`` (Default: 40.609) From 1a1b9502b92ec4ab67866aaf3060f1d524d10529 Mon Sep 17 00:00:00 2001 From: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com> Date: Mon, 9 Dec 2024 17:21:33 -0500 Subject: [PATCH 11/11] Correct FIRE_IGNITION_ROS default val and minor formatting --- doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst index 7e34702779..447373cbea 100644 --- a/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst +++ b/doc/UsersGuide/CustomizingTheWorkflow/ConfigWorkflow.rst @@ -2142,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) @@ -2151,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.5) +``FIRE_IGNITION_ROS`` (Default: 0.05) Ignition rate of spread (Rothermel parameterization) ``FIRE_IGNITION_START_LAT`` (Default: 40.609)