From d9b127eb51d8dd676ac3161b2ff7bd10f75f58b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Tue, 2 May 2023 19:48:53 -0400 Subject: [PATCH 01/44] update requirements file --- doc/UsersGuide/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/UsersGuide/requirements.txt b/doc/UsersGuide/requirements.txt index 9c7258463b..7be32f526d 100644 --- a/doc/UsersGuide/requirements.txt +++ b/doc/UsersGuide/requirements.txt @@ -1,2 +1,3 @@ sphinxcontrib-bibtex sphinx_rtd_theme +docutils==0.16 \ No newline at end of file From 73528885ab2ef56192dbb1f19fc2ef77106b13cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Tue, 2 May 2023 19:53:52 -0400 Subject: [PATCH 02/44] update Code Overview ch; add supported platforms section --- doc/UsersGuide/source/CodeOverview.rst | 192 +++++++++++++++---------- 1 file changed, 115 insertions(+), 77 deletions(-) diff --git a/doc/UsersGuide/source/CodeOverview.rst b/doc/UsersGuide/source/CodeOverview.rst index 827a1d3fe3..ea82442849 100644 --- a/doc/UsersGuide/source/CodeOverview.rst +++ b/doc/UsersGuide/source/CodeOverview.rst @@ -1,14 +1,48 @@ .. _CodeOverview: ************************* -Code Overview +Technical Overview ************************* +.. _SupportedPlatforms: + +===================================================== +Supported Systems for Running the UFS Weather Model +===================================================== + +Four levels of support have been defined for :term:`UFS` applications, and the UFS Weather Model (:term:`WM`) operates under this paradigm: + +* **Level 1** *(Preconfigured)*: Prerequisite software libraries are pre-built and available in a central location; code builds; full testing of model. +* **Level 2** *(Configurable)*: Prerequisite libraries are not available in a centralized location but are expected to install successfully; code builds; full testing of model. +* **Level 3** *(Limited-test platforms)*: Libraries and code build on these systems, but there is limited testing of the model. +* **Level 4** *(Build-only platforms)*: Libraries and code build, but running the model is not tested. + +Level 1 Systems +================== +Preconfigured (Level 1) systems for the UFS WM already have the required external libraries available in a central location via :term:`HPC-Stack` or :term:`spack-stack`. The WM is expected to build and run out-of-the-box on these systems, and users can download the WM code without first installing prerequisite software. In general, users must have access to these Level 1 systems in order to use them. + +Currently, Level 1 (or Tier-1) platforms for regression testing are: + + * WCOSS2 (Intel) + * Cheyenne (Intel/GNU compilers) + * Gaea (Intel) + * Hera (Intel/GNU compilers) + * Jet (Intel) + * Orion (Intel) + * AWS Docker container (GNU) + +More information is available in the `UFS WM wiki `__. + +Level 2-4 Systems +=================== + +On non-Level 1 platforms, users must install the required libraries before building the UFS WM. Once these prerequisite libraries are installed, applications and the WM should build and run successfully. However, users may need to perform additional troubleshooting on Level 3 or 4 systems since little or no testing is conducted on these systems. + =================================================== UFS Weather Model Hierarchical Repository Structure =================================================== -The UFS Weather Model (:term:`WM`) repository supports the :term:`UFS` short- and medium-range weather applications (:term:`SRW` / :term:`MRW` Apps). The WM repository contains atmosphere, ocean, sea ice, and wave components, as well as some infrastructure components. Each of these subcomponents has its own repository. All the repositories are currently located in GitHub with public access to the broad community. :numref:`Table %s ` describes the list of repositories that comprises the UFS WM. +The UFS :term:`WM` repository supports the :term:`UFS` short- and medium-range weather applications (:term:`SRW` / :term:`MRW` Apps). The WM repository contains atmosphere, ocean, sea ice, land, and wave components, as well as some infrastructure components. Each of these subcomponents has its own repository. All the repositories are currently located in GitHub with public access to the broader community. :numref:`Table %s ` describes the list of repositories that comprise the UFS WM. .. _Repo_Structure: @@ -20,103 +54,107 @@ The UFS Weather Model (:term:`WM`) repository supports the :term:`UFS` short- an - Authoritative repository URL * - Umbrella repository for the UFS Weather Model - https://github.com/ufs-community/ufs-weather-model - * - Framework to connect the CCPP library to a host model + * - Framework to connect the :term:`CCPP` library to a host model - https://github.com/NCAR/ccpp-framework * - CCPP library of physical parameterizations - https://github.com/NCAR/ccpp-physics * - Umbrella repository for the physics and dynamics of the atmospheric model (FV3) - https://github.com/NOAA-EMC/fv3atm - * - FV3 dynamical core + * - :term:`FV3` dynamical core - https://github.com/NOAA-GFDL/GFDL_atmos_cubed_sphere * - Stochastic physics pattern generator - https://github.com/noaa-psd/stochastic_physics - * - Modular Ocean Model (MOM6) + * - Modular Ocean Model (:term:`MOM6`) - https://github.com/NOAA-EMC/MOM6 - * - HYbrid Coordinate Ocean Model (HYCOM) + * - HYbrid Coordinate Ocean Model (:term:`HYCOM`) - https://github.com/NOAA-EMC/HYCOM-src - * - Los Alamos sea ice model (CICE6) + * - Los Alamos sea ice model (:term:`CICE6`) - https://github.com/NOAA-EMC/CICE - * - NOAA/NCEP WAVEWATCH III Model (WW3) + * - NOAA/NCEP WAVEWATCH III Model (:term:`WW3`) - https://github.com/NOAA-EMC/WW3 - * - The Goddard Chemistry Aerosol Radiation and Transport (GOCART) + * - The Goddard Chemistry Aerosol Radiation and Transport (:term:`GOCART`) - https://github.com/GEOS-ESM/GOCART - * - NUOPC Community Mediator for Earth Prediction Systems (CMEPS) + * - NUOPC Community Mediator for Earth Prediction Systems (:term:`CMEPS`) - https://github.com/NOAA-EMC/CMEPS - * - Community Data Models for Earth Prediction Systems (CDEPS) + * - Community Data Models for Earth Prediction Systems (:term:`CDEPS`) - https://github.com/NOAA-EMC/CDEPS - * - Air Quality Model (AQM) + * - Air Quality Model (:term:`AQM`) - https://github.com/NOAA-EMC/AQM + * - Noah-MP Land Surface Model (Noah-MP) + - https://github.com/NOAA-EMC/noahmp -In the table, the left column contains a description of each repository, and the right column shows the component repositories which are pointing to (or will point to) the authoritative repositories. The UFS WM currently uses Git submodules to manage the sub-components. +In the table, the left-hand column contains a description of each repository, and the +right-hand column shows the GitHub location of the authoritative component repositories. +The UFS WM currently uses Git submodules to manage these subcomponents. =================== Directory Structure =================== -The umbrella repository for the UFS Weather Model is named ``ufs-weather-model``. Under this repository reside a number of submodules that are nested in specific directories under the parent repository's working directory. When the ``ufs-weather-model`` repository is cloned, the basic directory structure will be similar to the example below. Files and some directories have been removed for brevity. Directories in parentheses will appear only after a submodule update (``git submodule update --init --recursive``). +The umbrella repository for the UFS WM is named ``ufs-weather-model``. Under this repository reside a number of submodules that are nested in specific directories under the parent repository's working directory. When the ``ufs-weather-model`` repository is cloned, the basic directory structure will be similar to the example below. Files and some directories have been removed for brevity. Directories in parentheses will appear only after a recursive clone or submodule update (``git submodule update --init --recursive``). .. code-block:: console - ufs-weather-model/ - ├── build.sh -------- script for building the WM - ├── cmake -------- cmake configuration files - ├── CMakeLists.txt - ├── CMakeModules - ├── doc -------- User Guide files - ├── driver - ├── FV3 -------- UFSAtm atmosphere model - │ ├── (atmos_cubed_sphere) -------- FV3 dynamical core - │ │ ├── (docs) - │ │ ├── (driver) - │ │ ├── (model) - │ │ └── (tools) - │ ├── (ccpp) -------- Common Community Physics Package - │ │ ├── (config) - │ │ ├── (driver) - │ │ ├── (framework) -------- CCPP framework - │ │ ├── (physics) -------- CCPP compliant physics schemes - │ │ └── (suites) -------- CCPP physics suite definition files (SDFs) - │ ├── (cpl) -------- Coupling field data structures - │ ├── (io) -------- UFSAtm write grid comp code - │ └── (stochastic_physics) -------- Wrapper for stochastic physics - │ - ├── stochastic_physics -------- stochastic physics pattern generator - ├── AQM - │ └── (src) - │ ├── (model) - │ └── (CMAQ) --------- EPA AQ Model - ├── CICE-interface - │ └── CICE --------- CICE6 sea ice model - │ ├── (icepack) --------- Sea ice column physics - │ └── (cicecore/drivers/nuopc/cmeps) --------- NUOPC CICE6 cap - ├── GOCART - │ └── (ESMF) --------- GOCART model - ├── HYCOM-interface - │ └── HYCOM --------- HYCOM ocean model - │ └── (NUOPC) --------- NUOPC HYCOM cap - ├── MOM6-interface - │ └── MOM6 - │ ├── (src) --------- MOM6 ocean model - │ └── (config_source/drivers/nuopc_cap) --------- NUOPC MOM6 cap - ├── WW3 - │ └── (model) --------- WW3 model - │ └── (esmf) --------- NUOPC WW3 cap - ├── CDEPS-interface - │ └── CDEPS - │ ├── (datm) --------- CDEPS DATM - │ └── (docn) --------- CDEPS DOCN - ├── CMEPS-interface - │ └── CMEPS - │ └── (cesm) --------- CMEPS CESM - ├── modulefiles -------- system module files for supported HPC systems - └── tests -------- regression test infrastructure - └── parm - └── tests - └── fv3_conf - -The physics subdirectory in the ``gfsphysics`` directory is not used or supported -as part of this release (all physics is available through the :term:`CCPP` using -the repository described in :numref:`Table %s `). - -.. COMMENT: Should we omit CMakeLists.txt, CMakeModules, driver (which I added) or add a description? -.. COMMENT: I don't see a "gfsphysics" directory... Can we remove it or be more specific about where it is? There are two CCPP repos in the table referenced above... Framework and Physics. \ No newline at end of file + ufs-weather-model + ├── AQM + │ └── (src) + │ ├── (model) + │ └── (CMAQ) -------- EPA Air Quality Model + ├── build.sh -------- script for building the WM + ├── CDEPS-interface + │ └── CDEPS + │ ├── (datm) -------- CDEPS DATM + │ └── (docn) -------- CDEPS DOCN + ├── CICE-interface + │ └── CICE -------- CICE6 sea ice model + │ ├── (icepack) -------- Sea ice column physics + │ └── (cicecore/drivers/nuopc/cmeps) -------- NUOPC CICE6 cap + ├── cmake -------- cmake configuration files + ├── CMakeLists.txt + ├── CMakeModules + ├── CMEPS-interface + │ └── CMEPS + │ └── (cesm) -------- CMEPS CESM + ├── doc -------- User Guide files + ├── driver + ├── FV3 -------- UFSAtm atmosphere model + │ ├── (atmos_cubed_sphere) -------- FV3 dynamical core + │ │ ├── (docs) + │ │ ├── (driver) + │ │ ├── (model) + │ │ └── (tools) + │ ├── (ccpp) -------- Common Community Physics Package + │ │ ├── (config) + │ │ ├── (driver) + │ │ ├── (framework) -------- CCPP framework + │ │ ├── (physics) -------- CCPP-compliant physics schemes + │ │ └── (suites) -------- CCPP physics suite definition files (SDFs) + │ ├── (cpl) -------- Coupling field data structures + │ ├── (io) -------- UFSAtm write grid comp code + │ └── (stochastic_physics) -------- Wrapper for stochastic physics + ├── GOCART + │ └── (ESMF) -------- GOCART model + ├── HYCOM-interface + │ └── HYCOM -------- HYCOM ocean model + │ └── (NUOPC) -------- NUOPC HYCOM cap + ├── LICENSE.md + ├── modulefiles -------- system module files for supported HPC systems + ├── MOM6-interface + │ └── MOM6 + │ ├── (src) -------- MOM6 ocean model + │ └── (config_source/drivers/nuopc_cap) -------- NUOPC MOM6 cap + ├── NOAHMP-interface + │ └── noahmp + │ ├── (cmake) -------- Noah-MP land model + │ ├── (drivers/nuopc) -------- NUOPC Noah-MP cap + │ ├── (parameters) + │ └── (src) + ├── README.md + ├── stochastic_physics -------- stochastic physics pattern generator + ├── tests -------- regression test infrastructure + │ └── parm + │ └── tests + │ └── fv3_conf + └── WW3 + └── (model) -------- WW3 model + └── (esmf) -------- NUOPC WW3 cap \ No newline at end of file From 469abc34a20480cc0005487f70dafa88840045a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Tue, 2 May 2023 20:27:26 -0400 Subject: [PATCH 03/44] update Build/Run ch --- doc/UsersGuide/source/BuildingAndRunning.rst | 342 +++++++++++++++---- 1 file changed, 268 insertions(+), 74 deletions(-) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index 4322eb0529..d6e851ca7d 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -8,62 +8,206 @@ Building and Running the UFS Weather Model Supported Platforms & Compilers =================================== Before running the Weather Model (:term:`WM`), users should determine which of the -`levels of support `__ +:ref:`levels of support ` is applicable to their system. Generally, Level 1 & 2 systems are restricted to those with access through NOAA and its affiliates. These systems are named (e.g., Hera, Orion, Cheyenne). Level 3 & 4 systems include certain personal computers or non-NOAA-affiliated HPC systems. The prerequisite software libraries for building the WM already exist on Level 1/preconfigured -systems, so users may skip directly :ref:`downloading the code `. -On other systems, users will need to build the prerequisite libraries using :term:`HPC-Stack`. +systems, so users may skip directly to :ref:`getting the data ` and downloading the code. +On other systems, users will need to build the prerequisite libraries using :term:`HPC-Stack` or :term:`spack-stack`. -====================== +======================= Prerequisite Libraries -====================== +======================= -The UFS Weather Model (WM) requires a number of libraries for it to compile. +The UFS Weather Model (:term:`WM`) requires a number of libraries. The WM uses two categories of libraries, which are available as a bundle via -:term:`HPC-Stack`: +:term:`HPC-Stack` or :term:`spack-stack`: #. :term:`NCEP` libraries (:term:`NCEPLIBS`): These are libraries developed for use with NOAA weather models. Most have an NCEPLIBS prefix in the repository (e.g., NCEPLIBS-bacio). Select tools from the UFS Utilities repository (:term:`UFS_UTILS`) are also included in this category. - A list of the bundled libraries tested with this WM release is available in the top-level ``README`` of the - `NCEPLIBS repository `__ (**be sure to look at - the tag in that repository that matches the tag on the most recent WM release**). #. Third-party libraries (:term:`NCEPLIBS-external`): These are libraries that were developed external to the UFS Weather Model. They are general software packages that are also used by other community models. Building these libraries is optional if users can point to existing builds of these libraries on their system - instead. A list of the external libraries tested with this WM release is in the top-level ``README`` - of the `NCEPLIBS-external `__ repository. Again, be - sure to look at the tag in that repository that matches the tag on this WM release. + instead. -.. note:: - Documentation is available for installing `HPC-Stack `__. - One of these software stacks (or the libraries they contain) must be installed before running the Weather Model. +Currently, HPC-Stack is the software stack validated by the UFS WM for running regression tests. +However, UFS applications are shifting to spack-stack, which is a Spack-based +method for installing UFS prerequisite software libraries. The spack-stack is currently +used on NOAA Cloud platforms and in containers, while HPC-Stack is still used on NOAA +Research & Development HPC Systems (RDHPCS). The spack-stack locations listed in :numref:`Table %s ` are still being validated. -.. COMMENT: "and `spack-stack `__, respectively" +---------------- +Common Modules +---------------- -For users who *do* need to build the prerequisite libraries, it is a good idea to check the platform- and compiler-specific -``README`` files in the ``doc`` directory of the `NCEPLIBS-external repository `_ -first to see if their system or one similar to it is included. These files have detailed -instructions for building NCEPLIBS-external, NCEPLIBS, and the UFS Weather Model. They may be all the -documentation you need. Be sure to use the tag that corresponds to this version of the WM, and define a -WORK directory path before you get started. +As of March 23, 2023, the UFS WM Regression Tests on Level 1 systems use the following common modules: -.. - COMMENT: What is meant by a WORK directory path? +.. code-block:: console + + bacio/2.4.1 + crtm/2.4.0 + esmf/8.3.0b09 + fms/2022.04 + g2/3.4.5 + g2tmpl/1.10.2 + gftl-shared/v1.5.0 + hdf5/1.10.6 + ip/3.3.3 + jasper/2.0.25 + libpng/1.6.37 + mapl/2.22.0-esmf-8.3.0b09 + netcdf/4.7.4 + pio/2.5.7 + sp/2.3.3 + w3emc/2.9.2 + zlib/1.2.11 + +The most updated list of modules can be viewed in ``ufs_common.lua`` +`here `__. -If your platform is not included in these platform- and compiler-specific ``README`` files, there is a more -generic set of instructions in the ``README`` file at the top level of the `NCEPLIBS-external repository -`__ and at the top level of the `NCEPLIBS repository -`__. It may still be a good idea to look at some of the platform- -and compiler-specific ``README`` files as a guide. Again, be sure to use the tag that corresponds to this version of the WM. +.. attention:: + Documentation is available for installing `HPC-Stack `__ + and `spack-stack `__, respectively. + One of these software stacks (or the libraries they contain) must be installed before running the UFS Weather Model. + +.. COMMENT: Add spack stack (and HPC-Stack?) locations: + On Level 1 systems, HPC-Stack and spack-stack are installed in the following locations: + + .. _stack-locations: + + .. table:: Stack Locations + + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Platform | HPC-Stack/spack-stack Installation | + +==============+=========================================================================================================================================+ + | WCOSS2 | N/A | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Hera (Intel) | HPC-Stack: /scratch1/NCEPDEV/nems/role.epic/hpc-stack/libs/intel-2022.1.2/modulefiles/stack | + | | | + | | spack-stack: /scratch1/NCEPDEV/jcsda/jedipara/spack-stack/modulefiles | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Hera (GNU) | HPC-Stack: /scratch1/NCEPDEV/nems/role.epic/hpc-stack/libs/gnu-9.2/modulefiles/stack | + | | | + | | spack-stack: /scratch1/NCEPDEV/global/spack-stack/spack-stack-v1/envs/skylab-3.0.0-intel-2021.5.0/install/modulefiles/Core | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Gaea | HPC-Stack: /lustre/f2/dev/role.epic/contrib/hpc-stack/intel-2021.3.0_noarch/modulefiles/stack | + | | | + | | spack-stack: /lustre/f2/pdata/esrl/gsd/spack-stack/modulefiles | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Jet | HPC-Stack: /mnt/lfs4/HFIP/hfv3gfs/role.epic/hpc-stack/libs/intel-2022.1.2/modulefiles/stack | + | | | + | | spack-stack: Coming soon! | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Orion | HPC-Stack: /work/noaa/epic-ps/role-epic-ps/hpc-stack/libs/intel-2022.1.2/modulefiles/stack | + | | | + | | spack-stack: /work/noaa/da/role-da/spack-stack/modulefiles | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Cheyenne | HPC-Stack: /glade/work/epicufsrt/contrib/hpc-stack/intel2022.1/modulefiles/stack | + | (Intel) | | + | | spack-stack: /glade/work/jedipara/cheyenne/spack-stack/modulefiles/misc | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Cheyenne | HPC-Stack: /glade/work/epicufsrt/contrib/hpc-stack/gnu10.1.0/modulefiles/stack | + | (GNU) | | + | | spack-stack: /glade/work/jedipara/cheyenne/spack-stack/spack-stack-feature-r2d2-mysql/envs/unified-4.0.0-rc1/install/modulefiles/Core | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | NOAA Cloud | HPC-Stack: N/A | + | (AWS/GCP/ | | + | Azure) | spack-stack: /contrib/spack-stack/modulefiles/core | + +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + + On Level 2-4 Systems, users will need to install the HPC-Stack or the spack-stack and load the appropriate modules. + The `HPC-Stack `__ and + `spack-stack `__ documentation is the authoritative + source for details on installation and configuration of each respective stack. + +.. _GetData: + +============ +Get Data +============ + +The WM regression tests (RTs) require input files to run. +These include static datasets, files that depend on grid resolution and +initial/boundary conditions, and model configuration files. On Level 1 systems, +the data required to run the WM RTs are already available in the following locations: + +.. _DataLocations: +.. table:: Data Locations for Level 1 Systems + + +--------------+-----------------------------------------------------+ + | Machine | File location | + +==============+=====================================================+ + | Cheyenne | /glade/scratch/epicufsrt/GMTB/ufs-weather-model/RT | + +--------------+-----------------------------------------------------+ + | Gaea | /lustre/f2/pdata/ncep_shared/emc.nemspara/RT | + +--------------+-----------------------------------------------------+ + | Hera | /scratch1/NCEPDEV/nems/emc.nemspara/RT | + +--------------+-----------------------------------------------------+ + | Jet | /mnt/lfs4/HFIP/hfv3gfs/role.epic/RT | + +--------------+-----------------------------------------------------+ + | Orion | /work/noaa/nems/emc.nemspara/RT | + +--------------+-----------------------------------------------------+ + | WCOSS2 | /lfs/h2/emc/nems/noscrub/emc.nems/RT | + +--------------+-----------------------------------------------------+ + +For Level 2-4 systems, the data must be added to the user's system. +Publicly available RT data is available in the `UFS WM Data Bucket `__. +Data for running RTs off of the develop branch is available for the most recent 60 days. +To view the data, users can visit https://noaa-ufs-regtests-pds.s3.amazonaws.com/index.html. +To download data, users must select the data they want from the bucket and either download it in their browser or via a ``wget`` command. +For example, to get the data for ``control_p8`` (specifically the March 20, 2023 ``develop`` branch version of the WM), run: -The top-level ``README`` in the NCEPLIBS-external repository includes a troubleshooting section that may be helpful. +.. code-block:: console -You can also get expert help through a `user support forum `__ -set up specifically for issues related to build dependencies. + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/atmf000.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/atmf021.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/atmf024.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/GFSFLX.GrbF00 + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/GFSFLX.GrbF21 + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/GFSFLX.GrbF24 + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/GFSPRS.GrbF00 + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/GFSPRS.GrbF21 + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/GFSPRS.GrbF24 + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/sfcf000.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/sfcf021.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/sfcf024.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.coupler.res + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.tile1.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.tile2.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.tile3.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.tile4.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.tile5.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_core.res.tile6.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_srf_wnd.res.tile1.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_srf_wnd.res.tile2.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_srf_wnd.res.tile3.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_srf_wnd.res.tile4.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_srf_wnd.res.tile5.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_srf_wnd.res.tile6.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_tracer.res.tile1.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_tracer.res.tile2.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_tracer.res.tile3.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_tracer.res.tile4.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_tracer.res.tile5.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.fv_tracer.res.tile6.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.phy_data.tile1.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.phy_data.tile2.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.phy_data.tile3.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.phy_data.tile4.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.phy_data.tile5.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.phy_data.tile6.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.sfc_data.tile1.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.sfc_data.tile2.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.sfc_data.tile3.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.sfc_data.tile4.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.sfc_data.tile5.nc + wget https://noaa-ufs-regtests-pds.s3.amazonaws.com/develop-20230426/INTEL/control_p8/RESTART/20210323.060000.sfc_data.tile6.nc + +Detailed information on input files can be found in :numref:`Chapter %s `. .. _DownloadingWMCode: @@ -75,9 +219,8 @@ To clone the develop branch of the ``ufs-weather-model`` repository and update i .. code-block:: console - git clone https://github.com/ufs-community/ufs-weather-model.git ufs-weather-model + git clone --recursive https://github.com/ufs-community/ufs-weather-model.git ufs-weather-model cd ufs-weather-model - git submodule update --init --recursive Compiling the model will take place within the ``ufs-weather-model`` directory you just created. @@ -89,9 +232,16 @@ Building the Weather Model Loading the Required Modules ---------------------------- -Modulefiles for `pre-configured platforms `_ -are located in ``modulefiles/ufs_.``. For example, to load the modules from the ``ufs-weather-model`` -directory on Hera: +The process for loading modules is fairly straightforward on NOAA :ref:`Level 1 Systems `. +Users may need to make adjustments when running on other systems. + + +On NOAA Level 1 Systems +--------------------------- + +Modulefiles for :ref:`preconfigured platforms ` are located in +``modulefiles/ufs_.``. For example, to load the modules from the +``ufs-weather-model`` directory on Hera: .. code-block:: console @@ -117,6 +267,9 @@ Note that loading this module file will also set the CMake environment variables | CMAKE_Platform | String containing platform and compiler name | hera.intel | +-------------------------+----------------------------------------------+----------------------+ +On Other Systems +------------------- + If you are not running on one of the pre-configured platforms, you will need to set the environment variables manually. For example, in a bash shell, a command in the following form will set the C compiler environment variable: @@ -124,12 +277,13 @@ manually. For example, in a bash shell, a command in the following form will set export CMAKE_C_COMPILER= +.. COMMENT: Update after Zach's PR is merged. ------------------------------------------------------------------------ Setting the ``CMAKE_FLAGS`` and ``CCPP_SUITES`` Environment Variables ------------------------------------------------------------------------ -The UFS Weather Model can be built in one of twelve configurations (cf. :numref:`Table %s `). +The UFS Weather Model can be built in one of several configurations (cf. :numref:`Table %s ` for common options). The ``CMAKE_FLAGS`` environment variable specifies which configuration to build. Additionally, users must select the :term:`CCPP` suite(s) by setting the ``CCPP_SUITES`` environment variable at build time in order to have one or more CCPP physics suites available at runtime. Multiple suites can be set. @@ -265,7 +419,10 @@ For the ``ufs-weather-model HAFS-ALL`` configuration (data/atm/ocean/wave) in 32 ------------------ Building the Model ------------------ -The UFS Weather Model uses the CMake build system. There is a build script called ``build.sh`` in the + +.. COMMENT: Is the "Building the Model" section necessary? Can users just run the RT without? + +The UFS Weather Model uses the CMake build system. There is a build script called ``build.sh`` in the top-level directory of the WM repository that configures the build environment and runs the ``make`` command. This script also checks that all necessary environment variables have been set. @@ -282,11 +439,10 @@ The WM can be built by running the following command from the ``ufs-weather-mode ./build.sh Once ``build.sh`` is finished, you should see the executable, named ``ufs_model``, in the ``ufs-weather-model/build/`` directory. -If it is desired to build in a different directory, specify the ``BUILD_DIR`` environment variable: e.g. ``export BUILD_DIR=test_cpld`` +If it is desired to build in a different directory, specify the ``BUILD_DIR`` environment variable. For example: ``export BUILD_DIR=test_cpld`` will build in the ``ufs-weather-model/test_cpld`` directory instead. -Expert help is available through a `user support forum `__ -set up specifically for issues related to the Weather Model. +Expert help is available through `GitHub Discussions `__. Users may post questions there for help with difficulties related to the UFS WM. .. _run-wm: @@ -304,20 +460,11 @@ Running the Model Using the Regression Test Script -------------------------------- -Users can run a number of preconfigured regression test cases using the regression test script -``rt.sh`` in the ``tests`` directory. This script is the top-level script -that calls lower-level scripts to build specified WM configurations, set up environments, and run tests. - -On `Tier-1 platforms `__, users can run -regression tests by (1) editing the ``rt.conf`` file and (2) executing: - -.. code-block:: console - - ./rt.sh -l rt.conf - -Users *may* need to add additional command line arguments or change information in the ``rt.sh`` file as well. -This information is provided in :numref:`Section %s ` below. +Users can run a number of preconfigured regression test cases from the ``rt.conf`` file +using the regression test script ``rt.sh`` in the ``tests`` directory. +``rt.sh`` is the top-level script that calls lower-level scripts to build specified +WM configurations, set up environments, and run tests. +Users must edit the ``rt.conf`` file to indicate which tests/configurations to run. .. _rt.conf: @@ -354,7 +501,38 @@ by a ``COMPILE`` line that builds the model used in the test. The following The ``rt.conf`` file includes a large number of tests. If the user wants to run only specific tests, s/he can either (1) comment out the tests to be skipped (using the ``#`` prefix) -or (2) create a new file (e.g., ``my_rt.conf``) and execute ``./rt.sh -l my_rt.conf``. +or (2) create a new file (e.g., ``my_rt.conf``), add the tests, and execute ``./rt.sh -l my_rt.conf``. + +On NOAA RDHPCS +------------------ + +On `Tier-1 platforms `__, users can run +regression tests by editing the ``rt.conf`` file and executing: + +.. code-block:: console + + ./rt.sh -l rt.conf + +Users may need to add additional command line arguments or change information in the ``rt.sh`` file as well. +This information is provided in :numref:`Section %s ` below. + +On Other Systems +------------------ + +Users on non-NOAA systems will need to make adjustments to several files in the +``tests`` directory before running ``rt.sh``, including: + + * rt.sh + * run_test.sh + * detect_machine.sh + * default_vars.sh + * fv3_conf/fv3_slurm.IN_* + * fv3_conf/compile_slurm.IN_* + * compile.sh + * module-setup.sh + +.. COMMENT: Add details when Zach's PR is merged. .. _rt.sh: @@ -372,18 +550,18 @@ To display detailed information on how to use ``rt.sh``, users can simply run `` .. code-block:: console - ./rt.sh -c | -f | -l | -m | -k | -r | -e | -h - -c: create baseline - -f: use rt.conf - -l: use instead of rt.conf - -m: compare against new baseline results - -k: keep run directory - -r: use Rocoto workflow manager - -e: use ecFlow workflow manager - -h: display help (same as ./rt.sh) - -.. COMMENT: Remove -f option? The wiki says: "Update 01/06/2021: On January 6, 2021, the argument -f was removed. - Adding it will force rt.sh to exit immediately. The default for rt.sh is to run the full regression tests in rt.conf unless -l xyz.conf is provided." + ./rt.sh -c | -e | -h | -k | -w | -d | -l | -m | -n | -r + -c create new baseline results + -e use ecFlow workflow manager + -h display this help + -k keep run directory after rt.sh is completed + -l runs test specified in + -m compare against new baseline results + -n run single test + -r use Rocoto workflow manager + -w for weekly_test, skip comparing baseline results + -d delete run direcotries that are not used by other tests + .. COMMENT: An -n option is discussed below. Why is this not printed when running ./rt.sh? When running a large number (10's or 100's) of tests, the ``-e`` or ``-r`` options can significantly @@ -391,9 +569,25 @@ decrease testing time by using a workflow manager (ecFlow or Rocoto, respectivel according to dependencies and run them concurrently. The ``-n`` option can be used to run a single test; for example, ``./rt.sh -n control`` will build the ATM model and run the ``control`` test. -The ``-c`` option is used to create a baseline. New baslines are needed when code changes lead +The ``-c`` option is used to create a baseline. New baselines are needed when code changes lead to result changes and therefore deviate from existing baselines on a bit-for-bit basis. +To run ``rt.sh`` using a custom configuration file and the Rocoto workflow manager, +creat the configuration file (e.g. ``my_rt.conf``) based on the desired tests in +``rt.conf``, and run: + +.. code-block:: console + + ./rt.sh -r -l my_rt.conf + +adding additional arguments as desired. + +To run a single test, users can try the following command instead of creating a ``my_rt.conf`` file: + +.. code-block:: console + + ./rt.sh -r -k -n control_p8 + Troubleshooting ^^^^^^^^^^^^^^^^^^ @@ -445,7 +639,7 @@ specifying the ``-k`` option retains the ``$RUNDIR``, e.g. ``./rt.sh -l rt.conf Inside the ``$RUNDIR`` directory are a number of model configuration files (``input.nml``, ``model_configure``, ``nems.configure``) and other application -dependent files (e.g., ``ice_in`` for the Subseasonal-to-Seasonal application). +dependent files (e.g., ``ice_in`` for the Subseasonal-to-Seasonal Application). These model configuration files are generated by ``rt.sh`` from the template files in the ``tests/parm`` directory. Specific values used to fill in the template files are test-dependent and @@ -508,11 +702,11 @@ Using the Operational Requirement Test Script The operational requirement test script ``opnReqTest`` in the ``tests`` directory can be used to run tests in place of ``rt.sh``. Given the name of a test, ``opnReqTest`` carries out a suite of test cases. Each test case addresses an aspect of the requirements that new operational implementations -should satisfy. These requirements are shown in :numref:`Table %s `. +must satisfy. These requirements are shown in :numref:`Table %s `. For the following discussions on opnReqTest, the user should note the distinction between ``'test name'`` and ``'test case'``. Examples of test names are ``control``, ``cpld_control`` and ``regional_control`` which are all found in the ``tests/tests`` directory, whereas -test case refers to any one of ``thr``, ``mpi``, ``dcp``, ``rst``, ``bit`` and ``dbg``. +test case refers to any one of the operational requirements: ``thr``, ``mpi``, ``dcp``, ``rst``, ``bit`` and ``dbg``. .. _OperationalRequirement: From 19a1e7603744ebf0f3b17098195acd6d303e9276 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Tue, 2 May 2023 20:41:48 -0400 Subject: [PATCH 04/44] add land build options to Build/Run ch --- doc/UsersGuide/source/BuildingAndRunning.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index d6e851ca7d..6a1117d545 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -326,6 +326,14 @@ For the ``ufs-weather-model ATMAQ`` configuration (standalone ATM coupled to :te export CMAKE_FLAGS="-DAPP=ATMAQ -DCCPP_SUITES=FV3_GFS_v15p2" +**ATML** + +For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :term:`LND`): + +.. code-block:: console + + export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=datm_cdeps_lnd_gswp3" + S2S Configurations ---------------------- @@ -415,6 +423,16 @@ For the ``ufs-weather-model HAFS-ALL`` configuration (data/atm/ocean/wave) in 32 export CMAKE_FLAGS="-DAPP=HAFS-ALL -D32BIT=ON -DCCPP_SUITES=FV3_HAFS_v0_gfdlmp_tedmf,FV3_HAFS_v0_gfdlmp_tedmf_nonsst" +LND Configurations +---------------------- + +**LND** + +For the ``ufs-weather-model LND`` configuration (datm/land): + +.. code-block:: console + + export CMAKE_FLAGS="-DAPP=LND" ------------------ Building the Model From 48f2eb539b8d57f1a1d098c59f36667bd3a05dad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 3 May 2023 10:19:55 -0400 Subject: [PATCH 05/44] add LND def to Glossary --- doc/UsersGuide/source/Glossary.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index ba105504db..bfd7336587 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -90,6 +90,10 @@ Glossary HYCOM The HYbrid Coordinate Ocean Model (`HYCOM `__) was developed to address known shortcomings in the vertical coordinate scheme of the Miami Isopycnic-Coordinate Ocean Model (MICOM). HYCOM is a primitive equation, general circulation model with vertical coordinates that remain isopycnic in the open, stratified ocean. However, the isopycnal vertical coordinates smoothly transition to z-coordinates in the weakly stratified upper-ocean mixed layer, to terrain-following sigma coordinates in shallow water regions, and back to z-level coordinates in very shallow water. The latter transition prevents layers from becoming too thin where the water is very shallow. See the `HYCOM User's Guide `__ for more information on using the model. The `HYCOM model code `__ is publicly available on GitHub. + LND + land component + The Noah Multi-Physics (Noah-MP) land surface model (LSM) is an open-source, community-developed LSM that has been incorporated into the UFS Weather Model (WM). It is the UFS WM's land component. + Mediator A mediator, sometimes called a coupler, is a software component that includes code for representing component interactions. Typical operations include merging data fields, ensuring consistent treatment of coastlines, computing fluxes, and temporal averaging. From b8779a6e45c18cfb5e14fa12b59a61a79bbb0d61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 3 May 2023 10:34:57 -0400 Subject: [PATCH 06/44] add note --- doc/UsersGuide/source/BuildingAndRunning.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index 6a1117d545..f58d47bb16 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -37,7 +37,10 @@ Currently, HPC-Stack is the software stack validated by the UFS WM for running r However, UFS applications are shifting to spack-stack, which is a Spack-based method for installing UFS prerequisite software libraries. The spack-stack is currently used on NOAA Cloud platforms and in containers, while HPC-Stack is still used on NOAA -Research & Development HPC Systems (RDHPCS). The spack-stack locations listed in :numref:`Table %s ` are still being validated. +Research & Development HPC Systems (RDHPCS). + +.. COMMENT: Is this still true? + The spack-stack locations listed in :numref:`Table %s ` are still being validated. ---------------- Common Modules From 6d4040ddc9aefc36455ab16c6536fd001678fbf5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 3 May 2023 10:38:22 -0400 Subject: [PATCH 07/44] fix ATML physics --- doc/UsersGuide/source/BuildingAndRunning.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index f58d47bb16..cbb62ca69e 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -335,7 +335,7 @@ For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :ter .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=datm_cdeps_lnd_gswp3" + export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=control_p8_atmlnd_sbs" S2S Configurations ---------------------- From 71701570dc316c06a09b871fe20e6f0af79d949f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 11 May 2023 23:06:28 -0400 Subject: [PATCH 08/44] move nems.configure samples to samples file --- doc/UsersGuide/source/InputsOutputs.rst | 638 +----------------- .../source/samples/nems.configure.ATMAQ.rst | 38 ++ .../source/samples/nems.configure.HAFS.rst | 110 +++ .../samples/nems.configure.NG-GODAS.rst | 131 ++++ .../source/samples/nems.configure.S2S.rst | 129 ++++ .../source/samples/nems.configure.S2SW.rst | 103 +++ .../source/samples/nems.configure.S2SWA.rst | 140 ++++ 7 files changed, 665 insertions(+), 624 deletions(-) create mode 100644 doc/UsersGuide/source/samples/nems.configure.ATMAQ.rst create mode 100644 doc/UsersGuide/source/samples/nems.configure.HAFS.rst create mode 100644 doc/UsersGuide/source/samples/nems.configure.NG-GODAS.rst create mode 100644 doc/UsersGuide/source/samples/nems.configure.S2S.rst create mode 100644 doc/UsersGuide/source/samples/nems.configure.S2SW.rst create mode 100644 doc/UsersGuide/source/samples/nems.configure.S2SWA.rst diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst index 31e3280b80..e4365c5b13 100644 --- a/doc/UsersGuide/source/InputsOutputs.rst +++ b/doc/UsersGuide/source/InputsOutputs.rst @@ -1425,7 +1425,7 @@ are not usually changed. ``nems.configure`` file ------------------------ -This file contains information about the various NEMS components and their run sequence. The active components for a particular model configuration are given in the *EARTH_component_list*. For each active component, the model name and compute tasks assigned to the component are given. A specific component might also require additional configuration information to be present. The ``runSeq`` describes the order and time intervals over which one or more component models integrate in time. Additional *attributes*, if present, provide additional configuration of the model components when coupled with the CMEPS mediator. +This file contains information about the various NEMS components and their run sequence. The active components for a particular model configuration are given in the *EARTH_component_list*. For each active component, the model name and compute tasks assigned to the component are given. A specific component might also require additional configuration information to be present. The ``runSeq`` describes the order and time intervals over which one or more component models integrate in time. Additional *attributes*, if present, provide additional configuration of the model components when coupled with the CMEPS mediator. For the ATM application, since it consists of a single component, the ``nems.configure`` is simple and does not need to be changed. A sample of the file contents is shown below: @@ -1438,639 +1438,29 @@ A sample of the file contents is shown below: ATM :: +However, ``nems.configure`` files for other configurations of the Weather Model are more complex. A number of samples are available below: -For the fully coupled S2SW application, a sample ``nems.configure`` is shown below : + * :doc:`ATMAQ ` configuration + * :doc:`S2S ` (fully coupled ``S2S`` configuration that receives atmosphere-ocean fluxes from a mediator) -.. code-block:: console - - # EARTH # - EARTH_component_list: MED ATM OCN ICE WAV - EARTH_attributes:: - Verbosity = 0 - :: - - # MED # - MED_model: cmeps - MED_petlist_bounds: 0 143 - :: - - # ATM # - ATM_model: fv3 - ATM_petlist_bounds: 0 149 - ATM_attributes:: - :: - - # OCN # - OCN_model: mom6 - OCN_petlist_bounds: 150 179 - OCN_attributes:: - mesh_ocn = mesh.mx100.nc - :: - - # ICE # - ICE_model: cice6 - ICE_petlist_bounds: 180 191 - ICE_attributes:: - mesh_ice = mesh.mx100.nc - :: - - # WAV # - WAV_model: ww3 - WAV_petlist_bounds: 192 395 - WAV_attributes:: - :: - - # CMEPS warm run sequence - runSeq:: - @3600 - MED med_phases_prep_ocn_avg - MED -> OCN :remapMethod=redist - OCN -> WAV - WAV -> OCN :srcMaskValues=1 - OCN - @900 - MED med_phases_prep_atm - MED med_phases_prep_ice - MED -> ATM :remapMethod=redist - MED -> ICE :remapMethod=redist - WAV -> ATM :srcMaskValues=1 - ATM -> WAV - ICE -> WAV - ATM - ICE - WAV - ATM -> MED :remapMethod=redist - MED med_phases_post_atm - ICE -> MED :remapMethod=redist - MED med_phases_post_ice - MED med_phases_prep_ocn_accum - @ - OCN -> MED :remapMethod=redist - MED med_phases_post_ocn - MED med_phases_restart_write - @ - :: - - # CMEPS variables - - :: - MED_attributes:: - ATM_model = fv3 - ICE_model = cice6 - OCN_model = mom6 - history_n = 1 - history_option = nhours - history_ymd = -999 - coupling_mode = nems_orig - :: - ALLCOMP_attributes:: - ScalarFieldCount = 2 - ScalarFieldIdxGridNX = 1 - ScalarFieldIdxGridNY = 2 - ScalarFieldName = cpl_scalars - start_type = startup - restart_dir = RESTART/ - case_name = ufs.cpld - restart_n = 24 - restart_option = nhours - restart_ymd = -999 - dbug_flag = 0 - use_coldstart = false - use_mommesh = true - :: - - -For the coupled NG_GODAS application, a sample ``nems.configure`` is shown below : - -.. code-block:: console + .. COMMENT: Is this a regular S2S nems.configure file, or is it special? What's the talk about "atmosphere-oceans fluxes"? - # EARTH # - EARTH_component_list: MED ATM OCN ICE - EARTH_attributes:: - Verbosity = 0 - :: - - # MED # - MED_model: cmeps - MED_petlist_bounds: 0 11 - Verbosity = 5 - dbug_flag = 5 - - :: - - # ATM # - ATM_model: datm - ATM_petlist_bounds: 0 11 - ATM_attributes:: - Verbosity = 0 - DumpFields = false - mesh_atm = DATM_INPUT/cfsr_mesh.nc - diro = "." - logfile = atm.log - stop_n = 24 - stop_option = nhours - stop_ymd = -999 - write_restart_at_endofrun = .true. - :: - - # OCN # - OCN_model: mom6 - OCN_petlist_bounds: 12 27 - OCN_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - mesh_ocn = mesh.mx100.nc - :: - - # ICE # - ICE_model: cice6 - ICE_petlist_bounds: 28 39 - ICE_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - mesh_ice = mesh.mx100.nc - stop_n = 12 - stop_option = nhours - stop_ymd = -999 - :: - - # CMEPS concurrent warm run sequence - - runSeq:: - @3600 - MED med_phases_prep_ocn_avg - MED -> OCN :remapMethod=redist - OCN - @900 - MED med_phases_prep_ice - MED -> ICE :remapMethod=redist - ATM - ICE - ATM -> MED :remapMethod=redist - MED med_phases_post_atm - ICE -> MED :remapMethod=redist - MED med_phases_post_ice - MED med_phases_aofluxes_run - MED med_phases_prep_ocn_accum - @ - OCN -> MED :remapMethod=redist - MED med_phases_post_ocn - MED med_phases_restart_write - @ - :: - - # CMEPS variables - - DRIVER_attributes:: - mediator_read_restart = false - :: - MED_attributes:: - ATM_model = datm - ICE_model = cice6 - OCN_model = mom6 - history_n = 1 - history_option = nhours - history_ymd = -999 - coupling_mode = nems_orig_data - :: - ALLCOMP_attributes:: - ScalarFieldCount = 3 - ScalarFieldIdxGridNX = 1 - ScalarFieldIdxGridNY = 2 - ScalarFieldIdxNextSwCday = 3 - ScalarFieldName = cpl_scalars - start_type = startup - restart_dir = RESTART/ - case_name = DATM_CFSR - restart_n = 12 - restart_option = nhours - restart_ymd = -999 - dbug_flag = 0 - use_coldstart = false - use_mommesh = true - coldair_outbreak_mod = .false. - flds_wiso = .false. - flux_convergence = 0.0 - flux_max_iteration = 2 - ocn_surface_flux_scheme = 0 - orb_eccen = 1.e36 - orb_iyear = 2000 - orb_iyear_align = 2000 - orb_mode = fixed_year - orb_mvelp = 1.e36 - orb_obliq = 1.e36 - :: - -For the coupled HAFS application, a sample ``nems.configure`` is shown below : + * :doc:`S2SW ` (fully coupled ``S2SW`` configuration) + * :doc:`S2SWA ` (coupled GOCART in the S2SAW configuration) + * :doc:`NG-GODAS ` (coupled NG-GODAS configuration) + * :doc:`HAFS ` (coupled HAFS configuration) -.. code-block:: console - - # EARTH # - EARTH_component_list: ATM OCN MED - - # MED # - MED_model: cmeps - MED_petlist_bounds: 1340 1399 - MED_attributes:: - coupling_mode = hafs - system_type = ufs - normalization = none - merge_type = copy - ATM_model = fv3 - OCN_model = hycom - history_ymd = -999 - ScalarFieldCount = 0 - ScalarFieldIdxGridNX = 0 - ScalarFieldIdxGridNY = 0 - ScalarFieldName = cpl_scalars - :: - - # ATM # - ATM_model: fv3 - ATM_petlist_bounds: 0000 1339 - ATM_attributes:: - Verbosity = 1 - Diagnostic = 0 - :: - - # OCN # - OCN_model: hycom - OCN_petlist_bounds: 1340 1399 - OCN_attributes:: - Verbosity = 1 - Diagnostic = 0 - cdf_impexp_freq = 3 - cpl_hour = 0 - cpl_min = 0 - cpl_sec = 360 - base_dtg = 2020082512 - merge_import = .true. - skip_first_import = .true. - hycom_arche_output = .false. - hyc_esmf_exp_output = .true. - hyc_esmf_imp_output = .true. - import_diagnostics = .false. - import_setting = flexible - hyc_impexp_file = nems.configure - espc_show_impexp_minmax = .true. - ocean_start_dtg = 43702.50000 - start_hour = 0 - start_min = 0 - start_sec = 0 - end_hour = 12 - end_min = 0 - end_sec = 0 - :: - - DRIVER_attributes:: - start_type = startup - :: - - ALLCOMP_attributes:: - mediator_read_restart = false - :: - - # CMEPS cold run sequence - - runSeq:: - @360 - ATM -> MED :remapMethod=redist - MED med_phases_post_atm - OCN -> MED :remapMethod=redist - MED med_phases_post_ocn - MED med_phases_prep_atm - MED med_phases_prep_ocn_accum - MED med_phases_prep_ocn_avg - MED -> ATM :remapMethod=redist - MED -> OCN :remapMethod=redist - ATM - OCN - @ - :: - - # HYCOM field coupling configuration (location set by hyc_impexp_file) - - ocn_export_fields:: - 'sst' 'sea_surface_temperature' 'K' - 'mask' 'ocean_mask' '1' - :: - - ocn_import_fields:: - 'taux10' 'mean_zonal_moment_flx_atm' 'N_m-2' - 'tauy10' 'mean_merid_moment_flx_atm' 'N_m-2' - 'prcp' 'mean_prec_rate' 'kg_m-2_s-1' - 'swflxd' 'mean_net_sw_flx' 'W_m-2' - 'lwflxd' 'mean_net_lw_flx' 'W_m-2' - 'mslprs' 'inst_pres_height_surface' 'Pa' - 'sensflx' 'mean_sensi_heat_flx' 'W_m-2' - 'latflx' 'mean_laten_heat_flx' 'W_m-2' - :: - -For more HAFS, HAFSW, and HAFS-ALL configurations please see the following nems.configure templates. - - * `HAFS ATM-OCN `_ - * `HAFS ATM-WAV `_ - * `HAFS ATM-OCN-WAV `_ - * `HAFS ATM-DOCN `_ - -For the coupled GOCART in S2SAW application, a sample ``nems.configure`` is shown below : - -.. code-block:: console + * For more HAFS, HAFSW, and HAFS-ALL configurations please see the following ``nems.configure`` templates: - # EARTH # - EARTH_component_list: MED ATM CHM OCN ICE WAV - EARTH_attributes:: - Verbosity = 0 - :: - - # MED # - MED_model: cmeps - MED_petlist_bounds: 0 287 - :: - - # ATM # - ATM_model: fv3 - ATM_petlist_bounds: 0 311 - ATM_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - :: - - # CHM # - CHM_model: gocart - CHM_petlist_bounds: 0 287 - CHM_attributes:: - Verbosity = 0 - :: - - # OCN # - OCN_model: mom6 - OCN_petlist_bounds: 312 431 - OCN_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - mesh_ocn = mesh.mx025.nc - :: - - # ICE # - ICE_model: cice6 - ICE_petlist_bounds: 432 479 - ICE_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - mesh_ice = mesh.mx025.nc - stop_n = 6 - stop_option = nhours - stop_ymd = -999 - :: - - # WAV # - WAV_model: ww3 - WAV_petlist_bounds: 480 559 - WAV_attributes:: - Verbosity = 0 - OverwriteSlice = false - :: - - # CMEPS warm run sequence - runSeq:: - @1800 - MED med_phases_prep_ocn_avg - MED -> OCN :remapMethod=redist - OCN -> WAV - WAV -> OCN :srcMaskValues=1 - OCN - @300 - MED med_phases_prep_atm - MED med_phases_prep_ice - MED -> ATM :remapMethod=redist - MED -> ICE :remapMethod=redist - WAV -> ATM :srcMaskValues=1 - ATM -> WAV - ICE -> WAV - ATM phase1 - ATM -> CHM - CHM - CHM -> ATM - ATM phase2 - ICE - WAV - ATM -> MED :remapMethod=redist - MED med_phases_post_atm - ICE -> MED :remapMethod=redist - MED med_phases_post_ice - MED med_phases_prep_ocn_accum - @ - OCN -> MED :remapMethod=redist - MED med_phases_post_ocn - MED med_phases_restart_write - @ - :: - - # CMEPS variables - - DRIVER_attributes:: - :: - - MED_attributes:: - ATM_model = fv3 - ICE_model = cice6 - OCN_model = mom6 - history_n = 1 - history_option = nhours - history_ymd = -999 - coupling_mode = nems_frac - history_tile_atm = 384 - :: - ALLCOMP_attributes:: - ScalarFieldCount = 2 - ScalarFieldIdxGridNX = 1 - ScalarFieldIdxGridNY = 2 - ScalarFieldName = cpl_scalars - start_type = startup - restart_dir = RESTART/ - case_name = ufs.cpld - restart_n = 6 - restart_option = nhours - restart_ymd = -999 - dbug_flag = 0 - use_coldstart = false - use_mommesh = true - eps_imesh = 1.0e-1 - stop_n = 6 - stop_option = nhours - stop_ymd = -999 - :: - -For the fully coupled S2S application that receives atmosphere-ocean fluxes from mediator, a sample ``nems.configure`` is shown below : - -.. code-block:: console - - # EARTH # - EARTH_component_list: MED ATM CHM OCN ICE WAV - EARTH_attributes:: - Verbosity = 0 - :: - - # MED # - MED_model: cmeps - MED_petlist_bounds: 0 143 - :: - - # ATM # - ATM_model: fv3 - ATM_petlist_bounds: 0 149 - ATM_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - :: - - # OCN # - OCN_model: mom6 - OCN_petlist_bounds: 150 269 - OCN_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - mesh_ocn = mesh.mx025.nc - :: - - # ICE # - ICE_model: cice6 - ICE_petlist_bounds: 270 317 - ICE_attributes:: - Verbosity = 0 - DumpFields = false - ProfileMemory = false - OverwriteSlice = true - mesh_ice = mesh.mx025.nc - stop_n = 840 - stop_option = nhours - stop_ymd = -999 - :: - - # CMEPS warm run sequence - runSeq:: - @720 - MED med_phases_prep_ocn_avg - MED -> OCN :remapMethod=redist - OCN - @720 - MED med_phases_aofluxes_run - MED med_phases_prep_atm - MED med_phases_prep_ice - MED -> ATM :remapMethod=redist - MED -> ICE :remapMethod=redist - ATM - ICE - ATM -> MED :remapMethod=redist - MED med_phases_post_atm - ICE -> MED :remapMethod=redist - MED med_phases_post_ice - MED med_phases_prep_ocn_accum - @ - OCN -> MED :remapMethod=redist - MED med_phases_post_ocn - MED med_phases_restart_write - MED med_phases_history_write - @ - :: - - # CMEPS variables - - DRIVER_attributes:: - :: - - MED_attributes:: - ATM_model = fv3 - ICE_model = cice6 - OCN_model = mom6 - history_n = 3 - history_option = nhours - history_ymd = -999 - coupling_mode = nems_frac_aoflux - history_tile_atm = 96 - aoflux_grid = 'xgrid' - aoflux_code = 'ccpp' - aoflux_ccpp_suite = 'FV3_sfc_ocean' - ccpp_restart_interval = -1 - ccpp_ini_mosaic_file = 'INPUT/C96_mosaic.nc' - ccpp_input_dir = 'INPUT/' - ccpp_ini_file_prefix = 'INPUT/sfc_data.tile' - ccpp_nstf_name = 2,1,0,0,0 - ccpp_ini_read = true - :: - ALLCOMP_attributes:: - ScalarFieldCount = 2 - ScalarFieldIdxGridNX = 1 - ScalarFieldIdxGridNY = 2 - ScalarFieldName = cpl_scalars - start_type = startup - restart_dir = RESTART/ - case_name = ufs.cpld - restart_n = 12 - restart_option = nhours - restart_ymd = -999 - dbug_flag = 0 - use_coldstart = false - use_mommesh = true - eps_imesh = 1.0e-1 - stop_n = 840 - stop_option = nhours - stop_ymd = -999 - :: + * `HAFS ATM-OCN `_ + * `HAFS ATM-WAV `_ + * `HAFS ATM-OCN-WAV `_ + * `HAFS ATM-DOCN `_ .. note:: The ``aoflux_grid`` option is used to select the grid/mesh to perform atmosphere-ocean flux calculation. The possible options are ``xgrid`` (exchange grid), ``agrid`` (atmosphere model grid) and ``ogrid`` (ocean model grid). .. note:: The ``aoflux_code`` option is used to define the algorithm that will be used to calculate atmosphere-ocean fluxes. The possible options are ``cesm`` and ``ccpp``. If ``ccpp`` is selected then the suite file provided in the ``aoflux_ccpp_suite`` option is used to calculate atmosphere-ocean fluxes through the use of CCPP host model. -For the ATMAQ application, a sample ``nems.configure`` is shown below : - -.. code-block:: console - - EARTH_component_list: ATM AQM - EARTH_attributes:: - Verbosity = 0 - :: - - # ATM # - ATM_model: fv3 - ATM_petlist_bounds: 0 271 - ATM_attributes:: - Verbosity = 0 - :: - - # AQM # - AQM_model: aqm - AQM_petlist_bounds: 0 271 - AQM_attributes:: - Verbosity = 0 - :: - - # Run Sequence # - runSeq:: - @180 - ATM phase1 - ATM -> AQM - AQM - AQM -> ATM - ATM phase2 - @ - :: - --------------------------------------- The Suite Definition File (SDF) File --------------------------------------- diff --git a/doc/UsersGuide/source/samples/nems.configure.ATMAQ.rst b/doc/UsersGuide/source/samples/nems.configure.ATMAQ.rst new file mode 100644 index 0000000000..006a275364 --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.ATMAQ.rst @@ -0,0 +1,38 @@ +:orphan: + +******************************************************************* +Sample ``nems.configure`` File for the ``ATMAQ`` WM Configuration +******************************************************************* + +.. code-block:: console + + EARTH_component_list: ATM AQM + EARTH_attributes:: + Verbosity = 0 + :: + + # ATM # + ATM_model: fv3 + ATM_petlist_bounds: 0 271 + ATM_attributes:: + Verbosity = 0 + :: + + # AQM # + AQM_model: aqm + AQM_petlist_bounds: 0 271 + AQM_attributes:: + Verbosity = 0 + :: + + # Run Sequence # + runSeq:: + @180 + ATM phase1 + ATM -> AQM + AQM + AQM -> ATM + ATM phase2 + @ + :: + diff --git a/doc/UsersGuide/source/samples/nems.configure.HAFS.rst b/doc/UsersGuide/source/samples/nems.configure.HAFS.rst new file mode 100644 index 0000000000..92aeafcde1 --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.HAFS.rst @@ -0,0 +1,110 @@ +:orphan: + +******************************************************************* +Sample ``nems.configure`` File for the ``HAFS`` WM Configuration +******************************************************************* + +.. code-block:: console + + # EARTH # + EARTH_component_list: ATM OCN MED + + # MED # + MED_model: cmeps + MED_petlist_bounds: 1340 1399 + MED_attributes:: + coupling_mode = hafs + system_type = ufs + normalization = none + merge_type = copy + ATM_model = fv3 + OCN_model = hycom + history_ymd = -999 + ScalarFieldCount = 0 + ScalarFieldIdxGridNX = 0 + ScalarFieldIdxGridNY = 0 + ScalarFieldName = cpl_scalars + :: + + # ATM # + ATM_model: fv3 + ATM_petlist_bounds: 0000 1339 + ATM_attributes:: + Verbosity = 1 + Diagnostic = 0 + :: + + # OCN # + OCN_model: hycom + OCN_petlist_bounds: 1340 1399 + OCN_attributes:: + Verbosity = 1 + Diagnostic = 0 + cdf_impexp_freq = 3 + cpl_hour = 0 + cpl_min = 0 + cpl_sec = 360 + base_dtg = 2020082512 + merge_import = .true. + skip_first_import = .true. + hycom_arche_output = .false. + hyc_esmf_exp_output = .true. + hyc_esmf_imp_output = .true. + import_diagnostics = .false. + import_setting = flexible + hyc_impexp_file = nems.configure + espc_show_impexp_minmax = .true. + ocean_start_dtg = 43702.50000 + start_hour = 0 + start_min = 0 + start_sec = 0 + end_hour = 12 + end_min = 0 + end_sec = 0 + :: + + DRIVER_attributes:: + start_type = startup + :: + + ALLCOMP_attributes:: + mediator_read_restart = false + :: + + # CMEPS cold run sequence + + runSeq:: + @360 + ATM -> MED :remapMethod=redist + MED med_phases_post_atm + OCN -> MED :remapMethod=redist + MED med_phases_post_ocn + MED med_phases_prep_atm + MED med_phases_prep_ocn_accum + MED med_phases_prep_ocn_avg + MED -> ATM :remapMethod=redist + MED -> OCN :remapMethod=redist + ATM + OCN + @ + :: + + # HYCOM field coupling configuration (location set by hyc_impexp_file) + + ocn_export_fields:: + 'sst' 'sea_surface_temperature' 'K' + 'mask' 'ocean_mask' '1' + :: + + ocn_import_fields:: + 'taux10' 'mean_zonal_moment_flx_atm' 'N_m-2' + 'tauy10' 'mean_merid_moment_flx_atm' 'N_m-2' + 'prcp' 'mean_prec_rate' 'kg_m-2_s-1' + 'swflxd' 'mean_net_sw_flx' 'W_m-2' + 'lwflxd' 'mean_net_lw_flx' 'W_m-2' + 'mslprs' 'inst_pres_height_surface' 'Pa' + 'sensflx' 'mean_sensi_heat_flx' 'W_m-2' + 'latflx' 'mean_laten_heat_flx' 'W_m-2' + :: + + diff --git a/doc/UsersGuide/source/samples/nems.configure.NG-GODAS.rst b/doc/UsersGuide/source/samples/nems.configure.NG-GODAS.rst new file mode 100644 index 0000000000..d2e173dbbb --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.NG-GODAS.rst @@ -0,0 +1,131 @@ +:orphan: + +*********************************************************************** +Sample ``nems.configure`` File for the ``NG-GODAS`` WM Configuration +*********************************************************************** + +.. code-block:: console + + # EARTH # + EARTH_component_list: MED ATM OCN ICE + EARTH_attributes:: + Verbosity = 0 + :: + + # MED # + MED_model: cmeps + MED_petlist_bounds: 0 11 + Verbosity = 5 + dbug_flag = 5 + + :: + + # ATM # + ATM_model: datm + ATM_petlist_bounds: 0 11 + ATM_attributes:: + Verbosity = 0 + DumpFields = false + mesh_atm = DATM_INPUT/cfsr_mesh.nc + diro = "." + logfile = atm.log + stop_n = 24 + stop_option = nhours + stop_ymd = -999 + write_restart_at_endofrun = .true. + :: + + # OCN # + OCN_model: mom6 + OCN_petlist_bounds: 12 27 + OCN_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + mesh_ocn = mesh.mx100.nc + :: + + # ICE # + ICE_model: cice6 + ICE_petlist_bounds: 28 39 + ICE_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + mesh_ice = mesh.mx100.nc + stop_n = 12 + stop_option = nhours + stop_ymd = -999 + :: + + # CMEPS concurrent warm run sequence + + runSeq:: + @3600 + MED med_phases_prep_ocn_avg + MED -> OCN :remapMethod=redist + OCN + @900 + MED med_phases_prep_ice + MED -> ICE :remapMethod=redist + ATM + ICE + ATM -> MED :remapMethod=redist + MED med_phases_post_atm + ICE -> MED :remapMethod=redist + MED med_phases_post_ice + MED med_phases_aofluxes_run + MED med_phases_prep_ocn_accum + @ + OCN -> MED :remapMethod=redist + MED med_phases_post_ocn + MED med_phases_restart_write + @ + :: + + # CMEPS variables + + DRIVER_attributes:: + mediator_read_restart = false + :: + MED_attributes:: + ATM_model = datm + ICE_model = cice6 + OCN_model = mom6 + history_n = 1 + history_option = nhours + history_ymd = -999 + coupling_mode = nems_orig_data + :: + ALLCOMP_attributes:: + ScalarFieldCount = 3 + ScalarFieldIdxGridNX = 1 + ScalarFieldIdxGridNY = 2 + ScalarFieldIdxNextSwCday = 3 + ScalarFieldName = cpl_scalars + start_type = startup + restart_dir = RESTART/ + case_name = DATM_CFSR + restart_n = 12 + restart_option = nhours + restart_ymd = -999 + dbug_flag = 0 + use_coldstart = false + use_mommesh = true + coldair_outbreak_mod = .false. + flds_wiso = .false. + flux_convergence = 0.0 + flux_max_iteration = 2 + ocn_surface_flux_scheme = 0 + orb_eccen = 1.e36 + orb_iyear = 2000 + orb_iyear_align = 2000 + orb_mode = fixed_year + orb_mvelp = 1.e36 + orb_obliq = 1.e36 + :: + + + diff --git a/doc/UsersGuide/source/samples/nems.configure.S2S.rst b/doc/UsersGuide/source/samples/nems.configure.S2S.rst new file mode 100644 index 0000000000..05d008c321 --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.S2S.rst @@ -0,0 +1,129 @@ +:orphan: + +******************************************************************* +Sample ``nems.configure`` File for the ``S2S`` WM Configuration +******************************************************************* + +.. code-block:: console + + # EARTH # + EARTH_component_list: MED ATM CHM OCN ICE WAV + EARTH_attributes:: + Verbosity = 0 + :: + + # MED # + MED_model: cmeps + MED_petlist_bounds: 0 143 + :: + + # ATM # + ATM_model: fv3 + ATM_petlist_bounds: 0 149 + ATM_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + :: + + # OCN # + OCN_model: mom6 + OCN_petlist_bounds: 150 269 + OCN_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + mesh_ocn = mesh.mx025.nc + :: + + # ICE # + ICE_model: cice6 + ICE_petlist_bounds: 270 317 + ICE_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + mesh_ice = mesh.mx025.nc + stop_n = 840 + stop_option = nhours + stop_ymd = -999 + :: + + # CMEPS warm run sequence + runSeq:: + @720 + MED med_phases_prep_ocn_avg + MED -> OCN :remapMethod=redist + OCN + @720 + MED med_phases_aofluxes_run + MED med_phases_prep_atm + MED med_phases_prep_ice + MED -> ATM :remapMethod=redist + MED -> ICE :remapMethod=redist + ATM + ICE + ATM -> MED :remapMethod=redist + MED med_phases_post_atm + ICE -> MED :remapMethod=redist + MED med_phases_post_ice + MED med_phases_prep_ocn_accum + @ + OCN -> MED :remapMethod=redist + MED med_phases_post_ocn + MED med_phases_restart_write + MED med_phases_history_write + @ + :: + + # CMEPS variables + + DRIVER_attributes:: + :: + + MED_attributes:: + ATM_model = fv3 + ICE_model = cice6 + OCN_model = mom6 + history_n = 3 + history_option = nhours + history_ymd = -999 + coupling_mode = nems_frac_aoflux + history_tile_atm = 96 + aoflux_grid = 'xgrid' + aoflux_code = 'ccpp' + aoflux_ccpp_suite = 'FV3_sfc_ocean' + ccpp_restart_interval = -1 + ccpp_ini_mosaic_file = 'INPUT/C96_mosaic.nc' + ccpp_input_dir = 'INPUT/' + ccpp_ini_file_prefix = 'INPUT/sfc_data.tile' + ccpp_nstf_name = 2,1,0,0,0 + ccpp_ini_read = true + :: + ALLCOMP_attributes:: + ScalarFieldCount = 2 + ScalarFieldIdxGridNX = 1 + ScalarFieldIdxGridNY = 2 + ScalarFieldName = cpl_scalars + start_type = startup + restart_dir = RESTART/ + case_name = ufs.cpld + restart_n = 12 + restart_option = nhours + restart_ymd = -999 + dbug_flag = 0 + use_coldstart = false + use_mommesh = true + eps_imesh = 1.0e-1 + stop_n = 840 + stop_option = nhours + stop_ymd = -999 + :: + +.. note:: The *aoflux_grid* option is used to select the grid/mesh to perform atmosphere-ocean flux calculation. The possible options are *xgrid* (exchange grid), *agrid* (atmosphere model grid) and *ogrid* (ocean model grid). + +.. note:: The *aoflux_code* option is used to define the algorithm that will be used to calculate atmosphere-ocean fluxes. The possible options are *cesm* and *ccpp*. If *ccpp* is selected then the suite file provided in the *aoflux_ccpp_suite* option is used to calculate atmosphere-ocean fluxes through the use of CCPP host model. + diff --git a/doc/UsersGuide/source/samples/nems.configure.S2SW.rst b/doc/UsersGuide/source/samples/nems.configure.S2SW.rst new file mode 100644 index 0000000000..3f7aa34698 --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.S2SW.rst @@ -0,0 +1,103 @@ +:orphan: + +******************************************************************* +Sample ``nems.configure`` File for the ``S2SW`` WM Configuration +******************************************************************* + +.. code-block:: console + + # EARTH # + EARTH_component_list: MED ATM OCN ICE WAV + EARTH_attributes:: + Verbosity = 0 + :: + + # MED # + MED_model: cmeps + MED_petlist_bounds: 0 143 + :: + + # ATM # + ATM_model: fv3 + ATM_petlist_bounds: 0 149 + ATM_attributes:: + :: + + # OCN # + OCN_model: mom6 + OCN_petlist_bounds: 150 179 + OCN_attributes:: + mesh_ocn = mesh.mx100.nc + :: + + # ICE # + ICE_model: cice6 + ICE_petlist_bounds: 180 191 + ICE_attributes:: + mesh_ice = mesh.mx100.nc + :: + + # WAV # + WAV_model: ww3 + WAV_petlist_bounds: 192 395 + WAV_attributes:: + :: + + # CMEPS warm run sequence + runSeq:: + @3600 + MED med_phases_prep_ocn_avg + MED -> OCN :remapMethod=redist + OCN -> WAV + WAV -> OCN :srcMaskValues=1 + OCN + @900 + MED med_phases_prep_atm + MED med_phases_prep_ice + MED -> ATM :remapMethod=redist + MED -> ICE :remapMethod=redist + WAV -> ATM :srcMaskValues=1 + ATM -> WAV + ICE -> WAV + ATM + ICE + WAV + ATM -> MED :remapMethod=redist + MED med_phases_post_atm + ICE -> MED :remapMethod=redist + MED med_phases_post_ice + MED med_phases_prep_ocn_accum + @ + OCN -> MED :remapMethod=redist + MED med_phases_post_ocn + MED med_phases_restart_write + @ + :: + + # CMEPS variables + + :: + MED_attributes:: + ATM_model = fv3 + ICE_model = cice6 + OCN_model = mom6 + history_n = 1 + history_option = nhours + history_ymd = -999 + coupling_mode = nems_orig + :: + ALLCOMP_attributes:: + ScalarFieldCount = 2 + ScalarFieldIdxGridNX = 1 + ScalarFieldIdxGridNY = 2 + ScalarFieldName = cpl_scalars + start_type = startup + restart_dir = RESTART/ + case_name = ufs.cpld + restart_n = 24 + restart_option = nhours + restart_ymd = -999 + dbug_flag = 0 + use_coldstart = false + use_mommesh = true + :: diff --git a/doc/UsersGuide/source/samples/nems.configure.S2SWA.rst b/doc/UsersGuide/source/samples/nems.configure.S2SWA.rst new file mode 100644 index 0000000000..e3a83199b9 --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.S2SWA.rst @@ -0,0 +1,140 @@ +:orphan: + +******************************************************************* +Sample ``nems.configure`` File for the ``S2SWA`` WM Configuration +******************************************************************* + +.. code-block:: console + + # EARTH # + EARTH_component_list: MED ATM CHM OCN ICE WAV + EARTH_attributes:: + Verbosity = 0 + :: + + # MED # + MED_model: cmeps + MED_petlist_bounds: 0 287 + :: + + # ATM # + ATM_model: fv3 + ATM_petlist_bounds: 0 311 + ATM_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + :: + + # CHM # + CHM_model: gocart + CHM_petlist_bounds: 0 287 + CHM_attributes:: + Verbosity = 0 + :: + + # OCN # + OCN_model: mom6 + OCN_petlist_bounds: 312 431 + OCN_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + mesh_ocn = mesh.mx025.nc + :: + + # ICE # + ICE_model: cice6 + ICE_petlist_bounds: 432 479 + ICE_attributes:: + Verbosity = 0 + DumpFields = false + ProfileMemory = false + OverwriteSlice = true + mesh_ice = mesh.mx025.nc + stop_n = 6 + stop_option = nhours + stop_ymd = -999 + :: + + # WAV # + WAV_model: ww3 + WAV_petlist_bounds: 480 559 + WAV_attributes:: + Verbosity = 0 + OverwriteSlice = false + :: + + # CMEPS warm run sequence + runSeq:: + @1800 + MED med_phases_prep_ocn_avg + MED -> OCN :remapMethod=redist + OCN -> WAV + WAV -> OCN :srcMaskValues=1 + OCN + @300 + MED med_phases_prep_atm + MED med_phases_prep_ice + MED -> ATM :remapMethod=redist + MED -> ICE :remapMethod=redist + WAV -> ATM :srcMaskValues=1 + ATM -> WAV + ICE -> WAV + ATM phase1 + ATM -> CHM + CHM + CHM -> ATM + ATM phase2 + ICE + WAV + ATM -> MED :remapMethod=redist + MED med_phases_post_atm + ICE -> MED :remapMethod=redist + MED med_phases_post_ice + MED med_phases_prep_ocn_accum + @ + OCN -> MED :remapMethod=redist + MED med_phases_post_ocn + MED med_phases_restart_write + @ + :: + + # CMEPS variables + + DRIVER_attributes:: + :: + + MED_attributes:: + ATM_model = fv3 + ICE_model = cice6 + OCN_model = mom6 + history_n = 1 + history_option = nhours + history_ymd = -999 + coupling_mode = nems_frac + history_tile_atm = 384 + :: + ALLCOMP_attributes:: + ScalarFieldCount = 2 + ScalarFieldIdxGridNX = 1 + ScalarFieldIdxGridNY = 2 + ScalarFieldName = cpl_scalars + start_type = startup + restart_dir = RESTART/ + case_name = ufs.cpld + restart_n = 6 + restart_option = nhours + restart_ymd = -999 + dbug_flag = 0 + use_coldstart = false + use_mommesh = true + eps_imesh = 1.0e-1 + stop_n = 6 + stop_option = nhours + stop_ymd = -999 + :: + + From 19a78842540d8c8677cb7c25443394a6cd3bcce4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 11 May 2023 23:08:30 -0400 Subject: [PATCH 09/44] fix file name --- doc/UsersGuide/source/InputsOutputs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst index e4365c5b13..0b1874dbaa 100644 --- a/doc/UsersGuide/source/InputsOutputs.rst +++ b/doc/UsersGuide/source/InputsOutputs.rst @@ -1446,7 +1446,7 @@ However, ``nems.configure`` files for other configurations of the Weather Model .. COMMENT: Is this a regular S2S nems.configure file, or is it special? What's the talk about "atmosphere-oceans fluxes"? * :doc:`S2SW ` (fully coupled ``S2SW`` configuration) - * :doc:`S2SWA ` (coupled GOCART in the S2SAW configuration) + * :doc:`S2SWA ` (coupled GOCART in the S2SAW configuration) * :doc:`NG-GODAS ` (coupled NG-GODAS configuration) * :doc:`HAFS ` (coupled HAFS configuration) From 5963a15f59b9ddf455319bbd421c8d493d9740ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 17 May 2023 16:14:28 -0400 Subject: [PATCH 10/44] add terms to glossary --- doc/UsersGuide/source/Glossary.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index bfd7336587..f84b4d4b74 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -124,6 +124,9 @@ Glossary The NOAA Environmental Modeling System is a common modeling framework whose purpose is to streamline components of operational modeling suites at :term:`NCEP`. + netCDF + NetCDF (`Network Common Data Form `__) is a file format and community standard for storing multidimensional scientific data. It includes a set of software libraries and machine-independent data formats that support the creation, access, and sharing of array-oriented scientific data. + NG-GODAS Next Generation-Global Ocean Data Assimilation System. NG-GODAS is a UFS Weather Model configuration that couples ocean (:term:`MOM6`), sea ice (:term:`CICE6`), and Data Assimilation (DA) capabilities with the :term:`DATM` component of :term:`CDEPS`. From 20a10e8618b0eb4f96afe0ed3db03fe208794040 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 17 May 2023 16:15:24 -0400 Subject: [PATCH 11/44] add lnd/atml & Xlink updates --- doc/UsersGuide/source/BuildingAndRunning.rst | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index cbb62ca69e..3f92372d1e 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -297,6 +297,8 @@ The following examples assume a bash shell. ATM Configurations --------------------- +.. _atm: + **Standalone ATM** For the ``ufs-weather-model ATM`` configuration (standalone :term:`ATM`): @@ -305,6 +307,8 @@ For the ``ufs-weather-model ATM`` configuration (standalone :term:`ATM`): export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_GFS_v16" +.. _atmw: + **ATMW** For the ``ufs-weather-model ATMW`` configuration (standalone ATM coupled to :term:`WW3`): @@ -313,6 +317,8 @@ For the ``ufs-weather-model ATMW`` configuration (standalone ATM coupled to :ter export CMAKE_FLAGS="-DAPP=ATMW -DCCPP_SUITES=FV3_GFS_v16" +.. _atmaero: + **ATMAERO** For the ``ufs-weather-model ATMAERO`` configuration (standalone ATM coupled to :term:`GOCART`): @@ -321,6 +327,8 @@ For the ``ufs-weather-model ATMAERO`` configuration (standalone ATM coupled to : export CMAKE_FLAGS="-DAPP=ATMAERO -DCCPP_SUITES=FV3_GFS_v17_p8" +.. _atmaq: + **ATMAQ** For the ``ufs-weather-model ATMAQ`` configuration (standalone ATM coupled to :term:`CMAQ`): @@ -329,6 +337,8 @@ For the ``ufs-weather-model ATMAQ`` configuration (standalone ATM coupled to :te export CMAKE_FLAGS="-DAPP=ATMAQ -DCCPP_SUITES=FV3_GFS_v15p2" +.. _atml: + **ATML** For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :term:`LND`): @@ -340,6 +350,8 @@ For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :ter S2S Configurations ---------------------- +.. _s2s: + **S2S** For the ``ufs-weather-model S2S`` configuration (coupled atm/ice/ocean): @@ -361,6 +373,8 @@ For example: export CMAKE_FLAGS="-DAPP=S2S -DCCPP_SUITES=FV3_GFS_v17_coupled_p8_sfcocn -DCMEPS_AOFLUX=ON" +.. _s2sa: + **S2SA** For the ``ufs-weather-model S2SA`` configuration (atm/ice/ocean/aerosols): @@ -372,6 +386,8 @@ For the ``ufs-weather-model S2SA`` configuration (atm/ice/ocean/aerosols): .. CHECK: DAPP flag and physics suites +.. _s2sw: + **S2SW** For the ``ufs-weather-model S2SW`` configuration (atm/ice/ocean/wave): @@ -380,6 +396,8 @@ For the ``ufs-weather-model S2SW`` configuration (atm/ice/ocean/wave): export CMAKE_FLAGS="-DAPP=S2SW -DCCPP_SUITES=FV3_GFS_v17_coupled_p8" +.. _s2swa: + **S2SWA** For the ``ufs-weather-model S2SWA`` configuration (atm/ice/ocean/wave/aerosols): @@ -388,6 +406,8 @@ For the ``ufs-weather-model S2SWA`` configuration (atm/ice/ocean/wave/aerosols): export CMAKE_FLAGS="-DAPP=S2SWA -DCCPP_SUITES=FV3_GFS_v17_coupled_p8,FV3_GFS_cpld_rasmgshocnsstnoahmp_ugwp" +.. _ng-godas: + NG-GODAS Configuration ------------------------ @@ -402,6 +422,8 @@ For the ``ufs-weather-model NG-GODAS`` configuration (atm/ocean/ice/data assimil HAFS Configurations ---------------------- +.. _hafs: + **HAFS** For the ``ufs-weather-model HAFS`` configuration (atm/ocean) in 32 bit: @@ -410,6 +432,8 @@ For the ``ufs-weather-model HAFS`` configuration (atm/ocean) in 32 bit: export CMAKE_FLAGS="-DAPP=HAFS -D32BIT=ON -DCCPP_SUITES=FV3_HAFS_v0_gfdlmp_tedmf_nonsst,FV3_HAFS_v0_gfdlmp_tedmf" +.. _hafsw: + **HAFSW** For the ``ufs-weather-model HAFSW`` configuration (atm/ocean/wave) in 32-bit with moving nest: @@ -418,6 +442,8 @@ For the ``ufs-weather-model HAFSW`` configuration (atm/ocean/wave) in 32-bit wit export CMAKE_FLAGS="-DAPP=HAFSW -D32BIT=ON -DMOVING_NEST=ON -DCCPP_SUITES=FV3_HAFS_v0_gfdlmp_tedmf,FV3_HAFS_v0_gfdlmp_tedmf_nonsst,FV3_HAFS_v0_thompson_tedmf_gfdlsf" +.. _hafs-all: + **HAFS-ALL** For the ``ufs-weather-model HAFS-ALL`` configuration (data/atm/ocean/wave) in 32 bit: @@ -429,6 +455,8 @@ For the ``ufs-weather-model HAFS-ALL`` configuration (data/atm/ocean/wave) in 32 LND Configurations ---------------------- +.. _lnd: + **LND** For the ``ufs-weather-model LND`` configuration (datm/land): From 7362add8aec10518e0ebec0efb6b4967bbb598fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 17 May 2023 16:16:26 -0400 Subject: [PATCH 12/44] add landda to intersphinx mapping --- doc/UsersGuide/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/conf.py b/doc/UsersGuide/source/conf.py index fa2a93ca5b..3ea9ae9025 100644 --- a/doc/UsersGuide/source/conf.py +++ b/doc/UsersGuide/source/conf.py @@ -203,7 +203,8 @@ def setup(app): # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {'landda': ('https://land-da-workflow.readthedocs.io/en/latest/', None), + } # -- Options for todo extension ---------------------------------------------- From b93dd74942c51836ca1f6b78b249424c761cf346 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 17 May 2023 16:17:04 -0400 Subject: [PATCH 13/44] add atml nems.config file --- .../source/samples/nems.configure.ATM_LND.rst | 130 ++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 doc/UsersGuide/source/samples/nems.configure.ATM_LND.rst diff --git a/doc/UsersGuide/source/samples/nems.configure.ATM_LND.rst b/doc/UsersGuide/source/samples/nems.configure.ATM_LND.rst new file mode 100644 index 0000000000..c154e51311 --- /dev/null +++ b/doc/UsersGuide/source/samples/nems.configure.ATM_LND.rst @@ -0,0 +1,130 @@ +:orphan: + +******************************************************************* +Sample ``nems.configure`` File for the ``LND`` WM Configuration +******************************************************************* + +.. code-block:: console + + # ESMF # + logKindFlag: ESMF_LOGKIND_MULTI + globalResourceControl: true + + # EARTH # + EARTH_component_list: MED ATM LND + EARTH_attributes:: + Verbosity = 0 + :: + + # MED # + MED_model: @[med_model] + MED_petlist_bounds: @[med_petlist_bounds] + MED_omp_num_threads: @[med_omp_num_threads] + MED_attributes:: + Verbosity = 1 + Diagnostic = 0 + ATM_model = @[atm_model] + LND_model = @[lnd_model] + MED_model = cmeps + history_n = 6 + history_option = nhours + history_ymd = -999 + coupling_mode = @[CPLMODE] + history_tile_lnd = 96 + history_n_lnd_inst = 6 + history_option_lnd_inst = nhours + :: + + # ATM # + ATM_model: @[atm_model] + ATM_petlist_bounds: @[atm_petlist_bounds] + ATM_omp_num_threads: @[atm_omp_num_threads] + ATM_attributes:: + Verbosity = 0 + Diagnostic = 0 + :: + + # LND # + LND_model: @[lnd_model] + LND_petlist_bounds: @[lnd_petlist_bounds] + LND_omp_num_threads: @[lnd_omp_num_threads] + LND_attributes:: + Verbosity = 1 + Diagnostic = 0 + mosaic_file = @[mosaic_file] + input_dir = INPUT/ + ic_type = @[lnd_ic_type] + layout = @[layout_x]:@[layout_y] # need to be consistent with number of PEs + num_soil_levels = 4 + forcing_height = 10 + soil_level_thickness = 0.10:0.30:0.60:1.00 + soil_level_nodes = 0.05:0.25:0.70:1.50 + dynamic_vegetation_option = 4 + canopy_stomatal_resistance_option = 2 + soil_wetness_option = 1 + runoff_option = 1 + surface_exchange_option = 3 + supercooled_soilwater_option = 1 + frozen_soil_adjust_option = 1 + radiative_transfer_option = 3 + snow_albedo_option = 1 + precip_partition_option = 4 + soil_temp_lower_bdy_option = 2 + soil_temp_time_scheme_option = 3 + surface_evap_resistance_option = 1 # not used, it is fixed to 4 in sfc_noahmp_drv.F90 + glacier_option = 1 + surface_thermal_roughness_option = 2 + output_freq = 10800 + calc_snet = @[CALC_SNET] + :: + + # cold + runSeq:: + @@[coupling_interval_sec] + MED med_phases_prep_atm + MED -> ATM :remapMethod=redist + ATM + ATM -> MED :remapMethod=redist + MED med_phases_post_atm + MED med_phases_prep_lnd + MED -> LND :remapMethod=redist + LND + LND -> MED :remapMethod=redist + MED med_phases_post_lnd + MED med_phases_restart_write + MED med_phases_history_write + @ + :: + + # Other Attributes # + DRIVER_attributes:: + :: + + ALLCOMP_attributes:: + ScalarFieldCount = 3 + ScalarFieldIdxGridNX = 1 + ScalarFieldIdxGridNY = 2 + ScalarFieldIdxNextSwCday = 3 # required for data atmosphere configurations + ScalarFieldName = cpl_scalars + start_type = @[RUNTYPE] + restart_dir = RESTART/ + case_name = ufs.cpld + restart_n = 12 + restart_option = nhours + restart_ymd = -999 + dbug_flag = 0 + use_coldstart = false + use_mommesh = true + eps_imesh = 2.5e-1 + orb_eccen = 1.e36 + orb_iyear = 2000 + orb_iyear_align = 2000 + orb_mode = fixed_year + orb_mvelp = 1.e36 + orb_obliq = 1.e36 + stop_n = @[FHMAX] + stop_option = nhours + stop_ymd = -999 + read_restart = @[READRESTART] + mediator_present = true + :: \ No newline at end of file From f85a17b7a3eadb83a67a0ad95dcde91737dfd3cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 17 May 2023 16:17:56 -0400 Subject: [PATCH 14/44] land-related updates to I/O ch --- doc/UsersGuide/source/InputsOutputs.rst | 155 +++++++++++++++++++----- 1 file changed, 125 insertions(+), 30 deletions(-) diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst index 0b1874dbaa..679641785f 100644 --- a/doc/UsersGuide/source/InputsOutputs.rst +++ b/doc/UsersGuide/source/InputsOutputs.rst @@ -4,44 +4,52 @@ Data: Input, Model Configuration, and Output Files ***************************************************** -The UFS Weather Model can be run in one of several configurations, from a single component atmospheric +The UFS Weather Model can be run in one of several configurations (sometimes referred to as "applications"), from a single-component atmospheric model to a fully coupled model with multiple earth system components (e.g., atmosphere, ocean, sea-ice and -mediator). Currently the supported configurations are: +mediator). Currently, supported configurations include: .. _UFS-configurations: .. list-table:: *Supported ufs-weather-model applications* :widths: 10 70 :header-rows: 1 - + * - Configuration Name - Description - * - ATM - - Standalone UFSAtm - * - ATMW - - UFSAtm coupled to WW3 - * - ATMAERO - - UFSAtm coupled to GOCART - * - ATMAQ - - UFSAtm coupled to CMAQ - * - S2S - - Coupled UFSATM-MOM6-CICE6-CMEPS - * - S2SA - - Coupled UFSATM-MOM6-CICE6-GOCART-CMEPS - * - S2SW - - Coupled UFSATM-MOM6-CICE6-WW3-CMEPS - * - S2SWA - - Coupled UFSATM-MOM6-CICE6-WW3-GOCART-CMEPS - * - NG-GODAS - - Coupled CDEPS-DATM-MOM6-CICE6-CMEPS - * - HAFS - - Coupled UFSATM-HYCOM-CMEPS - * - HAFSW - - Coupled UFSATM-HYCOM-WW3-CMEPS - * - HAFS-ALL - - Coupled CDEPS-UFSATM-HYCOM-WW3-CMEPS - -Each of the component models for a given configuration requires specific input files, and each component model outputs a particular set of files. Each configuration requires a set of model configuration files, as well. This chapter describes the input and output files involved with each component model. It also discusses the various configuration files involved in running the model. Users will need to view the input file requirements for each component model involved in the configuration they are running. For example, users running the *S2S* configuration would need to gather input data required for the *ATM*, *MOM6*, and *CICE6* component models. Then, they would need to alter certain model configuration files to reflect the ``ufs-weather-model`` configuration they plan to run. + * - :ref:`ATM ` + - Standalone Atmospheric Model (:term:`ATM`) + * - :ref:`ATMW ` + - :term:`ATM` coupled to :term:`WW3` + * - :ref:`ATMAERO ` + - :term:`ATM` coupled to :term:`GOCART` + * - :ref:`ATMAQ ` + - :term:`ATM` coupled to :term:`CMAQ` + * - :ref:`ATML ` + - Coupled :term:`ATM`- :term:`LND` - :term:`MOM6` - :term:`CICE6` - :term:`CMEPS` + * - :ref:`S2S ` + - Coupled :term:`ATM` - :term:`MOM6` - :term:`CICE6` - :term:`CMEPS` + * - :ref:`S2SA ` + - Coupled :term:`ATM` - :term:`MOM6` - :term:`CICE6` - :term:`GOCART` - :term:`CMEPS` + * - :ref:`S2SW ` + - Coupled :term:`ATM` - :term:`MOM6` - :term:`CICE6` - :term:`WW3` - :term:`CMEPS` + * - :ref:`S2SWA ` + - Coupled :term:`ATM` - :term:`MOM6` - :term:`CICE6` - :term:`GOCART` - :term:`WW3` - :term:`CMEPS` + * - :ref:`NG-GODAS ` + - Coupled :term:`CDEPS` - :term:`DATM` - :term:`MOM6` - :term:`CICE6` - :term:`CMEPS` + * - :ref:`LND ` + - Coupled :term:`CDEPS` - :term:`DATM` - :term:`LND` -:term:`CMEPS` + * - :ref:`HAFS ` + - Coupled :term:`ATM` - :term:`HYCOM` - :term:`CMEPS` + * - :ref:`HAFSW ` + - Coupled :term:`ATM` - :term:`HYCOM` - :term:`WW3` - :term:`CMEPS` + * - :ref:`HAFS-ALL ` + - Coupled :term:`CDEPS` - :term:`ATM` - :term:`HYCOM` - :term:`WW3` - :term:`CMEPS` + + +.. COMMENT: CMEPS for LND? Are those the right components for ATML? +.. COMMENT: Should HAFS-ALL be DATM instead of ATM? + +This chapter describes the input and output files needed for executing the model in the various supported configurations (see :numref:`Table %s `). Each of the component models for a given configuration requires specific input files, and each component model outputs a particular set of files. Each configuration requires a set of model configuration files, as well. This chapter describes the input and output files involved with each component model. It also discusses the various configuration files involved in running the model. Users will need to view the input file requirements for each component model involved in the configuration they are running. For example, users running the *S2S* configuration would need to gather input data required for the *ATM*, *MOM6*, and *CICE6* component models. Then, they would need to alter certain model configuration files to reflect the ``ufs-weather-model`` configuration they plan to run. ============= Input files @@ -940,6 +948,92 @@ AQM inputs defined in ``aqm.rc`` are listed and described in :numref:`Table %s < * - Hourly_Emissions_regrid_rrfs_13km_20190801_t12z_h72.nc - File Emissions File +.. _lnd-io: + +------- +LND +------- + +LND component datasets are available from the Land Data Assimilation (DA) System Data Bucket and can be retrieved using a ``wget`` command: + +.. code-block:: console + + wget https://noaa-ufs-land-da-pds.s3.amazonaws.com/current_land_da_release_data/landda-test-inps.tar.gz + tar xvfz landda-test-inps.tar.gz + +These files will be untarred into an ``inputs`` directory if the user does not specify a different name. They include data for Jan 1-2, 2016 with restarts available for Jan. 3-4, 2016. :numref:`Table %s ` describes the file types. In each file name, ``YYYY`` refers to a valid 4-digit year, ``MM`` refers to a valid 2-digit month, and ``DD`` refers to a valid 2-digit day of the month. + +.. _LndInputFiles: + +.. list-table:: *LND input files* + :widths: 30 60 10 + :header-rows: 1 + + * - Filename + - Description + - File Type + * - ufs-land_C96_static_fields.nc + - Static file that includes information on location, time, soil layers, and fixed (invariant) experiment parameters. + - Fix/static file + * - ufs-land_C96_init_fields_1hr.nc + - Initial conditions file that includes the initial state variables that are required for the UFS land snow DA to begin a cycling run. + - Initial conditions + * - C96_grid.tileN.nc + - C96 grid information for tiles 1-6, where N is the grid tile number [1-6]. + - Grid + * - C96_oro_data.tileN.nc / oro_C96.mx100.tileN.nc + - Orography files that contain grid and land mask information, where N is the grid tile number [1-6]. ``mx100`` refers to the ocean resolution (100=1º). + - Grid + * - ufs-land.namelist.gdas + - Land component model configuration (namelist) file + - Model configuration + * - ghcn_snwd_ioda_YYYYMMDD.nc + - Snow depth data assimilation files + - DA + * - C96_GDAS_forcing_YYYY-MM-DD.nc + - GDAS forcing files + - Forcing + * - ufs_land_restart.2015-09-01_18-00-00.nc + - Restart file + - Restart + * - ufs_land_restart.2016-01-01_18-00-00.nc + - Restart file + - Restart + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Static Datasets (i.e., *fix files*) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The static file (listed in :numref:`Table %s `) includes specific information on location, time, soil layers, and fixed (invariant) experiment parameters that are required for the land component to run. The data must be provided in :term:`netCDF` format. + +The static file is available in the ``inputs`` data directory at the following path: + +.. code-block:: + + inputs/forcing/gdas/static/ufs-land_C96_static_fields.nc + +Details on the configuration variables included in this file are available from the :ref:`Land DA documentation `. + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Grid Description and Initial Condition Files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The input files containing grid information and the initial conditions for global configurations are listed and described in :numref:`Table %s `. + +The initial conditions file includes the initial state variables that are required for the UFS land snow DA to begin a cycling run. The data must be provided in :term:`netCDF` format. + +The initial conditions file is available in the ``inputs`` data directory (downloaded :ref:`above `) at the following path: + +.. code-block:: + + inputs/forcing/GDAS/init/ufs-land_C96_init_fields_1hr.nc + +^^^^^^^^^^^^^^^^^^^^ +Additional Files +^^^^^^^^^^^^^^^^^^^^ + +The LND component uses a model configuration namelist file as well as atmospheric forcing files, data assimilation files, and restart files, which are also listed in :numref:`Table %s `. + .. _model-config-files: ========================== @@ -1438,7 +1532,7 @@ A sample of the file contents is shown below: ATM :: -However, ``nems.configure`` files for other configurations of the Weather Model are more complex. A number of samples are available below: +However, ``nems.configure`` files for other configurations of the Weather Model are more complex. A full set of ``nems.configure`` templates is available in the ``ufs-weather-model/tests/parm/`` directory `here `__. Template names follow the pattern ``nems.configure.*.IN``. A number of samples are available below: * :doc:`ATMAQ ` configuration * :doc:`S2S ` (fully coupled ``S2S`` configuration that receives atmosphere-ocean fluxes from a mediator) @@ -1449,6 +1543,7 @@ However, ``nems.configure`` files for other configurations of the Weather Model * :doc:`S2SWA ` (coupled GOCART in the S2SAW configuration) * :doc:`NG-GODAS ` (coupled NG-GODAS configuration) * :doc:`HAFS ` (coupled HAFS configuration) + * :doc:`LND ` (ATML configuration) * For more HAFS, HAFSW, and HAFS-ALL configurations please see the following ``nems.configure`` templates: From 4df00a3460feaab57d3680df077aaf986680bdad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 18 May 2023 17:01:05 -0400 Subject: [PATCH 15/44] make table headers responsive --- doc/UsersGuide/source/_static/theme_overrides.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/_static/theme_overrides.css b/doc/UsersGuide/source/_static/theme_overrides.css index 9713e89ab2..0416b736cd 100644 --- a/doc/UsersGuide/source/_static/theme_overrides.css +++ b/doc/UsersGuide/source/_static/theme_overrides.css @@ -4,6 +4,6 @@ max-width: 100% !important; } -.wy-table-responsive table td { +.wy-table-responsive table td, .wy-table-responsive table th { white-space: normal !important; } From 8b9c7019f4ad138dfbb3d920973f04e5300cd96c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 18 May 2023 17:01:44 -0400 Subject: [PATCH 16/44] add configuration chapter --- doc/UsersGuide/source/Configurations.rst | 210 +++++++++++++++++++++++ doc/UsersGuide/source/index.rst | 1 + 2 files changed, 211 insertions(+) create mode 100644 doc/UsersGuide/source/Configurations.rst diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst new file mode 100644 index 0000000000..b7b3356301 --- /dev/null +++ b/doc/UsersGuide/source/Configurations.rst @@ -0,0 +1,210 @@ +.. _Configurations: + +************************* +Configurations +************************* + +The UFS Weather Model (WM) can be run in any of several configurations, from a single-component atmospheric +model to a fully coupled model with multiple earth system components (e.g., atmosphere, ocean, sea-ice and +mediator). This chapter documents a few of the curently supported configurations. For a full list of +supported configurations, view the `rt.conf `__ +and `rt.gnu.conf `__ files. + +.. attention:: + + This chapter is a work in progress. There are a multitude of options for configuring the UFS WM, + and this chapter merely details a few supported configurations. It will be expanded over time + to include the full set of configurations supported for WM regression tests (RTs). + +.. _UFS-configurations-documented: + +.. list-table:: *Documented UFS Weather Model Configurations* + :widths: 10 70 + :header-rows: 1 + + * - Configuration Name + - Description + * - :ref:`ATM ` + - Standalone Atmospheric Model (:term:`ATM`) + * - :ref:`LND ` + - Coupled :term:`CDEPS` - :term:`DATM` - :term:`LND` -:term:`CMEPS` + +This chapter details the build and run options for each supported configuration. +Click on the Configuration Name in :numref:`Table %s ` +to go to that section. Each configuration includes sample code for setting ``CMAKE_FLAGS`` and ``CCPP_SUITES``. +Additionally, there is a list of preferred physics suites, examples of ``nems.configure`` files, +and links to information on other input files required to run the model. + +============ +Background +============ + +Each RT configuration file (located in the ``tests/tests`` `directory `__) sets default variables by calling setup functions from ``tests/default_vars.sh`` (see defaults `here `__). Then, the RT configuration file sets test-specific variables; these values will override the defaults. For example, the ``control_c48`` test file sets a list of files that it will use, calls the ``export_fv3`` function from ``default_vars.sh``, and then exports test-specific variables. An excerpt is included below (``...`` indicates omitted lines): + +.. code-block:: console + + export LIST_FILES="sfcf000.nc \ + sfcf024.nc \ + atmf000.nc \ + atmf024.nc \ + RESTART/20210323.060000.coupler.res \ + RESTART/20210323.060000.fv_core.res.nc \ + ... + RESTART/20210323.060000.sfc_data.tile5.nc \ + RESTART/20210323.060000.sfc_data.tile6.nc" + + export_fv3 + + export INPES=1 + export JNPES=1 + export WRTTASK_PER_GROUP=2 + export NPZ=127 + export NPZP=128 + export NPX=49 + export NPY=49 + export DT_ATMOS=1200 + ... + +``default_vars.sh`` contains eight functions that set defaults for different types of tests. :numref:`Table %s ` describes what each function does. Multiple functions may be called in a given RT. + +.. _def-funcs: + +.. list-table:: *default_vars.sh functions* + :widths: 10 70 + :header-rows: 1 + + * - Function Name + - Description + * - export_fv3 + - Export variables to the FV3 default values (first common variables, then model specific ones). Different machines may have different defaults for some variables. + * - export_cpl + - Export variables to the default values for *coupled* / S2S configurations. + * - export_35d_run + - Export variables to the default values for EMC's weekly coupled benchmark 35d tests (see `rt_35d.conf `__). + * - export_datm_cdeps + - Export variables to the default values for configurations that use the data atmosphere (:term:`DATM`) component. + * - export_hafs_datm_cdeps + - Export variables to the default values for HAFS configurations that use the data atmosphere (DATM) component. + * - export_hafs_docn_cdeps + - Export variables to the default values for HAFS configurations that use the data ocean (:term:`DOCN`) component. + * - export_hafs_regional + - Export variables to the default values for regional HAFS configurations. + * - export_hafs + - Export variables to the default values for HAFS configurations. + +==================================== +Atmospheric Model Configurations +==================================== + +The atmospheric model configurations all use the UFS WM atmospheric component +and may couple it with other models (e.g., a wave or aerosol model). + +.. _atm_documented: + +ATM - Standalone Atmospheric Model +===================================== + +The standalone atmospheric model (:term:`ATM`) is an :term:`FV3`-based prognostic +atmospheric model that can be used for short- and medium-range research and operational +forecasts. In standalone mode, ``ATM`` is not coupled to any other model. + +Current ATM regression tests cover a wide variety of functionality and involve several physics tests. :numref:`Table %s ` contains a selection of ATM-only RTs; it will be expanded to cover the full range of ATM-only supported configurations in time: + +.. _atm-rts: + +.. list-table:: *ATM regression test descriptions* + :widths: 10 40 10 10 15 5 + :header-rows: 1 + + * - Test Name + - Description + - Physics suite + - DT_ATMOS + - Start Date + - Forecast Length (hours) + * - `control_c48 `__ + - Compare global control C48L127 results with previous trunk version + - FV3_GFS_v16 + - 1200 + - 2021-03-22 06:00:00 + - 24 + * - `control_p8 `__ + - Compare global control results with previous trunk version + - FV3_GFS_v17_p8 + - 720 + - 2021-03-22 06:00:00 + - 24 + * - `regional_control `__ + - FV3 regional control (hi-res 3km, small domain) test + - FV3_GFS_v15_thompson_mynn_lam3km + - 1800 + - 2016-10-03 00:00:00 + - 6 + +**Sample** ``CMAKE_FLAGS`` **Setting** + +.. code-block:: console + + export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_GFS_v16,FV3_GFS_v17_p8,FV3_GFS_v15_thompson_mynn_lam3km -D32BIT=ON" + +.. _lnd_documented: + +LND +======= + +The LND configuration couples :term:`DATM`, :term:`CDEPS`, and :term:`CMEPS` with :term:`LND`. These test use default values set in the ``export_datm_cdeps`` function of ``default_vars.sh``. + +.. _lnd-rts: + +.. list-table:: *LND regression test descriptions* + :widths: 10 40 10 10 15 5 + :header-rows: 1 + + * - Test Name + - Description + - Physics suite + - DT_ATMOS + - Start Date + - Forecast Length (hours) + * - datm_cdeps_lnd_gswp3 + - DATM_CDEPS_NOAHMP_GSWP3 - control + - N/A + - N/A + - 2000-01-01 00:00:00 + - 24 + * - datm_cdeps_lnd_gswp3_rst + - DATM_CDEPS_NOAHMP_GSWP3_RST - control restart + - N/A + - N/A + - 2000-01-01 12:00:00 + - 12 + + +**Sample** ``CMAKE_FLAGS`` **Setting** + +.. code-block:: console + + export CMAKE_FLAGS="-DAPP=LND" + +============================================= +Seasonal to Subseasonal (S2S) Configurations +============================================= + +**COMING SOON!** + +============== +NG-GODAS +============== + +**COMING SOON!** + +======================================================== +Hurricane Analysis and Reforecast System Configurations +======================================================== + +**COMING SOON!** + + + + + diff --git a/doc/UsersGuide/source/index.rst b/doc/UsersGuide/source/index.rst index f5e638de4b..c6636e8452 100644 --- a/doc/UsersGuide/source/index.rst +++ b/doc/UsersGuide/source/index.rst @@ -14,6 +14,7 @@ Welcome to the UFS Weather Model User's Guide CodeOverview BuildingAndRunning InputsOutputs + Configurations ConfigParameters AutomatedTesting FAQ From 4fac1a6515fe098ff6a8bfc39f1996f22fd44822 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 18 May 2023 17:02:16 -0400 Subject: [PATCH 17/44] add docn def --- doc/UsersGuide/source/Glossary.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index f84b4d4b74..71ce72b8a5 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -55,7 +55,10 @@ Glossary Cron is a job scheduler accessed through the command-line on UNIX-like operating systems. It is useful for automating tasks such as regression testing. Cron periodically checks a cron table (aka crontab) to see if any tasks are are ready to execute. If so, it runs them. DATM - DATM is the *Data Atmosphere* component of :term:`CDEPS`. It uses static atmospheric forcing files (derived from observations or previous atmospheric model runs) instead of output from an active atmospheric model. This reduces the complexity and computational cost associated with coupling to an active atmospheric model. The *Data Atmosphere* component is particularly useful when employing computationally intensive Data Assimilation (DA) techniques to update ocean and/or sea ice fields in a coupled model. In general, use of DATM in place of :term:`ATM` can be appropriate when users are running a coupled model and only want certain components of the model to be active. More information about DATM is available in the `CDEPS Documentation `__. + DATM is the *Data Atmosphere* component of :term:`CDEPS`. It uses static atmospheric forcing files (derived from observations or previous atmospheric model runs) instead of output from an active atmospheric model. This reduces the complexity and computational cost associated with coupling to an active atmospheric model. The *Data Atmosphere* component is particularly useful when employing computationally intensive Data Assimilation (DA) techniques to update ocean and/or sea ice fields in a coupled model. In general, use of DATM in place of :term:`ATM` can be appropriate when users are running a coupled model and only want certain components of the model to be active. More information about DATM is available in the `CDEPS Documentation `__. + + DOCN + DOCN is the *Data Ocean* component of :term:`CDEPS`. It uses static ocean forcing files (derived from observations or previous ocean model runs) instead of output from an active ocean model. This reduces the complexity and computational cost associated with coupling to an active ocean model. The *Data Ocean* component is particularly useful when employing computationally intensive Data Assimilation (DA) techniques to update atmospheric fields in a coupled model. In general, use of DOCN in place of :term:`MOM6` or :term:`HYCOM` can be appropriate when users are running a coupled model and only want certain components of the model to be active. More information about DOCN is available in the `CDEPS Documentation `__. dycore dynamical core From e16ab1b6298cbdde276230b98d04040a7b63e8d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 10:49:18 -0400 Subject: [PATCH 18/44] add RT def --- doc/UsersGuide/source/Glossary.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index 71ce72b8a5..c927e691fb 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -154,6 +154,10 @@ Glossary Post-processor Software that enhances the value of the raw forecasts produced by the modeling application to make them more useful. At :term:`NCEP`, the :term:`UPP` (Unified Post Processor) software is used to convert data from spectral to gridded format, de-stagger grids, interpolate data vertically (e.g., to isobaric levels) and horizontally (to various predefined grids), and to compute derived variables. Some types of post-processors, such as statistical post-processors, use historical information of previous runs and observations to de-bias and calibrate its output. + Regression test + RT + Tests to validate that software still performs as expected after a change. In general, RTs ensure that the code should produce the same results and performance, within predefined measures of variance. When a code change is designed to change results or performance, then a new baseline is created. From these baselines, regression tests determine whether a change has occurred. + SRW SRW App Short-Range Weather Application From a408900f55ddb1598e7ad681ea8a53a6b8c7556b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 10:50:54 -0400 Subject: [PATCH 19/44] minor B/R updates --- doc/UsersGuide/source/BuildingAndRunning.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index 3f92372d1e..855d254b31 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -46,7 +46,7 @@ Research & Development HPC Systems (RDHPCS). Common Modules ---------------- -As of March 23, 2023, the UFS WM Regression Tests on Level 1 systems use the following common modules: +As of March 23, 2023, the UFS WM Regression Tests (:term:`RTs `) on Level 1 systems use the following common modules: .. code-block:: console @@ -132,7 +132,7 @@ The most updated list of modules can be viewed in ``ufs_common.lua`` Get Data ============ -The WM regression tests (RTs) require input files to run. +The WM RTs require input files to run. These include static datasets, files that depend on grid resolution and initial/boundary conditions, and model configuration files. On Level 1 systems, the data required to run the WM RTs are already available in the following locations: @@ -345,7 +345,7 @@ For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :ter .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=control_p8_atmlnd_sbs" + export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=FV3_GFS_v17_p8" S2S Configurations ---------------------- From 94f465e0afd7433d9cbfe2ef904d75739c0ae746 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 10:51:30 -0400 Subject: [PATCH 20/44] add details for ATM/ATML/LND configs --- doc/UsersGuide/source/Configurations.rst | 182 +++++++++++++++++++---- 1 file changed, 156 insertions(+), 26 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index b7b3356301..a19df6d812 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -5,8 +5,8 @@ Configurations ************************* The UFS Weather Model (WM) can be run in any of several configurations, from a single-component atmospheric -model to a fully coupled model with multiple earth system components (e.g., atmosphere, ocean, sea-ice and -mediator). This chapter documents a few of the curently supported configurations. For a full list of +model to a fully coupled model with multiple earth system components (e.g., atmosphere, ocean, sea-ice, land, and +mediator). This chapter documents a few of the currently supported configurations. For a full list of supported configurations, view the `rt.conf `__ and `rt.gnu.conf `__ files. @@ -18,20 +18,22 @@ and `rt.gnu.conf ` + * - :ref:`ATM ` - Standalone Atmospheric Model (:term:`ATM`) - * - :ref:`LND ` + * - :ref:`ATML ` + - Coupled :term:`ATM` and :term:`LND` + * - :ref:`LND ` - Coupled :term:`CDEPS` - :term:`DATM` - :term:`LND` -:term:`CMEPS` -This chapter details the build and run options for each supported configuration. -Click on the Configuration Name in :numref:`Table %s ` -to go to that section. Each configuration includes sample code for setting ``CMAKE_FLAGS`` and ``CCPP_SUITES``. +This chapter details the supported build/run options for each supported configuration. +Click on the configuration category in :numref:`Table %s ` +to go to that section. Each configuration category includes sample code for setting ``CMAKE_FLAGS`` and ``CCPP_SUITES``. Additionally, there is a list of preferred physics suites, examples of ``nems.configure`` files, and links to information on other input files required to run the model. @@ -39,7 +41,14 @@ and links to information on other input files required to run the model. Background ============ -Each RT configuration file (located in the ``tests/tests`` `directory `__) sets default variables by calling setup functions from ``tests/default_vars.sh`` (see defaults `here `__). Then, the RT configuration file sets test-specific variables; these values will override the defaults. For example, the ``control_c48`` test file sets a list of files that it will use, calls the ``export_fv3`` function from ``default_vars.sh``, and then exports test-specific variables. An excerpt is included below (``...`` indicates omitted lines): +Each RT configuration file (located in the ``ufs-weather-model/tests/tests`` +`directory `__) +sets default variables by calling setup functions from ``ufs-weather-model/tests/default_vars.sh`` +(see defaults `here `__). +Then, the RT configuration file sets test-specific variables; these values will override +the defaults. For example, the ``control_c48`` test file sets a list of files that +it will use, calls the ``export_fv3`` function from ``default_vars.sh``, and then exports +test-specific variables. An excerpt is included below (``...`` indicates omitted lines): .. code-block:: console @@ -65,7 +74,7 @@ Each RT configuration file (located in the ``tests/tests`` `directory ` describes what each function does. Multiple functions may be called in a given RT. +``default_vars.sh`` contains eight functions that set defaults for different types of tests. :numref:`Table %s ` describes what each function does. .. _def-funcs: @@ -76,21 +85,30 @@ Each RT configuration file (located in the ``tests/tests`` `directory `__). + - Set variables to the default values for EMC's weekly coupled benchmark 35d tests (see `rt_35d.conf `__). * - export_datm_cdeps - - Export variables to the default values for configurations that use the data atmosphere (:term:`DATM`) component. + - Set variables to the default values for configurations that use the data atmosphere (:term:`DATM`) component. * - export_hafs_datm_cdeps - - Export variables to the default values for HAFS configurations that use the data atmosphere (DATM) component. + - Set variables to the default values for HAFS configurations that use the data atmosphere (DATM) component. * - export_hafs_docn_cdeps - - Export variables to the default values for HAFS configurations that use the data ocean (:term:`DOCN`) component. + - Set variables to the default values for HAFS configurations that use the data ocean (:term:`DOCN`) component. * - export_hafs_regional - - Export variables to the default values for regional HAFS configurations. + - Set variables to the default values for regional HAFS configurations. * - export_hafs - - Export variables to the default values for HAFS configurations. + - Set variables to the default values for HAFS configurations. + +Multiple ``default_vars.sh`` functions may be called in a given test. Values set in one +function will be overridden when the same values are set in a subsequent function. + +The most up-to-date list of ``develop`` branch data required for each test is available in +the `UFS WM RT Data Bucket `__. +Users should click on "Browse Bucket" and navigate to the most recent date (in ``develop-YYYY-MM-DD`` format). +Then, users should select *Intel* or *GNU* based on the compiler used in the test they +want to run and then select the test name to see the required data. ==================================== Atmospheric Model Configurations @@ -99,7 +117,7 @@ Atmospheric Model Configurations The atmospheric model configurations all use the UFS WM atmospheric component and may couple it with other models (e.g., a wave or aerosol model). -.. _atm_documented: +.. _atm-documented: ATM - Standalone Atmospheric Model ===================================== @@ -108,7 +126,9 @@ The standalone atmospheric model (:term:`ATM`) is an :term:`FV3`-based prognosti atmospheric model that can be used for short- and medium-range research and operational forecasts. In standalone mode, ``ATM`` is not coupled to any other model. -Current ATM regression tests cover a wide variety of functionality and involve several physics tests. :numref:`Table %s ` contains a selection of ATM-only RTs; it will be expanded to cover the full range of ATM-only supported configurations in time: +Current ATM regression tests cover a wide variety of functionality and involve several +physics tests. :numref:`Table %s ` contains a small selection of ATM-only RTs; +it will be expanded to cover the full range of ATM-only supported configurations in time: .. _atm-rts: @@ -118,7 +138,7 @@ Current ATM regression tests cover a wide variety of functionality and involve s * - Test Name - Description - - Physics suite + - Physics Suite - DT_ATMOS - Start Date - Forecast Length (hours) @@ -147,12 +167,114 @@ Current ATM regression tests cover a wide variety of functionality and involve s export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_GFS_v16,FV3_GFS_v17_p8,FV3_GFS_v15_thompson_mynn_lam3km -D32BIT=ON" -.. _lnd_documented: +**Supported Physics Suites** + +.. list-table:: *Physics suites used in the ATM configurations above* + :widths: 10 50 + :header-rows: 1 + + * - Physics Suite + - Description + * - FV3_GFS_v16 + - The :term:`CCPP` GFS_v16 physics suite is described in the CCPP documentation `here `__. + * - FV3_GFS_v17_p8 + - The CCPP GFS_v17_p8 physics suite is described in the CCPP documentation `here `__. + * - FV3_GFS_v15_thompson_mynn_lam3km + - The CCPP GFS_v15 physics suite with the Thompson Aerosol-Aware Cloud Microphysics Scheme + (see `here `__) and + Mynn Surface Layer Module (see `here `__) + tailored for a limited area model (LAM) 3-km resolution grid. + +**Additional Information** + +Input files required for ATM configurations can be viewed in :numref:`Section %s ` +or in the `UFS WM RT Data Bucket `__. +Information on ``nems.configure`` files is available in :numref:`Section %s `, +and a sample ATM ``nems.configure`` file (``nems.configure.atm.IN``) is available +`here `__. + + +ATMW +======= +**COMING SOON!** + +ATMAERO +========= + +**COMING SOON!** + +ATMAQ +======= + +**COMING SOON!** + +.. _atml-documented: + +ATML +====== + +The ATML configuration couples :term:`ATM` with :term:`LND`. +These tests use default values set in the ``export_fv3`` function of ``default_vars.sh``. + +.. attention:: + There is an issue with ``-D32BIT=ON`` in the ATM-LND tests, and NoahMP requires r8 libraries. + +.. COMMENT: Should "r8" be "p8"? + +.. _atml-rts: + +.. list-table:: *ATML regression test descriptions* + :widths: 10 40 10 10 15 5 + :header-rows: 1 + + * - Test Name + - Description + - Physics Suite + - DT_ATMOS + - Start Date + - Forecast Length (hours) + * - control_p8_atmlnd_sbs + - Compare global control results with previous trunk version + - FV3_GFS_v17_p8 + - 720 + - 2021-03-22 06:00:00 + - 24 + +**Sample** ``CMAKE_FLAGS`` **Setting** + +.. code-block:: console + + export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=FV3_GFS_v17_p8" + + +**Supported Physics Suites** + +.. list-table:: *Physics suites used in the ATM configurations above* + :widths: 10 50 + :header-rows: 1 + + * - Physics Suite + - Description + * - FV3_GFS_v17_p8 + - The :term:`CCPP` GFS_v17_p8 physics suite is described in the CCPP documentation `here `__. + +**Additional Information** + +Input files required for ATML configurations can be viewed in :numref:`Section %s (ATM) ` +and :numref:`Section %s (LND) ` or in the `UFS WM RT Data Bucket `__. +Information on ``nems.configure`` files is available in :numref:`Section %s `, +and a sample ATML ``nems.configure`` file (``nems.configure.atm_lnd.IN``) is available +`here `__. + + +.. _lnd-documented: + +======= LND ======= -The LND configuration couples :term:`DATM`, :term:`CDEPS`, and :term:`CMEPS` with :term:`LND`. These test use default values set in the ``export_datm_cdeps`` function of ``default_vars.sh``. +The LND configuration couples :term:`DATM`, :term:`CDEPS`, and :term:`CMEPS` with :term:`LND`. These tests use default values set in the ``export_datm_cdeps`` function of ``default_vars.sh``. .. _lnd-rts: @@ -162,7 +284,7 @@ The LND configuration couples :term:`DATM`, :term:`CDEPS`, and :term:`CMEPS` wit * - Test Name - Description - - Physics suite + - Physics Suite - DT_ATMOS - Start Date - Forecast Length (hours) @@ -179,13 +301,21 @@ The LND configuration couples :term:`DATM`, :term:`CDEPS`, and :term:`CMEPS` wit - 2000-01-01 12:00:00 - 12 - **Sample** ``CMAKE_FLAGS`` **Setting** .. code-block:: console export CMAKE_FLAGS="-DAPP=LND" +**Additional Information** + +Input files required for LND configurations can be viewed in :numref:`Section %s (LND) ` +or in the `UFS WM RT Data Bucket `__. +Information on ``nems.configure`` files is available in :numref:`Section %s `, +and a sample ATML ``nems.configure`` file (``nems.configure.atm_lnd.IN``) is available +`here `__. + + ============================================= Seasonal to Subseasonal (S2S) Configurations ============================================= From 159fda4c31a2891cb9128b37ccf653d1b773bd0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 10:52:29 -0400 Subject: [PATCH 21/44] add ATML nems.config; other minor updates --- doc/UsersGuide/source/InputsOutputs.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst index 679641785f..30f9b3bbf0 100644 --- a/doc/UsersGuide/source/InputsOutputs.rst +++ b/doc/UsersGuide/source/InputsOutputs.rst @@ -63,6 +63,8 @@ There are three types of files needed to execute a run: Information on the first two types of file appears in detail below for each component model. Information on Model Configuration files can be viewed in :numref:`Section %s `. +.. _atm-io: + ------- ATM ------- @@ -1515,6 +1517,8 @@ are not usually changed. - integer - 0 +.. _nems-conf: + ------------------------ ``nems.configure`` file ------------------------ From 58e27565adb077ff9df2725e1eedb679f1eb594e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 17:42:19 -0400 Subject: [PATCH 22/44] minor Glossary update --- doc/UsersGuide/source/Glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index c927e691fb..c325d647c6 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -154,8 +154,8 @@ Glossary Post-processor Software that enhances the value of the raw forecasts produced by the modeling application to make them more useful. At :term:`NCEP`, the :term:`UPP` (Unified Post Processor) software is used to convert data from spectral to gridded format, de-stagger grids, interpolate data vertically (e.g., to isobaric levels) and horizontally (to various predefined grids), and to compute derived variables. Some types of post-processors, such as statistical post-processors, use historical information of previous runs and observations to de-bias and calibrate its output. - Regression test RT + Regression test Tests to validate that software still performs as expected after a change. In general, RTs ensure that the code should produce the same results and performance, within predefined measures of variance. When a code change is designed to change results or performance, then a new baseline is created. From these baselines, regression tests determine whether a change has occurred. SRW From 42a9f51410423f6662126c61cb935f8d014d5f59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 17:45:33 -0400 Subject: [PATCH 23/44] Build/Run updates --- doc/UsersGuide/source/BuildingAndRunning.rst | 226 +++++++------------ 1 file changed, 85 insertions(+), 141 deletions(-) diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index 855d254b31..ed756249e2 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -20,7 +20,7 @@ On other systems, users will need to build the prerequisite libraries using :ter Prerequisite Libraries ======================= -The UFS Weather Model (:term:`WM`) requires a number of libraries. +The UFS WM requires a number of libraries. The WM uses two categories of libraries, which are available as a bundle via :term:`HPC-Stack` or :term:`spack-stack`: @@ -28,25 +28,23 @@ The WM uses two categories of libraries, which are available as a bundle via Most have an NCEPLIBS prefix in the repository (e.g., NCEPLIBS-bacio). Select tools from the UFS Utilities repository (:term:`UFS_UTILS`) are also included in this category. - #. Third-party libraries (:term:`NCEPLIBS-external`): These are libraries that were developed external to + #. Third-party libraries (:term:`NCEPLIBS-external`): These are libraries that were developed externally to the UFS Weather Model. They are general software packages that are also used by other community models. Building these libraries is optional if users can point to existing builds of these libraries on their system instead. -Currently, HPC-Stack is the software stack validated by the UFS WM for running regression tests. -However, UFS applications are shifting to spack-stack, which is a Spack-based -method for installing UFS prerequisite software libraries. The spack-stack is currently -used on NOAA Cloud platforms and in containers, while HPC-Stack is still used on NOAA -Research & Development HPC Systems (RDHPCS). - -.. COMMENT: Is this still true? - The spack-stack locations listed in :numref:`Table %s ` are still being validated. +.. note:: + Currently, HPC-Stack is the software stack validated by the UFS WM for running :term:`regression tests `. + However, UFS applications are shifting to spack-stack, which is a Spack-based + method for installing UFS prerequisite software libraries. The spack-stack is currently + used on NOAA Cloud platforms and in containers, while HPC-Stack is still used on NOAA + Research & Development HPC Systems (RDHPCS). ---------------- Common Modules ---------------- -As of March 23, 2023, the UFS WM Regression Tests (:term:`RTs `) on Level 1 systems use the following common modules: +As of May 19, 2023, the UFS WM Regression Tests (:term:`RTs `) on Level 1 systems use the following common modules: .. code-block:: console @@ -68,7 +66,7 @@ As of March 23, 2023, the UFS WM Regression Tests (:term:`RTs `) on Level 1 w3emc/2.9.2 zlib/1.2.11 -The most updated list of modules can be viewed in ``ufs_common.lua`` +The most updated list of common modules can be viewed in ``ufs_common.lua`` `here `__. .. attention:: @@ -76,56 +74,6 @@ The most updated list of modules can be viewed in ``ufs_common.lua`` and `spack-stack `__, respectively. One of these software stacks (or the libraries they contain) must be installed before running the UFS Weather Model. -.. COMMENT: Add spack stack (and HPC-Stack?) locations: - On Level 1 systems, HPC-Stack and spack-stack are installed in the following locations: - - .. _stack-locations: - - .. table:: Stack Locations - - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Platform | HPC-Stack/spack-stack Installation | - +==============+=========================================================================================================================================+ - | WCOSS2 | N/A | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Hera (Intel) | HPC-Stack: /scratch1/NCEPDEV/nems/role.epic/hpc-stack/libs/intel-2022.1.2/modulefiles/stack | - | | | - | | spack-stack: /scratch1/NCEPDEV/jcsda/jedipara/spack-stack/modulefiles | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Hera (GNU) | HPC-Stack: /scratch1/NCEPDEV/nems/role.epic/hpc-stack/libs/gnu-9.2/modulefiles/stack | - | | | - | | spack-stack: /scratch1/NCEPDEV/global/spack-stack/spack-stack-v1/envs/skylab-3.0.0-intel-2021.5.0/install/modulefiles/Core | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Gaea | HPC-Stack: /lustre/f2/dev/role.epic/contrib/hpc-stack/intel-2021.3.0_noarch/modulefiles/stack | - | | | - | | spack-stack: /lustre/f2/pdata/esrl/gsd/spack-stack/modulefiles | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Jet | HPC-Stack: /mnt/lfs4/HFIP/hfv3gfs/role.epic/hpc-stack/libs/intel-2022.1.2/modulefiles/stack | - | | | - | | spack-stack: Coming soon! | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Orion | HPC-Stack: /work/noaa/epic-ps/role-epic-ps/hpc-stack/libs/intel-2022.1.2/modulefiles/stack | - | | | - | | spack-stack: /work/noaa/da/role-da/spack-stack/modulefiles | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Cheyenne | HPC-Stack: /glade/work/epicufsrt/contrib/hpc-stack/intel2022.1/modulefiles/stack | - | (Intel) | | - | | spack-stack: /glade/work/jedipara/cheyenne/spack-stack/modulefiles/misc | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Cheyenne | HPC-Stack: /glade/work/epicufsrt/contrib/hpc-stack/gnu10.1.0/modulefiles/stack | - | (GNU) | | - | | spack-stack: /glade/work/jedipara/cheyenne/spack-stack/spack-stack-feature-r2d2-mysql/envs/unified-4.0.0-rc1/install/modulefiles/Core | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | NOAA Cloud | HPC-Stack: N/A | - | (AWS/GCP/ | | - | Azure) | spack-stack: /contrib/spack-stack/modulefiles/core | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - - On Level 2-4 Systems, users will need to install the HPC-Stack or the spack-stack and load the appropriate modules. - The `HPC-Stack `__ and - `spack-stack `__ documentation is the authoritative - source for details on installation and configuration of each respective stack. - .. _GetData: ============ @@ -161,54 +109,54 @@ Publicly available RT data is available in the `UFS WM Data Bucket `. @@ -225,7 +173,7 @@ To clone the develop branch of the ``ufs-weather-model`` repository and update i git clone --recursive https://github.com/ufs-community/ufs-weather-model.git ufs-weather-model cd ufs-weather-model -Compiling the model will take place within the ``ufs-weather-model`` directory you just created. +Compiling the model will take place within the ``ufs-weather-model`` directory created by this command. ========================== Building the Weather Model @@ -286,12 +234,12 @@ manually. For example, in a bash shell, a command in the following form will set Setting the ``CMAKE_FLAGS`` and ``CCPP_SUITES`` Environment Variables ------------------------------------------------------------------------ -The UFS Weather Model can be built in one of several configurations (cf. :numref:`Table %s ` for common options). -The ``CMAKE_FLAGS`` environment variable specifies which configuration to build. -Additionally, users must select the :term:`CCPP` suite(s) by setting the ``CCPP_SUITES`` environment variable at -build time in order to have one or more CCPP physics suites available at runtime. Multiple suites can be set. -Additional environment variables, such as ``-D32BIT=ON``, can be set if the user chooses. These options are documented -in :numref:`Section %s `. +The UFS Weather Model can be built in one of several configurations (see :numref:`Table %s ` for common options). +The ``CMAKE_FLAGS`` environment variable specifies which configuration to build using the ``-DAPP`` and ``-DCCPP_SUITES`` variables. +Users set which components to build using ``-DAPP``. Users select the :term:`CCPP` suite(s) by setting the +``CCPP_SUITES`` environment variable at build time in order to have one or more CCPP physics suites available at runtime. +Multiple suites can be set. Additional variables, such as ``-D32BIT=ON``, +can be set if the user chooses. These options are documented in :numref:`Section %s `. The following examples assume a bash shell. ATM Configurations @@ -452,7 +400,7 @@ For the ``ufs-weather-model HAFS-ALL`` configuration (data/atm/ocean/wave) in 32 export CMAKE_FLAGS="-DAPP=HAFS-ALL -D32BIT=ON -DCCPP_SUITES=FV3_HAFS_v0_gfdlmp_tedmf,FV3_HAFS_v0_gfdlmp_tedmf_nonsst" -LND Configurations +LND Configuration ---------------------- .. _lnd: @@ -487,8 +435,8 @@ The WM can be built by running the following command from the ``ufs-weather-mode ./build.sh -Once ``build.sh`` is finished, you should see the executable, named ``ufs_model``, in the ``ufs-weather-model/build/`` directory. -If it is desired to build in a different directory, specify the ``BUILD_DIR`` environment variable. For example: ``export BUILD_DIR=test_cpld`` +Once ``build.sh`` is finished, users should see the executable, named ``ufs_model``, in the ``ufs-weather-model/build/`` directory. +If users prefer to build in a different directory, specify the ``BUILD_DIR`` environment variable. For example: ``export BUILD_DIR=test_cpld`` will build in the ``ufs-weather-model/test_cpld`` directory instead. Expert help is available through `GitHub Discussions `__. Users may post questions there for help with difficulties related to the UFS WM. @@ -520,13 +468,13 @@ Users must edit the ``rt.conf`` file to indicate which tests/configurations to r The ``rt.conf`` File ------------------------ -Each line in the PSV (Pipe-separated values) file ``rt.conf`` contains four columns of information. +Each line in the PSV (Pipe-separated values) file, ``rt.conf``, contains four columns of information. The first column specifies whether to build a test (``COMPILE``) or run a test (``RUN``). The second column specifies either configuration information for building a test or the name of a test to run. -Thus, the second column in a ``COMPILE`` line will list the application to build (e.g., ``APP=S2S``), -the CCPP suite to use (e.g., ``SUITES=FV3_GFS_2017_coupled``), and additional build options -(e.g., ``DEBUG=Y``) as needed. On a ``RUN`` line, the second column will contain a test name +Thus, the second column in a ``COMPILE`` line will list the application to build (e.g., ``-DAPP=S2S``), +the CCPP suite to use (e.g., ``-DCCPP_SUITES=FV3_GFS_2017_coupled``), and additional build options +(e.g., ``-DDEBUG=ON``) as needed. On a ``RUN`` line, the second column will contain a test name (e.g., ``control_p8``). The test name should match the name of one of the test files in the ``tests/tests`` directory or, if the user is adding a new test, the name of the new test file. The third column of ``rt.conf`` relates to the platform; @@ -538,10 +486,8 @@ and ``fv3`` means that the test will be included during baseline creation. The order of lines in ``rt.conf`` matters since ``rt.sh`` processes them sequentially; a ``RUN`` line should be preceeded by a ``COMPILE`` line that builds the model used in the test. The following -``rt.conf`` file excerpt builds the standalone ATM model in 32-bit mode and then runs the -``control`` test: - -.. COMMENT: Is the control test just the test with which other tests are compared? +``rt.conf`` file excerpt builds the standalone ATM model with GFS_v16 physics +in 32-bit mode and then runs the ``control`` test: .. code-block:: console @@ -572,16 +518,14 @@ On Other Systems Users on non-NOAA systems will need to make adjustments to several files in the ``tests`` directory before running ``rt.sh``, including: - * rt.sh - * run_test.sh - * detect_machine.sh - * default_vars.sh - * fv3_conf/fv3_slurm.IN_* - * fv3_conf/compile_slurm.IN_* - * compile.sh - * module-setup.sh - -.. COMMENT: Add details when Zach's PR is merged. + * ``rt.sh`` + * ``run_test.sh`` + * ``detect_machine.sh`` + * ``default_vars.sh`` + * ``fv3_conf/fv3_slurm.IN_*`` + * ``fv3_conf/compile_slurm.IN_*`` + * ``compile.sh`` + * ``module-setup.sh`` .. _rt.sh: @@ -622,7 +566,7 @@ The ``-c`` option is used to create a baseline. New baselines are needed when co to result changes and therefore deviate from existing baselines on a bit-for-bit basis. To run ``rt.sh`` using a custom configuration file and the Rocoto workflow manager, -creat the configuration file (e.g. ``my_rt.conf``) based on the desired tests in +create the configuration file (e.g. ``my_rt.conf``) based on the desired tests in ``rt.conf``, and run: .. code-block:: console @@ -641,7 +585,7 @@ Troubleshooting ^^^^^^^^^^^^^^^^^^ Users may need to adjust certain information in the ``rt.sh`` file, such as -the ``'Machine'`` and ``'Account'`` variables (``$ACCNR`` and ``$MACHINE_ID``), for the tests to run +the *Machine* and *Account* variables (``$MACHINE_ID`` and ``$ACCNR``), for the tests to run correctly. If there is a problem with these or other variables (e.g., file paths), the output should indicate where: .. code-block:: console @@ -676,7 +620,7 @@ The run directory path, which corresponds to the value of ``RUNDIR`` in the ``ru is particularly useful. ``$RUNDIR`` is a self-contained (i.e., sandboxed) directory with the executable file, initial conditions, model configuration files, environment setup scripts and a batch job submission script. The user can run the test -by ``cd``-ing into ``$RUNDIR`` and invoking the command: +by navigating into ``$RUNDIR`` and invoking the command: .. code-block:: console From c4dfba9b9d117594ad95f3f6d04ba84c2b018c32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 17:59:34 -0400 Subject: [PATCH 24/44] minor I/O updates --- doc/UsersGuide/source/InputsOutputs.rst | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst index 30f9b3bbf0..7e19dca68a 100644 --- a/doc/UsersGuide/source/InputsOutputs.rst +++ b/doc/UsersGuide/source/InputsOutputs.rst @@ -25,7 +25,7 @@ mediator). Currently, supported configurations include: * - :ref:`ATMAQ ` - :term:`ATM` coupled to :term:`CMAQ` * - :ref:`ATML ` - - Coupled :term:`ATM`- :term:`LND` - :term:`MOM6` - :term:`CICE6` - :term:`CMEPS` + - :term:`ATM` coupled to :term:`LND` * - :ref:`S2S ` - Coupled :term:`ATM` - :term:`MOM6` - :term:`CICE6` - :term:`CMEPS` * - :ref:`S2SA ` @@ -45,11 +45,9 @@ mediator). Currently, supported configurations include: * - :ref:`HAFS-ALL ` - Coupled :term:`CDEPS` - :term:`ATM` - :term:`HYCOM` - :term:`WW3` - :term:`CMEPS` - -.. COMMENT: CMEPS for LND? Are those the right components for ATML? .. COMMENT: Should HAFS-ALL be DATM instead of ATM? -This chapter describes the input and output files needed for executing the model in the various supported configurations (see :numref:`Table %s `). Each of the component models for a given configuration requires specific input files, and each component model outputs a particular set of files. Each configuration requires a set of model configuration files, as well. This chapter describes the input and output files involved with each component model. It also discusses the various configuration files involved in running the model. Users will need to view the input file requirements for each component model involved in the configuration they are running. For example, users running the *S2S* configuration would need to gather input data required for the *ATM*, *MOM6*, and *CICE6* component models. Then, they would need to alter certain model configuration files to reflect the ``ufs-weather-model`` configuration they plan to run. +This chapter describes the input and output files needed for executing the model in the various supported configurations (see :numref:`Table %s `). Each of the component models for a given configuration requires specific input files, and each component model outputs a particular set of files. Each configuration requires a set of model configuration files, as well. This chapter describes the input and output files involved with each component model. It also discusses the various configuration files involved in running the model. Users will need to view the input file requirements for each component model involved in the configuration they are running. For example, users running the *S2S* configuration would need to gather input data required for the *ATM*, *MOM6*, and *CICE6* component models. Then, they would need to alter certain model configuration files to reflect the ``ufs-weather-model`` configuration that they plan to run. ============= Input files @@ -1540,9 +1538,6 @@ However, ``nems.configure`` files for other configurations of the Weather Model * :doc:`ATMAQ ` configuration * :doc:`S2S ` (fully coupled ``S2S`` configuration that receives atmosphere-ocean fluxes from a mediator) - - .. COMMENT: Is this a regular S2S nems.configure file, or is it special? What's the talk about "atmosphere-oceans fluxes"? - * :doc:`S2SW ` (fully coupled ``S2SW`` configuration) * :doc:`S2SWA ` (coupled GOCART in the S2SAW configuration) * :doc:`NG-GODAS ` (coupled NG-GODAS configuration) From 9aba8ec6f77fe85f55532d5b5f190a8d7ae78973 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 19 May 2023 18:04:30 -0400 Subject: [PATCH 25/44] fix AWS compiler --- doc/UsersGuide/source/CodeOverview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/CodeOverview.rst b/doc/UsersGuide/source/CodeOverview.rst index ea82442849..9a5cd52771 100644 --- a/doc/UsersGuide/source/CodeOverview.rst +++ b/doc/UsersGuide/source/CodeOverview.rst @@ -29,7 +29,7 @@ Currently, Level 1 (or Tier-1) platforms for regression testing are: * Hera (Intel/GNU compilers) * Jet (Intel) * Orion (Intel) - * AWS Docker container (GNU) + * AWS Docker container (Intel) More information is available in the `UFS WM wiki `__. From c0fc04268504eae8b8427e9780f0e3627497d3c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Mon, 22 May 2023 21:48:33 -0400 Subject: [PATCH 26/44] fix WW3 dir & lvls of support --- doc/UsersGuide/source/CodeOverview.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/UsersGuide/source/CodeOverview.rst b/doc/UsersGuide/source/CodeOverview.rst index 9a5cd52771..b421bbe123 100644 --- a/doc/UsersGuide/source/CodeOverview.rst +++ b/doc/UsersGuide/source/CodeOverview.rst @@ -12,9 +12,9 @@ Supported Systems for Running the UFS Weather Model Four levels of support have been defined for :term:`UFS` applications, and the UFS Weather Model (:term:`WM`) operates under this paradigm: -* **Level 1** *(Preconfigured)*: Prerequisite software libraries are pre-built and available in a central location; code builds; full testing of model. -* **Level 2** *(Configurable)*: Prerequisite libraries are not available in a centralized location but are expected to install successfully; code builds; full testing of model. -* **Level 3** *(Limited-test platforms)*: Libraries and code build on these systems, but there is limited testing of the model. +* **Level 1** *(Preconfigured)*: Prerequisite software libraries are pre-built and available in a central location; code builds and runs; full testing of model. +* **Level 2** *(Configurable)*: Prerequisite libraries are not available in a centralized location but are expected to install successfully; code builds and runs; full testing of model. +* **Level 3** *(Limited-test platforms)*: Libraries and code build on these systems, but there is limited testing with running the model. * **Level 4** *(Build-only platforms)*: Libraries and code build, but running the model is not tested. Level 1 Systems @@ -157,4 +157,4 @@ The umbrella repository for the UFS WM is named ``ufs-weather-model``. Under thi │ └── fv3_conf └── WW3 └── (model) -------- WW3 model - └── (esmf) -------- NUOPC WW3 cap \ No newline at end of file + └── (src) -------- NUOPC WW3 caps \ No newline at end of file From 01693b7198a391c12c7a2c1f3a7d36151594dc71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 14 Jun 2023 13:20:44 -0400 Subject: [PATCH 27/44] add RRFS config info --- doc/UsersGuide/source/ConfigParameters.rst | 2 - doc/UsersGuide/source/Configurations.rst | 270 +++++++++++++++++- .../source/_static/theme_overrides.css | 7 + doc/UsersGuide/source/conf.py | 1 - 4 files changed, 274 insertions(+), 6 deletions(-) diff --git a/doc/UsersGuide/source/ConfigParameters.rst b/doc/UsersGuide/source/ConfigParameters.rst index 0fb0881411..c7738db65b 100644 --- a/doc/UsersGuide/source/ConfigParameters.rst +++ b/doc/UsersGuide/source/ConfigParameters.rst @@ -173,5 +173,3 @@ Other Build Options set(OPENMP ON CACHE BOOL "Enable OpenMP threading") set(PARALLEL_NETCDF OFF CACHE BOOL "Enable parallel NetCDF") set(JEDI_DRIVER OFF CACHE BOOL "Enable JEDI as top level driver") - - diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index a19df6d812..d214b0c4f6 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -30,6 +30,8 @@ and `rt.gnu.conf ` - Coupled :term:`CDEPS` - :term:`DATM` - :term:`LND` -:term:`CMEPS` + * - :ref:`RRFS ` + - :term:`ATM` with :term:`data assimilation` This chapter details the supported build/run options for each supported configuration. Click on the configuration category in :numref:`Table %s ` @@ -45,7 +47,7 @@ Each RT configuration file (located in the ``ufs-weather-model/tests/tests`` `directory `__) sets default variables by calling setup functions from ``ufs-weather-model/tests/default_vars.sh`` (see defaults `here `__). -Then, the RT configuration file sets test-specific variables; these values will override +Then, the RT configuration file sets test-specific variablesthese values will override the defaults. For example, the ``control_c48`` test file sets a list of files that it will use, calls the ``export_fv3`` function from ``default_vars.sh``, and then exports test-specific variables. An excerpt is included below (``...`` indicates omitted lines): @@ -138,7 +140,7 @@ it will be expanded to cover the full range of ATM-only supported configurations * - Test Name - Description - - Physics Suite + - Physics Suite (see namelist options `here `__) - DT_ATMOS - Start Date - Forecast Length (hours) @@ -230,7 +232,7 @@ These tests use default values set in the ``export_fv3`` function of ``default_v * - Test Name - Description - - Physics Suite + - Physics Suite (see namelist options `here `__) - DT_ATMOS - Start Date - Forecast Length (hours) @@ -268,6 +270,268 @@ and a sample ATML ``nems.configure`` file (``nems.configure.atm_lnd.IN``) is ava `here `__. +.. _rrfs-documented: + +======================================= +Rapid Refresh Forecast System (RRFS) +======================================= + +The RRFS configurations use an :term:`ATM`-only configuration on a high-resolution +regional grid with data assimilation capabilities. +These tests use default values set in the ``export_fv3`` function of ``default_vars.sh``. + +Current RRFS regression tests cover a wide variety of functionality and involve several +physics tests. :numref:`Table %s ` contains RTs for RRFS functionality; +in other words, : + + +.. _rrfs-rts: + +.. list-table:: *RRFS regression test descriptions* + :widths: 10 10 10 10 10 10 10 10 10 + :header-rows: 1 + + * - Test Name + - Description + - Physics Suite (see namelist options `here `__) + - DT_ATMOS + - Start Date + - Forecast Length (hours) + - Output Grid + - Configuration Files + - Notes + * - `rrfs_v1beta `__ / `rrfs_v1beta_debug `__ + - Compare RRFS_v1beta / rrfs_v1beta_debug results with previous trunk version + - FV3_RRFS_v1beta; IMP_PHYSICS=8 + - 300 + - 2021-03-22 06:00:00 + - 24 + - gaussian_grid + - INPUT_NML=rap.nml.IN | FIELD_TABLE=field_table_thompson_aero_tke | DIAG_TABLE=diag_table_rap_noah + - Notes: DO_SAT_ADJ=.false. ; LRADAR=.true. ; LTAEROSOL=.true. ; IALB=2; IEMS=2; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + * - `rrfs_v1nssl `__ + - Compare RRFS_v1nssl results with previous trunk version + - FV3_RRFS_v1nssl; IMP_PHYSICS=17 + - 300 + - 2021-03-22 06:00:00 + - 24 + - gaussian_grid + - INPUT_NML=rap.nml.IN | FIELD_TABLE=field_table_nssl_tke | DIAG_TABLE=diag_table_rap_noah; NSSL_CCN_ON=.true. + - Notes: NSSL_HAIL_ON=.true. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + * - `rrfs_v1nssl_nohailnoccn `__ + - Compare RRFS_v1nssl_nohailnoccn results with previous trunk version + - FV3_RRFS_v1nssl; IMP_PHYSICS=17 + - 300 + - 2021-03-22 06:00:00 + - 24 + - gaussian_grid + - FV3_RUN=control_run.IN | INPUT_NML=rap.nml.IN | FIELD_TABLE=field_table_nssl_nohailnoccn_tke | DIAG_TABLE=diag_table_rap_noah + - Notes: DNATS=0 ; NWAT=6 ; NSSL_CCN_ON=.false. ; NSSL_HAIL_ON=.false. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + * - `rrfs_conus13km_hrrr_warm `__ + - HRRR physics on 13km domain, control run + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 2 + - lambert_conformal + - FV3_RUN=rrfs_warm_run.IN | INPUT_NML=rrfs_conus13km_hrrr.nml.IN | FIELD_TABLE=field_table_thompson_aero_tke | DIAG_TABLE=diag_table_hrrr | MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + - Notes: LKM=1; IOPT_LAKE=2; SFCLAY_COMPUTE_FLUX=.true.; IALB=2; ICLIQ_SW=2; IEMS=2; IOVR=3; KICE=9; LSM=3; LSOIL_LSM=9; DO_MYNNSFCLAY=.true.; DO_MYNNEDMF=.true.; DO_MYJPBL=.true; HYBEDMF=.false.; SHAL_CNV=.false.; DO_SAT_ADJ=.false.; DO_DEEP=.false. ; MAKE_NH=.false.; NA_INIT=0; DNATS=0; EXTERNAL_IC=.false.; NGGPS_IC=.false.; MOUNTAIN=.true.; WARM_START=.true.; READ_INCREMENT=.false.; RES_LATLON_DYNAMICS="'fv3_increment.nc'"; FHZERO=1.0; LDIAG3D=.false.; QDIAG3D=.false.; FHCYC=0.0; IAER=1011; LHEATSTRG=.false.; RANDOM_CLDS=.false.; CNVCLD=.false.; IMFSHALCNV=-1; IMFDEEPCNV=-1; CDMBWD='3.5,1.0'; DO_SPPT=.false.; DO_SHUM=.false.; DO_SKEB=.false.; LNDP_TYPE=0; N_VAR_LNDP=0; GWD_OPT=3; DO_UGWP_V0=.false.; DO_UGWP_V0_OROG_ONLY=.false.; DO_GSL_DRAG_LS_BL=.true.; DO_GSL_DRAG_SS=.true.; DO_GSL_DRAG_TOFD=.true.; DO_UGWP_V1=.false.; DO_UGWP_V1_OROG_ONLY=.false.; FRAC_ICE=.true. + * - `rrfs_conus13km_hrrr_warm_debug `__ + - HRRR physics on 13km domain, debug run + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 1 + - lambert_conformal + - + - Notes: + * - `rrfs_conus13km_hrrr_warm_restart_mismatch `__ + - HRRR physics on 13km domain, control run + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 2 + - lambert_conformal + - + - Notes: + * - `rrfs_smoke_conus13km_hrrr_warm `__ + - HRRR smoke physics on 13km domain, control run + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 2 + - lambert_conformal + - + - Notes: + * - `rrfs_smoke_conus13km_hrrr_warm_2threads `__ + - HRRR smoke physics on 13km domain, different threads + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 2 + - lambert_conformal + - + - Notes: + * - `rrfs_smoke_conus13km_hrrr_warm_debug `__ + - HRRR smoke physics on 13km domain, control run + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 1 + - lambert_conformal + - + - Notes: + * - `rrfs_smoke_conus13km_hrrr_warm_debug_2threads `__ + - HRRR smoke physics on 13km domain, control run + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 1 + - lambert_conformal + - + - Notes: + * - `rrfs_smoke_conus13km_radar_tten_warm `__ + - HRRR smoke physics on 13km domain with radar-derived temperature tendencies + - FV3_HRRR; IMP_PHYSICS=8 + - 120 + - 2021-05-12 16:00:00 + - 2 + - lambert_conformal + - + - Notes: + +.. COMMENT: What are PEs??? And check rrfs_conus13km_hrrr_warm_restart_mismatch description. It's the same as the rrfs_conus13km_hrrr_warm description + +**Sample** ``CMAKE_FLAGS`` **Setting** + +.. code-block:: console + + export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_RAP,FV3_RAP_sfcdiff,FV3_HRRR,FV3_HRRR_flake,FV3_RRFS_v1beta,FV3_RRFS_v1nssl -D32BIT=ON" + +.. COMMENT: Edit this section! + +**Supported Physics Suites** + +.. COMMENT: Edit this section! + +.. list-table:: *Physics suites used in the RRFS configurations above* + :widths: 10 50 + :header-rows: 1 + + * - Physics Suite + - Description + * - FV3_RAP + - The FV3_RAP physics suite is described in the :term:`CCPP` documentation `here `__. + * - FV3_RAP_sfcdiff + - The FV3_RAP_sfcdiff physics suite is described in the CCPP documentation `here <>`__. + * - FV3_HRRR + - The FV3_HRRR physics suite is described in the CCPP documentation `here `__. + * - FV3_HRRR_flake + - The FV3_HRRR_flake physics suite is described in the CCPP documentation `here <>`__. + * - FV3_RRFS_v1beta + - The FV3_RRFS_v1beta physics suite is described in the CCPP documentation `here `__. + * - FV3_RRFS_v1nssl + - The FV3_RRFS_v1nssl physics suite is described in the CCPP documentation `here <>`__. + +**Additional Information** + +.. COMMENT: Edit this section! + +Input files required for RRFS ATM configurations can be viewed in :numref:`Table %s ` +or in the `UFS WM RT Data Bucket `__. + +.. COMMENT: Edit this section before adding! + + Information on ``nems.configure`` files is available in :numref:`Section %s `, + and a sample RRFS ``nems.configure`` file (``nems.configure.atm.IN``) is available + `here `__. + +.. _rrfs-files: + +.. list-table:: Files Required for RRFS RTs + :widths: 50 10 10 10 10 100 + :header-rows: 1 + + * - Tests + - sfcf*.nc + - atmf*.nc + - GFSFLX.GrbF* + - GFSPRS.GrbF* + - Other + * - rrfs_v1beta + - sfcf000.nc + sfcf009.nc + sfcf012.nc + - atmf000.nc + atmf009.nc + atmf012.nc + - GFSFLX.GrbF00 + GFSFLX.GrbF09 + GFSFLX.GrbF12 + - GFSPRS.GrbF00 + GFSPRS.GrbF09 + GFSPRS.GrbF12 + - coupler.research + + fv_core.res.nc + + fv_core.res.tile[1𔂰].nc ‑ + + fv_srf_wnd.res.tile[1-6].nc + + fv_tracer.res.tile[1-6].nc + + phy_data.tile[1-6].nc + + sfc_data.tile[1-6].nc + * - rrfs_v1beta_debug + rrfs_conus13km_hrrr_warm_debug + rrfs_smoke_conus13km_hrrr_warm_debug + rrfs_smoke_conus13km_hrrr_warm_debug_2threads + - sfcf000.nc + sfcf001.nc + - atmf000.nc + atmf001.nc + - + - + - + * - rrfs_v1nssl + rrfs_v1nssl_nohailnoccn + - sfcf000.nc + sfcf009.nc + sfcf012.nc + - atmf000.nc + atmf009.nc + atmf012.nc + - GFSFLX.GrbF00 + GFSFLX.GrbF09 + GFSFLX.GrbF12 + - GFSPRS.GrbF00 + GFSPRS.GrbF09 + GFSPRS.GrbF12 + - + * - rrfs_conus13km_hrrr_warm + rrfs_smoke_conus13km_hrrr_warm + rrfs_smoke_conus13km_hrrr_warm_2threads + rrfs_conus13km_radar_tten_warm + - sfcf000.nc + sfcf001.nc + sfcf002.nc + - atmf000.nc + atmf001.nc + atmf002.nc + - atmf000.nc + atmf009.nc + atmf012.nc + - + - + * - rrfs_conus13km_hrrr_warm_restart_mismatch + - sfcf002.nc + - atmf002.nc + - + - + - + .. _lnd-documented: ======= diff --git a/doc/UsersGuide/source/_static/theme_overrides.css b/doc/UsersGuide/source/_static/theme_overrides.css index 0416b736cd..cf37d00b7b 100644 --- a/doc/UsersGuide/source/_static/theme_overrides.css +++ b/doc/UsersGuide/source/_static/theme_overrides.css @@ -7,3 +7,10 @@ .wy-table-responsive table td, .wy-table-responsive table th { white-space: normal !important; } + + + + +table th:nth-of-type(6) { + width: 30%; +} \ No newline at end of file diff --git a/doc/UsersGuide/source/conf.py b/doc/UsersGuide/source/conf.py index 3ea9ae9025..ff1ce0db89 100644 --- a/doc/UsersGuide/source/conf.py +++ b/doc/UsersGuide/source/conf.py @@ -30,7 +30,6 @@ numfig = True - # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. From 159b9e5230c8acea79a251ec4cee46f330b494de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 15 Jun 2023 10:52:20 -0400 Subject: [PATCH 28/44] test non-breaking hyphen --- doc/UsersGuide/source/Configurations.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index d214b0c4f6..b87eeca8c5 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -475,15 +475,15 @@ or in the `UFS WM RT Data Bucket Date: Thu, 15 Jun 2023 10:55:30 -0400 Subject: [PATCH 29/44] test non-breaking hyphen --- doc/UsersGuide/source/Configurations.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index b87eeca8c5..d665a1cd22 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -475,11 +475,11 @@ or in the `UFS WM RT Data Bucket Date: Thu, 15 Jun 2023 10:58:08 -0400 Subject: [PATCH 30/44] test non-breaking hyphen --- doc/UsersGuide/source/Configurations.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index d665a1cd22..e4df4b8332 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -475,9 +475,9 @@ or in the `UFS WM RT Data Bucket Date: Thu, 15 Jun 2023 11:50:08 -0400 Subject: [PATCH 31/44] test non-breaking hyphen --- doc/UsersGuide/source/Configurations.rst | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index e4df4b8332..e1d5d31558 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -475,15 +475,15 @@ or in the `UFS WM RT Data Bucket Date: Thu, 15 Jun 2023 12:33:30 -0400 Subject: [PATCH 32/44] prevent line breaks in table file names --- doc/UsersGuide/source/Configurations.rst | 36 ++++++------------------ 1 file changed, 9 insertions(+), 27 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index e1d5d31558..98546bd76c 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -1,3 +1,6 @@ +.. |nbsp| unicode:: 0xA0 + :trim: + .. _Configurations: ************************* @@ -457,7 +460,7 @@ or in the `UFS WM RT Data Bucket Date: Wed, 21 Jun 2023 08:04:20 -0400 Subject: [PATCH 33/44] minor edits/formatting --- doc/UsersGuide/source/ConfigParameters.rst | 1 + doc/UsersGuide/source/Configurations.rst | 5 ++--- doc/UsersGuide/source/_static/theme_overrides.css | 7 ------- doc/UsersGuide/source/conf.py | 1 + 4 files changed, 4 insertions(+), 10 deletions(-) diff --git a/doc/UsersGuide/source/ConfigParameters.rst b/doc/UsersGuide/source/ConfigParameters.rst index c7738db65b..953d1264c4 100644 --- a/doc/UsersGuide/source/ConfigParameters.rst +++ b/doc/UsersGuide/source/ConfigParameters.rst @@ -173,3 +173,4 @@ Other Build Options set(OPENMP ON CACHE BOOL "Enable OpenMP threading") set(PARALLEL_NETCDF OFF CACHE BOOL "Enable parallel NetCDF") set(JEDI_DRIVER OFF CACHE BOOL "Enable JEDI as top level driver") + diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 98546bd76c..1052751675 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -284,8 +284,7 @@ regional grid with data assimilation capabilities. These tests use default values set in the ``export_fv3`` function of ``default_vars.sh``. Current RRFS regression tests cover a wide variety of functionality and involve several -physics tests. :numref:`Table %s ` contains RTs for RRFS functionality; -in other words, : +physics tests. :numref:`Table %s ` contains RTs for RRFS functionality. .. _rrfs-rts: @@ -294,7 +293,7 @@ in other words, : :widths: 10 10 10 10 10 10 10 10 10 :header-rows: 1 - * - Test Name + * - Test |nbsp| Name - Description - Physics Suite (see namelist options `here `__) - DT_ATMOS diff --git a/doc/UsersGuide/source/_static/theme_overrides.css b/doc/UsersGuide/source/_static/theme_overrides.css index cf37d00b7b..0416b736cd 100644 --- a/doc/UsersGuide/source/_static/theme_overrides.css +++ b/doc/UsersGuide/source/_static/theme_overrides.css @@ -7,10 +7,3 @@ .wy-table-responsive table td, .wy-table-responsive table th { white-space: normal !important; } - - - - -table th:nth-of-type(6) { - width: 30%; -} \ No newline at end of file diff --git a/doc/UsersGuide/source/conf.py b/doc/UsersGuide/source/conf.py index ff1ce0db89..3ea9ae9025 100644 --- a/doc/UsersGuide/source/conf.py +++ b/doc/UsersGuide/source/conf.py @@ -30,6 +30,7 @@ numfig = True + # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. From 848943d40748b976269b1db66bf939074e3bbf49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 21 Jun 2023 08:14:39 -0400 Subject: [PATCH 34/44] minor edits/formatting --- doc/UsersGuide/source/ConfigParameters.rst | 1 + doc/UsersGuide/source/Configurations.rst | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/doc/UsersGuide/source/ConfigParameters.rst b/doc/UsersGuide/source/ConfigParameters.rst index 953d1264c4..0fb0881411 100644 --- a/doc/UsersGuide/source/ConfigParameters.rst +++ b/doc/UsersGuide/source/ConfigParameters.rst @@ -174,3 +174,4 @@ Other Build Options set(PARALLEL_NETCDF OFF CACHE BOOL "Enable parallel NetCDF") set(JEDI_DRIVER OFF CACHE BOOL "Enable JEDI as top level driver") + diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 1052751675..42d939dcf9 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -599,3 +599,8 @@ Hurricane Analysis and Reforecast System Configurations ======================================================== **COMING SOON!** + + + + + From 1030815e33947542d0323ff45ce5a33732b5f843 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Wed, 21 Jun 2023 08:16:18 -0400 Subject: [PATCH 35/44] add nbsp --- doc/UsersGuide/source/Configurations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 42d939dcf9..dee65ae4ac 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -293,7 +293,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality :widths: 10 10 10 10 10 10 10 10 10 :header-rows: 1 - * - Test |nbsp| Name + * - Test |nbsp| Name |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| - Description - Physics Suite (see namelist options `here `__) - DT_ATMOS From fe2ad27f2b30cf14076bcfb9ee85238773b6796c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 23 Jun 2023 22:06:50 -0400 Subject: [PATCH 36/44] Add 'data assimilation' to Glossary --- doc/UsersGuide/source/Glossary.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index c325d647c6..55f4aa6848 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -54,6 +54,9 @@ Glossary cron table Cron is a job scheduler accessed through the command-line on UNIX-like operating systems. It is useful for automating tasks such as regression testing. Cron periodically checks a cron table (aka crontab) to see if any tasks are are ready to execute. If so, it runs them. + data assimilation + Data assimilation is the process of combining observations, model data, and error statistics to achieve the best estimate of the state of a system. One of the major sources of error in weather and climate forecasts is uncertainty related to the initial conditions that are used to generate future predictions. Even the most precise instruments have a small range of unavoidable measurement error, which means that tiny measurement errors (e.g., related to atmospheric conditions and instrument location) can compound over time. These small differences result in very similar forecasts in the short term (i.e., minutes, hours), but they cause widely divergent forecasts in the long term. Errors in weather and climate forecasts can also arise because models are imperfect representations of reality. Data assimilation systems seek to mitigate these problems by combining the most timely observational data with a "first guess" of the atmospheric state (usually a previous forecast) and other sources of data to provide a "best guess" analysis of the atmospheric state to start a weather or climate simulation. When combined with an "ensemble" of model runs (many forecasts with slightly different conditions), data assimilation helps predict a range of possible atmospheric states, giving an overall measure of uncertainty in a given forecast. + DATM DATM is the *Data Atmosphere* component of :term:`CDEPS`. It uses static atmospheric forcing files (derived from observations or previous atmospheric model runs) instead of output from an active atmospheric model. This reduces the complexity and computational cost associated with coupling to an active atmospheric model. The *Data Atmosphere* component is particularly useful when employing computationally intensive Data Assimilation (DA) techniques to update ocean and/or sea ice fields in a coupled model. In general, use of DATM in place of :term:`ATM` can be appropriate when users are running a coupled model and only want certain components of the model to be active. More information about DATM is available in the `CDEPS Documentation `__. From 927cb2d390273bfaee660b7957c7e1ab500d8462 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 23 Jun 2023 22:07:38 -0400 Subject: [PATCH 37/44] add Physics info for RRFS configs --- doc/UsersGuide/source/Configurations.rst | 131 ++++++++++++++++------- 1 file changed, 94 insertions(+), 37 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index dee65ae4ac..afe45ecc5d 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -290,13 +290,12 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality .. _rrfs-rts: .. list-table:: *RRFS regression test descriptions* - :widths: 10 10 10 10 10 10 10 10 10 + :widths: 50 10 50 10 10 10 10 10 :header-rows: 1 * - Test |nbsp| Name |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| - Description - - Physics Suite (see namelist options `here `__) - - DT_ATMOS + - Physics |nbsp| Parameters |nbsp| (see |nbsp| namelist |nbsp| options |nbsp| `here `__ for variable definitions) - Start Date - Forecast Length (hours) - Output Grid @@ -304,105 +303,160 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes * - `rrfs_v1beta `__ / `rrfs_v1beta_debug `__ - Compare RRFS_v1beta / rrfs_v1beta_debug results with previous trunk version - - FV3_RRFS_v1beta; IMP_PHYSICS=8 - - 300 + - FV3_RRFS_v1beta + IMP_PHYSICS=8 + DT_ATMOS=300 + **Set to FALSE:** DO_SAT_ADJ, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG + **Set to TRUE:** LRADAR, LTAEROSOL, DO_MYNNEDMF, DO_MYNNSFCLAY + **Set to value:** IAER=5111; DNATS=0; IALB=2; IEMS=2; IMFSHALCNV=-1; IMFDEEPCNV=-1; LSM=2; LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - gaussian_grid - - INPUT_NML=rap.nml.IN | FIELD_TABLE=field_table_thompson_aero_tke | DIAG_TABLE=diag_table_rap_noah + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure.IN + FV3_RUN=control_run.IN + INPUT_NML=rap.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke + DIAG_TABLE=diag_table_rap_noah - Notes: DO_SAT_ADJ=.false. ; LRADAR=.true. ; LTAEROSOL=.true. ; IALB=2; IEMS=2; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 * - `rrfs_v1nssl `__ - Compare RRFS_v1nssl results with previous trunk version - - FV3_RRFS_v1nssl; IMP_PHYSICS=17 - - 300 + - FV3_RRFS_v1nssl; IMP_PHYSICS=17; DT_ATMOS=300 - 2021-03-22 06:00:00 - 24 - gaussian_grid - - INPUT_NML=rap.nml.IN | FIELD_TABLE=field_table_nssl_tke | DIAG_TABLE=diag_table_rap_noah; NSSL_CCN_ON=.true. - - Notes: NSSL_HAIL_ON=.true. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure.IN + FV3_RUN=control_run.IN + INPUT_NML=rap.nml.IN + FIELD_TABLE=field_table_nssl_tke + DIAG_TABLE=diag_table_rap_noah + - Notes: NSSL_CCN_ON=.true. ; NSSL_HAIL_ON=.true. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 * - `rrfs_v1nssl_nohailnoccn `__ - Compare RRFS_v1nssl_nohailnoccn results with previous trunk version - - FV3_RRFS_v1nssl; IMP_PHYSICS=17 - - 300 + - FV3_RRFS_v1nssl; IMP_PHYSICS=17; DT_ATMOS=300 - 2021-03-22 06:00:00 - 24 - gaussian_grid - - FV3_RUN=control_run.IN | INPUT_NML=rap.nml.IN | FIELD_TABLE=field_table_nssl_nohailnoccn_tke | DIAG_TABLE=diag_table_rap_noah + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure.IN + FV3_RUN=control_run.IN + INPUT_NML=rap.nml.IN + FIELD_TABLE=field_table_nssl_nohailnoccn_tke + DIAG_TABLE=diag_table_rap_noah - Notes: DNATS=0 ; NWAT=6 ; NSSL_CCN_ON=.false. ; NSSL_HAIL_ON=.false. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 * - `rrfs_conus13km_hrrr_warm `__ - HRRR physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal - - FV3_RUN=rrfs_warm_run.IN | INPUT_NML=rrfs_conus13km_hrrr.nml.IN | FIELD_TABLE=field_table_thompson_aero_tke | DIAG_TABLE=diag_table_hrrr | MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke + DIAG_TABLE=diag_table_hrrr - Notes: LKM=1; IOPT_LAKE=2; SFCLAY_COMPUTE_FLUX=.true.; IALB=2; ICLIQ_SW=2; IEMS=2; IOVR=3; KICE=9; LSM=3; LSOIL_LSM=9; DO_MYNNSFCLAY=.true.; DO_MYNNEDMF=.true.; DO_MYJPBL=.true; HYBEDMF=.false.; SHAL_CNV=.false.; DO_SAT_ADJ=.false.; DO_DEEP=.false. ; MAKE_NH=.false.; NA_INIT=0; DNATS=0; EXTERNAL_IC=.false.; NGGPS_IC=.false.; MOUNTAIN=.true.; WARM_START=.true.; READ_INCREMENT=.false.; RES_LATLON_DYNAMICS="'fv3_increment.nc'"; FHZERO=1.0; LDIAG3D=.false.; QDIAG3D=.false.; FHCYC=0.0; IAER=1011; LHEATSTRG=.false.; RANDOM_CLDS=.false.; CNVCLD=.false.; IMFSHALCNV=-1; IMFDEEPCNV=-1; CDMBWD='3.5,1.0'; DO_SPPT=.false.; DO_SHUM=.false.; DO_SKEB=.false.; LNDP_TYPE=0; N_VAR_LNDP=0; GWD_OPT=3; DO_UGWP_V0=.false.; DO_UGWP_V0_OROG_ONLY=.false.; DO_GSL_DRAG_LS_BL=.true.; DO_GSL_DRAG_SS=.true.; DO_GSL_DRAG_TOFD=.true.; DO_UGWP_V1=.false.; DO_UGWP_V1_OROG_ONLY=.false.; FRAC_ICE=.true. * - `rrfs_conus13km_hrrr_warm_debug `__ - HRRR physics on 13km domain, debug run - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 1 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke + DIAG_TABLE=diag_table_hrrr - Notes: * - `rrfs_conus13km_hrrr_warm_restart_mismatch `__ - HRRR physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke + DIAG_TABLE=diag_table_hrrr - Notes: * - `rrfs_smoke_conus13km_hrrr_warm `__ - HRRR smoke physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke_smoke + DIAG_TABLE=diag_table_hrrr + DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - Notes: * - `rrfs_smoke_conus13km_hrrr_warm_2threads `__ - HRRR smoke physics on 13km domain, different threads - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke_smoke + DIAG_TABLE=diag_table_hrrr + DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - Notes: * - `rrfs_smoke_conus13km_hrrr_warm_debug `__ - HRRR smoke physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 1 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke_smoke + DIAG_TABLE=diag_table_hrrr + DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - Notes: * - `rrfs_smoke_conus13km_hrrr_warm_debug_2threads `__ - HRRR smoke physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 1 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke_smoke + DIAG_TABLE=diag_table_hrrr + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - Notes: * - `rrfs_smoke_conus13km_radar_tten_warm `__ - HRRR smoke physics on 13km domain with radar-derived temperature tendencies - - FV3_HRRR; IMP_PHYSICS=8 - - 120 + - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal - - + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN + FV3_RUN=rrfs_warm_run.IN + INPUT_NML=rrfs_conus13km_hrrr.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke + DIAG_TABLE=diag_table_hrrr - Notes: .. COMMENT: What are PEs??? And check rrfs_conus13km_hrrr_warm_restart_mismatch description. It's the same as the rrfs_conus13km_hrrr_warm description +.. COMMENT: What is DNATS? Remove from Physics??? **Sample** ``CMAKE_FLAGS`` **Setting** @@ -534,6 +588,9 @@ or in the `UFS WM RT Data Bucket Date: Mon, 26 Jun 2023 13:39:31 -0400 Subject: [PATCH 38/44] update CCPP info & notes --- doc/UsersGuide/source/Configurations.rst | 37 +++++++++++++++++------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index afe45ecc5d..153474ecb8 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -303,11 +303,16 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes * - `rrfs_v1beta `__ / `rrfs_v1beta_debug `__ - Compare RRFS_v1beta / rrfs_v1beta_debug results with previous trunk version - - FV3_RRFS_v1beta - IMP_PHYSICS=8 - DT_ATMOS=300 + - **Suite:** CCPP_SUITE=FV3_RRFS_v1beta + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=300 + **Set to FALSE:** DO_SAT_ADJ, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG + **Set to TRUE:** LRADAR, LTAEROSOL, DO_MYNNEDMF, DO_MYNNSFCLAY + **Set to value:** IAER=5111; DNATS=0; IALB=2; IEMS=2; IMFSHALCNV=-1; IMFDEEPCNV=-1; LSM=2; LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 @@ -318,10 +323,14 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_rap_noah - - Notes: DO_SAT_ADJ=.false. ; LRADAR=.true. ; LTAEROSOL=.true. ; IALB=2; IEMS=2; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + - Notes: * - `rrfs_v1nssl `__ - Compare RRFS_v1nssl results with previous trunk version - - FV3_RRFS_v1nssl; IMP_PHYSICS=17; DT_ATMOS=300 + - **Suite:** CCPP_SUITE=FV3_RRFS_v1nssl + + **Microphysics:** IMP_PHYSICS=17 + + **Time Step:** DT_ATMOS=300 - 2021-03-22 06:00:00 - 24 - gaussian_grid @@ -331,10 +340,14 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_nssl_tke DIAG_TABLE=diag_table_rap_noah - - Notes: NSSL_CCN_ON=.true. ; NSSL_HAIL_ON=.true. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + - Notes: * - `rrfs_v1nssl_nohailnoccn `__ - Compare RRFS_v1nssl_nohailnoccn results with previous trunk version - - FV3_RRFS_v1nssl; IMP_PHYSICS=17; DT_ATMOS=300 + - **Suite:** CCPP_SUITE=FV3_RRFS_v1nssl + + **Microphysics:** IMP_PHYSICS=17 + + **Time Step:** DT_ATMOS=300 - 2021-03-22 06:00:00 - 24 - gaussian_grid @@ -344,10 +357,14 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_nssl_nohailnoccn_tke DIAG_TABLE=diag_table_rap_noah - - Notes: DNATS=0 ; NWAT=6 ; NSSL_CCN_ON=.false. ; NSSL_HAIL_ON=.false. ; NSSL_INVERTCCN=.true. ; DO_SAT_ADJ=.false. ; LTAEROSOL=.false. ; IALB=2 ; IEMS=2 ; HYBEDMF=.false. ; DO_MYNNEDMF=.true. ; DO_MYNNSFCLAY=.true. ; DO_DEEP=.false. ; SHAL_CNV=.false. ; IMFSHALCNV=-1 ; IMFDEEPCNV=-1 ; LHEATSTRG=.false. ; LSM=2 ; LSOIL_LSM=4 + - Notes: * - `rrfs_conus13km_hrrr_warm `__ - HRRR physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -357,7 +374,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - Notes: LKM=1; IOPT_LAKE=2; SFCLAY_COMPUTE_FLUX=.true.; IALB=2; ICLIQ_SW=2; IEMS=2; IOVR=3; KICE=9; LSM=3; LSOIL_LSM=9; DO_MYNNSFCLAY=.true.; DO_MYNNEDMF=.true.; DO_MYJPBL=.true; HYBEDMF=.false.; SHAL_CNV=.false.; DO_SAT_ADJ=.false.; DO_DEEP=.false. ; MAKE_NH=.false.; NA_INIT=0; DNATS=0; EXTERNAL_IC=.false.; NGGPS_IC=.false.; MOUNTAIN=.true.; WARM_START=.true.; READ_INCREMENT=.false.; RES_LATLON_DYNAMICS="'fv3_increment.nc'"; FHZERO=1.0; LDIAG3D=.false.; QDIAG3D=.false.; FHCYC=0.0; IAER=1011; LHEATSTRG=.false.; RANDOM_CLDS=.false.; CNVCLD=.false.; IMFSHALCNV=-1; IMFDEEPCNV=-1; CDMBWD='3.5,1.0'; DO_SPPT=.false.; DO_SHUM=.false.; DO_SKEB=.false.; LNDP_TYPE=0; N_VAR_LNDP=0; GWD_OPT=3; DO_UGWP_V0=.false.; DO_UGWP_V0_OROG_ONLY=.false.; DO_GSL_DRAG_LS_BL=.true.; DO_GSL_DRAG_SS=.true.; DO_GSL_DRAG_TOFD=.true.; DO_UGWP_V1=.false.; DO_UGWP_V1_OROG_ONLY=.false.; FRAC_ICE=.true. + - Notes: * - `rrfs_conus13km_hrrr_warm_debug `__ - HRRR physics on 13km domain, debug run - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 From 897149f51afc8f6536b5e88bb695cc30f43d4616 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Mon, 26 Jun 2023 17:43:00 -0400 Subject: [PATCH 39/44] update NSSL physics desc --- doc/UsersGuide/source/Configurations.rst | 53 +++++++++++++++++------- 1 file changed, 38 insertions(+), 15 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 153474ecb8..82b0cf835b 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -377,7 +377,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_conus13km_hrrr_warm_debug `__ - HRRR physics on 13km domain, debug run - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -390,7 +394,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_conus13km_hrrr_warm_restart_mismatch `__ - HRRR physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -403,7 +411,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_smoke_conus13km_hrrr_warm `__ - HRRR smoke physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -417,7 +429,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_smoke_conus13km_hrrr_warm_2threads `__ - HRRR smoke physics on 13km domain, different threads - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -431,7 +447,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_smoke_conus13km_hrrr_warm_debug `__ - HRRR smoke physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -445,7 +465,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_smoke_conus13km_hrrr_warm_debug_2threads `__ - HRRR smoke physics on 13km domain, control run - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -460,7 +484,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: * - `rrfs_smoke_conus13km_radar_tten_warm `__ - HRRR smoke physics on 13km domain with radar-derived temperature tendencies - - FV3_HRRR; IMP_PHYSICS=8; DT_ATMOS=120 + - **Suite:** CCPP_SUITE=FV3_HRRR + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=120 - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -479,14 +507,12 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_RAP,FV3_RAP_sfcdiff,FV3_HRRR,FV3_HRRR_flake,FV3_RRFS_v1beta,FV3_RRFS_v1nssl -D32BIT=ON" + export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_RAP,FV3_HRRR,FV3_RRFS_v1beta,FV3_RRFS_v1nssl -D32BIT=ON" .. COMMENT: Edit this section! **Supported Physics Suites** -.. COMMENT: Edit this section! - .. list-table:: *Physics suites used in the RRFS configurations above* :widths: 10 50 :header-rows: 1 @@ -495,16 +521,13 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Description * - FV3_RAP - The FV3_RAP physics suite is described in the :term:`CCPP` documentation `here `__. - * - FV3_RAP_sfcdiff - - The FV3_RAP_sfcdiff physics suite is described in the CCPP documentation `here <>`__. * - FV3_HRRR - The FV3_HRRR physics suite is described in the CCPP documentation `here `__. - * - FV3_HRRR_flake - - The FV3_HRRR_flake physics suite is described in the CCPP documentation `here <>`__. * - FV3_RRFS_v1beta - The FV3_RRFS_v1beta physics suite is described in the CCPP documentation `here `__. * - FV3_RRFS_v1nssl - - The FV3_RRFS_v1nssl physics suite is described in the CCPP documentation `here <>`__. + - The FV3_RRFS_v1nssl physics suite is similar to the *FV3_RRFS_v1beta* suite; the only difference is that it uses the NSSL 2-moment microphysics scheme instead of the Thompson microphysics scheme. + **Additional Information** From 70aeb0b277e5e7ca7f99d06ec660c1fc43b86101 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Thu, 29 Jun 2023 19:29:12 -0400 Subject: [PATCH 40/44] more physics updates --- doc/UsersGuide/source/Configurations.rst | 122 ++++++++++++++++++----- 1 file changed, 99 insertions(+), 23 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 82b0cf835b..a6cd403a5e 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -1,6 +1,9 @@ .. |nbsp| unicode:: 0xA0 :trim: +.. role:: raw-html(raw) + :format: html + .. _Configurations: ************************* @@ -307,16 +310,17 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=300 + **Time Step:** DT_ATMOS=300 :raw-html:`

` + + **Set to FALSE:** DO_SAT_ADJ, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG :raw-html:`

` + + **Set to TRUE:** LRADAR, LTAEROSOL, DO_MYNNEDMF, DO_MYNNSFCLAY :raw-html:`

` - **Set to FALSE:** DO_SAT_ADJ, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG - - **Set to TRUE:** LRADAR, LTAEROSOL, DO_MYNNEDMF, DO_MYNNSFCLAY - **Set to value:** IAER=5111; DNATS=0; IALB=2; IEMS=2; IMFSHALCNV=-1; IMFDEEPCNV=-1; LSM=2; LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - - gaussian_grid + - gaussian_grid :raw-html:`

` + **Grid Parameters:** - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN FV3_RUN=control_run.IN @@ -330,10 +334,17 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=17 - **Time Step:** DT_ATMOS=300 + **Time Step:** DT_ATMOS=300 :raw-html:`
` + + **Set to FALSE:** DO_SAT_ADJ, LTAEROSOL, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG :raw-html:`

` + + **Set to TRUE:** NSSL_CCN_ON, NSSL_HAIL_ON, NSSL_INVERTCCN, DO_MYNNEDMF, DO_MYNNSFCLAY :raw-html:`

` + + **Set to value:** NPZ=127, NPZP=128, IAER=5111, CS=17, DNATS=0, NWAT=7, IALB=2, IEMS=2, IMFSHALCNV=-1, IMFDEEPCNV=-1, LSM=2, LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - - gaussian_grid + - gaussian_grid :raw-html:`

` + **Grid Parameters:** - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN FV3_RUN=control_run.IN @@ -347,10 +358,17 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=17 - **Time Step:** DT_ATMOS=300 + **Time Step:** DT_ATMOS=300 :raw-html:`

` + + **Set to FALSE:** NSSL_CCN_ON, NSSL_HAIL_ON, DO_SAT_ADJ, LTAEROSOL, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG :raw-html:`

` + + **Set to TRUE:** NSSL_INVERTCCN, DO_MYNNEDMF, DO_MYNNSFCLAY :raw-html:`

` + + **Set to value:** NPZ=127, NPZP=128, IAER=5111, DNATS=0, NWAT=6, IALB=2, IEMS=2, IMFSHALCNV=-1, IMFDEEPCNV=-1, LSM=2, LSOIL_LSM=4 :raw-html:`

` - 2021-03-22 06:00:00 - 24 - - gaussian_grid + - gaussian_grid :raw-html:`

` + **Grid Parameters:** - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN FV3_RUN=control_run.IN @@ -364,10 +382,19 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + + **Set to value:** DECFL=8, LKM=1, IOPT_LAKE=2, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NA_INIT=0, DNATS=0, NPZP=66, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', RES_LATLON_DYNAMICS="'fv3_increment.nc'", LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 :raw-html:`

` + + .. COMMENT: Check whether all params are for physics... vs grid or something else. INPES/JNPES? - 2021-05-12 16:00:00 - 2 - - lambert_conformal + - lambert_conformal :raw-html:`

` + **Grid Parameters:** - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -381,10 +408,18 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + + **Set to value:** RESTART_INTERVAL=1, DECFL=8, LKM=1, IOPT_LAKE=2, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + - 2021-05-12 16:00:00 - 1 - - lambert_conformal + - lambert_conformal :raw-html:`

` + **Grid Parameters:** - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -398,10 +433,17 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + + **Set to TRUE:** RRFS_RESTART=YES, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + + **Set to value:** FHROT=1, RESTART_FILE_PREFIX=$( printf %04d%02d%02d.%02d0000 $SYEAR $SMONTH $SDAY $(( SHOUR+FHROT )) ), DECFL=8, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, FHZERO=1.0, FHCYC=0.0, IAER=5111, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal + - lambert_conformal :raw-html:`

` + **Grid Parameters:** - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -415,10 +457,18 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + + **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IOPT_LAKE=2, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + - 2021-05-12 16:00:00 - 2 - - lambert_conformal + - lambert_conformal :raw-html:`

` + **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -433,10 +483,17 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + + **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal + - lambert_conformal :raw-html:`

` + **Grid Parameters:** INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66, RES_LATLON_DYNAMICS="'fv3_increment.nc'" - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -451,7 +508,13 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** + + **Set to TRUE:** + + **Set to value:** - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -469,7 +532,13 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** + + **Set to TRUE:** + + **Set to value:** - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -488,7 +557,13 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 + **Time Step:** DT_ATMOS=120 :raw-html:`

` + + **Set to FALSE:** + + **Set to TRUE:** + + **Set to value:** - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -502,6 +577,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality .. COMMENT: What are PEs??? And check rrfs_conus13km_hrrr_warm_restart_mismatch description. It's the same as the rrfs_conus13km_hrrr_warm description .. COMMENT: What is DNATS? Remove from Physics??? + - DNATS is the number of tracers at the end of the tracer array that are not advected by the dycore **Sample** ``CMAKE_FLAGS`` **Setting** From 6caf4f5c77fda32464b90b07ba9ce1a39af0b5c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Fri, 30 Jun 2023 16:35:45 -0400 Subject: [PATCH 41/44] add remaining phys info --- doc/UsersGuide/source/Configurations.rst | 25 ++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index a6cd403a5e..b8e7d6afef 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -510,14 +510,16 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 :raw-html:`

` - **Set to FALSE:** + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` - **Set to TRUE:** + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` - **Set to value:** + **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + - 2021-05-12 16:00:00 - 1 - lambert_conformal + **Grid Parameters**: INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -534,14 +536,15 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 :raw-html:`

` - **Set to FALSE:** + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` - **Set to TRUE:** + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` - **Set to value:** + **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - lambert_conformal + **Grid Parameters**: INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -559,14 +562,16 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 :raw-html:`

` - **Set to FALSE:** + **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` - **Set to TRUE:** + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` - **Set to value:** + **Set to value:** FH_DFI_RADAR='0.0, 0.25, 0.50, 0.75, 1.0', RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + - 2021-05-12 16:00:00 - 2 - lambert_conformal + **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -576,7 +581,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Notes: .. COMMENT: What are PEs??? And check rrfs_conus13km_hrrr_warm_restart_mismatch description. It's the same as the rrfs_conus13km_hrrr_warm description -.. COMMENT: What is DNATS? Remove from Physics??? +.. COMMENT: What is DNATS? - DNATS is the number of tracers at the end of the tracer array that are not advected by the dycore **Sample** ``CMAKE_FLAGS`` **Setting** From 41e6f7d239102ae64f943e4624ba568d4e06a895 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Mon, 3 Jul 2023 17:46:52 -0400 Subject: [PATCH 42/44] 1st draft of RRFS docs --- doc/UsersGuide/source/Configurations.rst | 183 +++++++++++------------ 1 file changed, 85 insertions(+), 98 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index b8e7d6afef..67284fb3b9 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -284,39 +284,49 @@ Rapid Refresh Forecast System (RRFS) The RRFS configurations use an :term:`ATM`-only configuration on a high-resolution regional grid with data assimilation capabilities. -These tests use default values set in the ``export_fv3`` function of ``default_vars.sh``. +These tests use the default values set in the ``export_fv3`` function of ``default_vars.sh`` unless other values are explicitly set. Current RRFS regression tests cover a wide variety of functionality and involve several -physics tests. :numref:`Table %s ` contains RTs for RRFS functionality. +physics tests. :numref:`Table %s ` contains RTs for RRFS functionality. + +.. attention:: + + Certain physics-related settings are common to all of the supported RRFS configurations. These values are set in each test's configuration file because they differ from the ``default_vars.sh`` values: + * **Set to FALSE:** DO_SAT_ADJ, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG + * **Set to TRUE:** DO_MYNNEDMF, DO_MYNNSFCLAY + * **Set to VALUE:** DNATS=0, IALB=2, IEMS=2, IMFSHALCNV=-1, IMFDEEPCNV=-1 + + The "Detailed Physics Parameters" column in :numref:`Table %s ` details physics settings that differ from both the ``default_vars.sh`` values and these RRFS-specific defaults. + .. _rrfs-rts: .. list-table:: *RRFS regression test descriptions* - :widths: 50 10 50 10 10 10 10 10 + :widths: 50 10 30 30 10 10 10 10 10 :header-rows: 1 * - Test |nbsp| Name |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| - Description - - Physics |nbsp| Parameters |nbsp| (see |nbsp| namelist |nbsp| options |nbsp| `here `__ for variable definitions) - - Start Date - - Forecast Length (hours) + - General Physics Parameters + - Detailed |nbsp| Physics |nbsp| Parameters |nbsp| (see |nbsp| namelist |nbsp| options |nbsp| `here `__ |nbsp| for variable definitions) + - Start |nbsp| Date |nbsp| |nbsp| |nbsp| |nbsp| + - Fcst Length (hours) - Output Grid - Configuration Files - - Notes + - Restart * - `rrfs_v1beta `__ / `rrfs_v1beta_debug `__ - Compare RRFS_v1beta / rrfs_v1beta_debug results with previous trunk version - **Suite:** CCPP_SUITE=FV3_RRFS_v1beta **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=300 :raw-html:`

` - - **Set to FALSE:** DO_SAT_ADJ, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG :raw-html:`

` + **Time Step:** DT_ATMOS=300 + - **Set to FALSE:** Default RRFS values only :raw-html:`

` - **Set to TRUE:** LRADAR, LTAEROSOL, DO_MYNNEDMF, DO_MYNNSFCLAY :raw-html:`

` + **Set to TRUE:** LRADAR, LTAEROSOL :raw-html:`

` - **Set to value:** IAER=5111; DNATS=0; IALB=2; IEMS=2; IMFSHALCNV=-1; IMFDEEPCNV=-1; LSM=2; LSOIL_LSM=4 + **Set to VALUE:** IAER=5111, LSM=2, LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - gaussian_grid :raw-html:`

` @@ -327,144 +337,134 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_rap_noah - - Notes: + - * - `rrfs_v1nssl `__ - Compare RRFS_v1nssl results with previous trunk version - **Suite:** CCPP_SUITE=FV3_RRFS_v1nssl **Microphysics:** IMP_PHYSICS=17 - **Time Step:** DT_ATMOS=300 :raw-html:`
` + **Time Step:** DT_ATMOS=300 + - **Set to FALSE:** LTAEROSOL :raw-html:`

` - **Set to FALSE:** DO_SAT_ADJ, LTAEROSOL, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG :raw-html:`

` + **Set to TRUE:** NSSL_CCN_ON, NSSL_HAIL_ON, NSSL_INVERTCCN :raw-html:`

` - **Set to TRUE:** NSSL_CCN_ON, NSSL_HAIL_ON, NSSL_INVERTCCN, DO_MYNNEDMF, DO_MYNNSFCLAY :raw-html:`

` - - **Set to value:** NPZ=127, NPZP=128, IAER=5111, CS=17, DNATS=0, NWAT=7, IALB=2, IEMS=2, IMFSHALCNV=-1, IMFDEEPCNV=-1, LSM=2, LSOIL_LSM=4 + **Set to VALUE:** IAER=5111, CS=17, NWAT=7, LSM=2, LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - gaussian_grid :raw-html:`

` - **Grid Parameters:** + **Grid Parameters:** NPZ=127, NPZP=128 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN FV3_RUN=control_run.IN INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_nssl_tke DIAG_TABLE=diag_table_rap_noah - - Notes: + - * - `rrfs_v1nssl_nohailnoccn `__ - Compare RRFS_v1nssl_nohailnoccn results with previous trunk version - **Suite:** CCPP_SUITE=FV3_RRFS_v1nssl **Microphysics:** IMP_PHYSICS=17 - **Time Step:** DT_ATMOS=300 :raw-html:`

` - - **Set to FALSE:** NSSL_CCN_ON, NSSL_HAIL_ON, DO_SAT_ADJ, LTAEROSOL, HYBEDMF, DO_DEEP, SHAL_CNV, LHEATSTRG :raw-html:`

` + **Time Step:** DT_ATMOS=300 + - **Set to FALSE:** NSSL_CCN_ON, NSSL_HAIL_ON, LTAEROSOL :raw-html:`

` - **Set to TRUE:** NSSL_INVERTCCN, DO_MYNNEDMF, DO_MYNNSFCLAY :raw-html:`

` + **Set to TRUE:** NSSL_INVERTCCN :raw-html:`

` - **Set to value:** NPZ=127, NPZP=128, IAER=5111, DNATS=0, NWAT=6, IALB=2, IEMS=2, IMFSHALCNV=-1, IMFDEEPCNV=-1, LSM=2, LSOIL_LSM=4 :raw-html:`

` + **Set to VALUE:** IAER=5111, NWAT=6, LSM=2, LSOIL_LSM=4 :raw-html:`

` - 2021-03-22 06:00:00 - 24 - gaussian_grid :raw-html:`

` - **Grid Parameters:** + **Grid Parameters:** NPZ=127, NPZP=128 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN FV3_RUN=control_run.IN INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_nssl_nohailnoccn_tke DIAG_TABLE=diag_table_rap_noah - - Notes: + - * - `rrfs_conus13km_hrrr_warm `__ - HRRR physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** DECFL=8, LKM=1, IOPT_LAKE=2, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NA_INIT=0, DNATS=0, NPZP=66, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', RES_LATLON_DYNAMICS="'fv3_increment.nc'", LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 :raw-html:`

` - - .. COMMENT: Check whether all params are for physics... vs grid or something else. INPES/JNPES? + **Set to VALUE:** DECFL=8, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - lambert_conformal :raw-html:`

` - **Grid Parameters:** + **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - Notes: + - READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_conus13km_hrrr_warm_debug `__ - HRRR physics on 13km domain, debug run - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** RESTART_INTERVAL=1, DECFL=8, LKM=1, IOPT_LAKE=2, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - + **Set to VALUE:** DECFL=8, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - lambert_conformal :raw-html:`

` - **Grid Parameters:** + **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - Notes: + - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_conus13km_hrrr_warm_restart_mismatch `__ - HRRR physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_RESTART=YES, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** FHROT=1, RESTART_FILE_PREFIX=$( printf %04d%02d%02d.%02d0000 $SYEAR $SMONTH $SDAY $(( SHOUR+FHROT )) ), DECFL=8, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, FHZERO=1.0, FHCYC=0.0, IAER=5111, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + **Set to VALUE:** DECFL=8, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=5111, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - lambert_conformal :raw-html:`

` - **Grid Parameters:** + **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - Notes: + - RRFS_RESTART=YES, READ_INCREMENT=.false., FHROT=1, RESTART_FILE_PREFIX=$( printf %04d%02d%02d.%02d0000 $SYEAR $SMONTH $SDAY $(( SHOUR+FHROT )) ), RES_LATLON_DYNAMICS="'fv3_increment.nc'", * - `rrfs_smoke_conus13km_hrrr_warm `__ - HRRR smoke physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IOPT_LAKE=2, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - + **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - lambert_conformal :raw-html:`

` @@ -476,24 +476,23 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality FIELD_TABLE=field_table_thompson_aero_tke_smoke DIAG_TABLE=diag_table_hrrr DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - Notes: + - RESTART_INTERVAL=1, READ_INCREMENT=.false. * - `rrfs_smoke_conus13km_hrrr_warm_2threads `__ - HRRR smoke physics on 13km domain, different threads - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL=.true, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - lambert_conformal :raw-html:`

` - **Grid Parameters:** INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66, RES_LATLON_DYNAMICS="'fv3_increment.nc'" + **Grid Parameters:** INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -501,21 +500,19 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality FIELD_TABLE=field_table_thompson_aero_tke_smoke DIAG_TABLE=diag_table_hrrr DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - Notes: + - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_hrrr_warm_debug `__ - HRRR smoke physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - + **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -527,20 +524,19 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality FIELD_TABLE=field_table_thompson_aero_tke_smoke DIAG_TABLE=diag_table_hrrr DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - Notes: + - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_hrrr_warm_debug_2threads `__ - HRRR smoke physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 + **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - lambert_conformal @@ -553,21 +549,19 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality DIAG_TABLE=diag_table_hrrr MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - Notes: + - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_radar_tten_warm `__ - HRRR smoke physics on 13km domain with radar-derived temperature tendencies - **Suite:** CCPP_SUITE=FV3_HRRR **Microphysics:** IMP_PHYSICS=8 - **Time Step:** DT_ATMOS=120 :raw-html:`

` - - **Set to FALSE:** SEDI_SEMI, HYBEDMF, SHAL_CNV, DO_SAT_ADJ, DO_DEEP, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, LHEATSTRG, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_V0, DO_UGWP_V0_OROG_ONLY, DO_UGWP_V1, DO_UGWP_V1_OROG_ONLY :raw-html:`

` + **Time Step:** DT_ATMOS=120 + - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYNNSFCLAY, DO_MYNNEDMF, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_LS_BL, DO_GSL_DRAG_SS, DO_GSL_DRAG_TOFD, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to value:** FH_DFI_RADAR='0.0, 0.25, 0.50, 0.75, 1.0', RESTART_INTERVAL=1, DECFL=8, SEAS_OPT=0, LKM=1, IALB=2, ICLIQ_SW=2, IEMS=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, DNATS=0, RES_LATLON_DYNAMICS="'fv3_increment.nc'", FHZERO=1.0, FHCYC=0.0, IAER=1011, IMFSHALCNV=-1, IMFDEEPCNV=-1, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - + **Set to VALUE:** FH_DFI_RADAR='0.0, 0.25, 0.50, 0.75, 1.0', DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - lambert_conformal @@ -578,7 +572,9 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - Notes: + - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + + .. COMMENT: What are PEs??? And check rrfs_conus13km_hrrr_warm_restart_mismatch description. It's the same as the rrfs_conus13km_hrrr_warm description .. COMMENT: What is DNATS? @@ -590,8 +586,6 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_RAP,FV3_HRRR,FV3_RRFS_v1beta,FV3_RRFS_v1nssl -D32BIT=ON" -.. COMMENT: Edit this section! - **Supported Physics Suites** .. list-table:: *Physics suites used in the RRFS configurations above* @@ -607,21 +601,17 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality * - FV3_RRFS_v1beta - The FV3_RRFS_v1beta physics suite is described in the CCPP documentation `here `__. * - FV3_RRFS_v1nssl - - The FV3_RRFS_v1nssl physics suite is similar to the *FV3_RRFS_v1beta* suite; the only difference is that it uses the NSSL 2-moment microphysics scheme instead of the Thompson microphysics scheme. + - The FV3_RRFS_v1nssl physics suite is similar to the *FV3_RRFS_v1beta* suite; however, it uses the NSSL 2-moment microphysics scheme instead of the Thompson microphysics scheme. **Additional Information** -.. COMMENT: Edit this section! - Input files required for RRFS ATM configurations can be viewed in :numref:`Table %s ` -or in the `UFS WM RT Data Bucket `__. +or in the `UFS WM RT Data Bucket `__. Users who wish to run additional (unsupported) cases may also find useful data `here `__. -.. COMMENT: Edit this section before adding! +Information on ``nems.configure`` files is available in :numref:`Section %s `. The supported RRFS WM RTs use the same ``nems.configure`` file that ATM-only tests do (``nems.configure.atm.IN``). This file can be viewed in the ``ufs-weather-model/tests/parm`` directory `here `__. - Information on ``nems.configure`` files is available in :numref:`Section %s `, - and a sample RRFS ``nems.configure`` file (``nems.configure.atm.IN``) is available - `here `__. +Additionally, users can find examples of various RRFS configuration files in ``ufs-weather-model/tests/parm`` `here `__. These files include ``model_configure_*``, ``*_run.IN`` (input run), ``*.nml.IN`` (input namelist), ``field_table_*``, and ``diag_table_*`` files. .. _rrfs-files: @@ -709,9 +699,6 @@ or in the `UFS WM RT Data Bucket Date: Mon, 3 Jul 2023 19:34:47 -0400 Subject: [PATCH 43/44] minor updates, esp data table --- doc/UsersGuide/source/Configurations.rst | 131 ++++++++++++----------- 1 file changed, 70 insertions(+), 61 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 67284fb3b9..f4f1ecb5da 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -303,7 +303,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality .. _rrfs-rts: .. list-table:: *RRFS regression test descriptions* - :widths: 50 10 30 30 10 10 10 10 10 + :widths: 50 10 30 50 10 10 10 10 10 :header-rows: 1 * - Test |nbsp| Name |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| @@ -314,30 +314,49 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality - Fcst Length (hours) - Output Grid - Configuration Files - - Restart - * - `rrfs_v1beta `__ / `rrfs_v1beta_debug `__ - - Compare RRFS_v1beta / rrfs_v1beta_debug results with previous trunk version + - Other + * - `rrfs_v1beta `__ + - Compare RRFS_v1beta results with previous trunk version - **Suite:** CCPP_SUITE=FV3_RRFS_v1beta **Microphysics:** IMP_PHYSICS=8 **Time Step:** DT_ATMOS=300 - **Set to FALSE:** Default RRFS values only :raw-html:`

` - **Set to TRUE:** LRADAR, LTAEROSOL :raw-html:`

` - - **Set to VALUE:** IAER=5111, LSM=2, LSOIL_LSM=4 + **Set to VALUE:** NSTF_NAME='2,0,0,0,0', IAER=5111, LSM=2, LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - - gaussian_grid :raw-html:`

` - **Grid Parameters:** + - OUTPUT_GRID=gaussian_grid :raw-html:`

` + **Grid Parameters:** NPZ=127, NPZP=128 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN FV3_RUN=control_run.IN INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_rap_noah - - + - RESTART_INTERVAL="6 -1", OUTPUT_FH='0 09 12' + * - `rrfs_v1beta_debug `__ + - Compare rrfs_v1beta_debug results with previous trunk version + - **Suite:** CCPP_SUITE=FV3_RRFS_v1beta + + **Microphysics:** IMP_PHYSICS=8 + + **Time Step:** DT_ATMOS=300 + - **Set to FALSE:** Default RRFS values only :raw-html:`

` + **Set to TRUE:** LRADAR, LTAEROSOL :raw-html:`

` + **Set to VALUE:** NSTF_NAME='2,0,0,0,0', IAER=5111, LSM=2, LSOIL_LSM=4 + - 2021-03-22 06:00:00 + - 1 + - OUTPUT_GRID=gaussian_grid :raw-html:`

` + **Grid Parameters:** NPZ=127, NPZP=128 + - NEMS_CONFIGURE=nems.configure.atm.IN + MODEL_CONFIGURE=model_configure.IN + FV3_RUN=control_run.IN + INPUT_NML=rap.nml.IN + FIELD_TABLE=field_table_thompson_aero_tke + DIAG_TABLE=diag_table_rap_noah + - OUTPUT_FH="0 1" * - `rrfs_v1nssl `__ - Compare RRFS_v1nssl results with previous trunk version - **Suite:** CCPP_SUITE=FV3_RRFS_v1nssl @@ -346,13 +365,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=300 - **Set to FALSE:** LTAEROSOL :raw-html:`

` - **Set to TRUE:** NSSL_CCN_ON, NSSL_HAIL_ON, NSSL_INVERTCCN :raw-html:`

` - - **Set to VALUE:** IAER=5111, CS=17, NWAT=7, LSM=2, LSOIL_LSM=4 + **Set to VALUE:** NSTF_NAME='2,0,0,0,0', IAER=5111, CS=17, NWAT=7, LSM=2, LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - - gaussian_grid :raw-html:`

` + - OUTPUT_GRID=gaussian_grid :raw-html:`

` **Grid Parameters:** NPZ=127, NPZP=128 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN @@ -360,7 +377,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_nssl_tke DIAG_TABLE=diag_table_rap_noah - - + - RESTART_INTERVAL="6 -1", OUTPUT_FH='0 09 12' * - `rrfs_v1nssl_nohailnoccn `__ - Compare RRFS_v1nssl_nohailnoccn results with previous trunk version - **Suite:** CCPP_SUITE=FV3_RRFS_v1nssl @@ -369,13 +386,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=300 - **Set to FALSE:** NSSL_CCN_ON, NSSL_HAIL_ON, LTAEROSOL :raw-html:`

` - **Set to TRUE:** NSSL_INVERTCCN :raw-html:`

` - - **Set to VALUE:** IAER=5111, NWAT=6, LSM=2, LSOIL_LSM=4 :raw-html:`

` + **Set to VALUE:** NSTF_NAME='2,0,0,0,0', IAER=5111, NWAT=6, LSM=2, LSOIL_LSM=4 - 2021-03-22 06:00:00 - 24 - - gaussian_grid :raw-html:`

` + - OUTPUT_GRID=gaussian_grid :raw-html:`

` **Grid Parameters:** NPZ=127, NPZP=128 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure.IN @@ -383,7 +398,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rap.nml.IN FIELD_TABLE=field_table_nssl_nohailnoccn_tke DIAG_TABLE=diag_table_rap_noah - - + - RESTART_INTERVAL="6 -1", OUTPUT_FH='0 09 12' * - `rrfs_conus13km_hrrr_warm `__ - HRRR physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR @@ -398,7 +413,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Set to VALUE:** DECFL=8, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal :raw-html:`

` + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -415,13 +430,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** DECFL=8, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - - lambert_conformal :raw-html:`

` + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -438,13 +451,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** DECFL=8, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=5111, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal :raw-html:`

` + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -461,13 +472,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal :raw-html:`

` + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -485,13 +494,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal :raw-html:`

` + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters:** INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -509,13 +516,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - - lambert_conformal + - OUTPUT_GRID=lambert_conformal **Grid Parameters**: INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -533,13 +538,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - - lambert_conformal + - OUTPUT_GRID=lambert_conformal **Grid Parameters**: INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -558,13 +561,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` - **Set to VALUE:** FH_DFI_RADAR='0.0, 0.25, 0.50, 0.75, 1.0', DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - lambert_conformal + - OUTPUT_GRID=lambert_conformal **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -574,12 +575,6 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality DIAG_TABLE=diag_table_hrrr - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" - - -.. COMMENT: What are PEs??? And check rrfs_conus13km_hrrr_warm_restart_mismatch description. It's the same as the rrfs_conus13km_hrrr_warm description -.. COMMENT: What is DNATS? - - DNATS is the number of tracers at the end of the tracer array that are not advected by the dycore - **Sample** ``CMAKE_FLAGS`` **Setting** .. code-block:: console @@ -616,7 +611,7 @@ Additionally, users can find examples of various RRFS configuration files in ``u .. _rrfs-files: .. list-table:: Files Required for RRFS RTs - :widths: 50 10 10 10 10 100 + :widths: 50 10 10 10 10 110 :header-rows: 1 * - Tests @@ -624,7 +619,7 @@ Additionally, users can find examples of various RRFS configuration files in ``u - atmf*.nc - GFSFLX.GrbF* - GFSPRS.GrbF* - - Other |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| + - Other |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| |nbsp| * - rrfs_v1beta - sfcf000.nc sfcf009.nc @@ -638,19 +633,19 @@ Additionally, users can find examples of various RRFS configuration files in ``u - GFSPRS.GrbF00 GFSPRS.GrbF09 GFSPRS.GrbF12 - - coupler.research + - 20210323.060000.coupler.research - fv_core.res.nc + 20210323.060000.fv_core.res.nc - fv_core.res.tile[1-6].nc + 20210323.060000.fv_core.res.tile[1-6].nc - fv_srf_wnd.res.tile[1-6].nc + 20210323.060000.fv_srf_wnd.res.tile[1-6].nc - fv_tracer.res.tile[1-6].nc + 20210323.060000.fv_tracer.res.tile[1-6].nc - phy_data.tile[1-6].nc + 20210323.060000.phy_data.tile[1-6].nc - sfc_data.tile[1-6].nc + 20210323.060000.sfc_data.tile[1-6].nc * - rrfs_v1beta_debug rrfs_conus13km_hrrr_warm_debug rrfs_smoke_conus13km_hrrr_warm_debug @@ -663,6 +658,7 @@ Additionally, users can find examples of various RRFS configuration files in ``u - - * - rrfs_v1nssl + rrfs_v1nssl_nohailnoccn - sfcf000.nc sfcf009.nc @@ -679,17 +675,30 @@ Additionally, users can find examples of various RRFS configuration files in ``u - * - rrfs_conus13km_hrrr_warm rrfs_smoke_conus13km_hrrr_warm - rrfs_smoke_conus13km_hrrr_warm_2threads - rrfs_conus13km_radar_tten_warm - sfcf000.nc sfcf001.nc sfcf002.nc - atmf000.nc atmf001.nc atmf002.nc + - + - + - 20210512.170000.coupler.res + 20210512.170000.fv_core.res.nc + 20210512.170000.fv_core.res.tile1.nc + 20210512.170000.fv_srf_wnd.res.tile1.nc + 20210512.170000.fv_tracer.res.tile1.nc + 20210512.170000.phy_data.nc + 20210512.170000.sfc_data.nc + * - rrfs_smoke_conus13km_hrrr_warm_2threads + rrfs_conus13km_radar_tten_warm + - sfcf000.nc + sfcf001.nc + sfcf002.nc - atmf000.nc - atmf009.nc - atmf012.nc + atmf001.nc + atmf002.nc + - - - * - rrfs_conus13km_hrrr_warm_restart_mismatch From 5dd053082c64864dc5b40e1c3e9e897f10f6e266 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cgspetro-NOAA=E2=80=9D?= Date: Mon, 3 Jul 2023 20:14:29 -0400 Subject: [PATCH 44/44] minor updates --- doc/UsersGuide/source/Configurations.rst | 64 ++++++++++++------------ 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index f4f1ecb5da..ae7772a25b 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -408,7 +408,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 @@ -421,7 +421,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + - RESTART_INTERVAL=1, WARM_START=.true., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_conus13km_hrrr_warm_debug `__ - HRRR physics on 13km domain, debug run - **Suite:** CCPP_SUITE=FV3_HRRR @@ -430,7 +430,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, READ_INCREMENT, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 @@ -442,7 +442,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + - RESTART_INTERVAL=1, WARM_START=.true., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_conus13km_hrrr_warm_restart_mismatch `__ - HRRR physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR @@ -451,7 +451,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=5111, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 @@ -463,7 +463,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - RRFS_RESTART=YES, READ_INCREMENT=.false., FHROT=1, RESTART_FILE_PREFIX=$( printf %04d%02d%02d.%02d0000 $SYEAR $SMONTH $SDAY $(( SHOUR+FHROT )) ), RES_LATLON_DYNAMICS="'fv3_increment.nc'", + - FHROT=1, RESTART_FILE_PREFIX=$( printf %04d%02d%02d.%02d0000 $SYEAR $SMONTH $SDAY $(( SHOUR+FHROT )) ), RRFS_RESTART=YES, WARM_START=.true., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'", * - `rrfs_smoke_conus13km_hrrr_warm `__ - HRRR smoke physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR @@ -472,12 +472,12 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, IOPT_LAKE=2, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - OUTPUT_GRID=lambert_conformal :raw-html:`

` - **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, RES_LATLON_DYNAMICS="'fv3_increment.nc'", NPZP=66, + **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66, - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN FV3_RUN=rrfs_warm_run.IN @@ -485,7 +485,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality FIELD_TABLE=field_table_thompson_aero_tke_smoke DIAG_TABLE=diag_table_hrrr DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - RESTART_INTERVAL=1, READ_INCREMENT=.false. + - RESTART_INTERVAL=1, WARM_START=.true., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_hrrr_warm_2threads `__ - HRRR smoke physics on 13km domain, different threads - **Suite:** CCPP_SUITE=FV3_HRRR @@ -494,7 +494,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 @@ -507,7 +507,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality FIELD_TABLE=field_table_thompson_aero_tke_smoke DIAG_TABLE=diag_table_hrrr DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.true, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_hrrr_warm_debug `__ - HRRR smoke physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR @@ -516,11 +516,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - - OUTPUT_GRID=lambert_conformal + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters**: INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -529,7 +529,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality FIELD_TABLE=field_table_thompson_aero_tke_smoke DIAG_TABLE=diag_table_hrrr DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + - RESTART_INTERVAL=1, WARM_START=.true., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_hrrr_warm_debug_2threads `__ - HRRR smoke physics on 13km domain, control run - **Suite:** CCPP_SUITE=FV3_HRRR @@ -538,11 +538,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 1 - - OUTPUT_GRID=lambert_conformal + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters**: INPES=$INPES_thrd, JNPES=$JNPES_thrd, INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -552,7 +552,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality DIAG_TABLE=diag_table_hrrr MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN DIAG_TABLE_ADDITIONAL=diag_additional_rrfs_smoke - - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.true, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `rrfs_smoke_conus13km_radar_tten_warm `__ - HRRR smoke physics on 13km domain with radar-derived temperature tendencies - **Suite:** CCPP_SUITE=FV3_HRRR @@ -561,11 +561,11 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality **Time Step:** DT_ATMOS=120 - **Set to FALSE:** SEDI_SEMI, MAKE_NH, EXTERNAL_IC, NGGPS_IC, LDIAG3D, QDIAG3D, RANDOM_CLDS, CNVCLD, DO_SPPT, DO_SHUM, DO_SKEB, DO_UGWP_* :raw-html:`

` - **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, WARM_START, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` + **Set to TRUE:** RRFS_SMOKE, SFCLAY_COMPUTE_FLUX, DO_MYJPBL, MOUNTAIN, PRINT_DIFF_PGR, DO_GSL_DRAG_*, FRAC_ICE :raw-html:`

` **Set to VALUE:** FH_DFI_RADAR='0.0, 0.25, 0.50, 0.75, 1.0', DECFL=8, SEAS_OPT=0, LKM=1, ICLIQ_SW=2, IOVR=3, KICE=9, LSM=3, LSOIL_LSM=9, NA_INIT=0, FHZERO=1.0, FHCYC=0.0, IAER=1011, CDMBWD='3.5,1.0', LNDP_TYPE=0, N_VAR_LNDP=0, GWD_OPT=3 - 2021-05-12 16:00:00 - 2 - - OUTPUT_GRID=lambert_conformal + - OUTPUT_GRID=lambert_conformal :raw-html:`

` **Grid Parameters:** INPES=12, JNPES=12, NPX=397, NPY=233, NPZ=65, NPZP=66 - NEMS_CONFIGURE=nems.configure.atm.IN MODEL_CONFIGURE=model_configure_rrfs_conus13km.IN @@ -573,7 +573,7 @@ physics tests. :numref:`Table %s ` contains RTs for RRFS functionality INPUT_NML=rrfs_conus13km_hrrr.nml.IN FIELD_TABLE=field_table_thompson_aero_tke DIAG_TABLE=diag_table_hrrr - - RESTART_INTERVAL=1, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" + - RESTART_INTERVAL=1, WARM_START=.true, READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" **Sample** ``CMAKE_FLAGS`` **Setting** @@ -646,17 +646,6 @@ Additionally, users can find examples of various RRFS configuration files in ``u 20210323.060000.phy_data.tile[1-6].nc 20210323.060000.sfc_data.tile[1-6].nc - * - rrfs_v1beta_debug - rrfs_conus13km_hrrr_warm_debug - rrfs_smoke_conus13km_hrrr_warm_debug - rrfs_smoke_conus13km_hrrr_warm_debug_2threads - - sfcf000.nc - sfcf001.nc - - atmf000.nc - atmf001.nc - - - - - - * - rrfs_v1nssl rrfs_v1nssl_nohailnoccn @@ -691,7 +680,7 @@ Additionally, users can find examples of various RRFS configuration files in ``u 20210512.170000.phy_data.nc 20210512.170000.sfc_data.nc * - rrfs_smoke_conus13km_hrrr_warm_2threads - rrfs_conus13km_radar_tten_warm + rrfs_smoke_conus13km_radar_tten_warm - sfcf000.nc sfcf001.nc sfcf002.nc @@ -701,6 +690,17 @@ Additionally, users can find examples of various RRFS configuration files in ``u - - - + * - rrfs_v1beta_debug + rrfs_conus13km_hrrr_warm_debug + rrfs_smoke_conus13km_hrrr_warm_debug + rrfs_smoke_conus13km_hrrr_warm_debug_2threads + - sfcf000.nc + sfcf001.nc + - atmf000.nc + atmf001.nc + - + - + - * - rrfs_conus13km_hrrr_warm_restart_mismatch - sfcf002.nc - atmf002.nc