diff --git a/.gitmodules b/.gitmodules index a3775fc12d..d7c9399f71 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,7 +1,7 @@ [submodule "FV3"] path = FV3 - url = https://github.com/NOAA-EMC/fv3atm - branch = develop + url = https://github.com/mkavulich/fv3atm + branch = feature/suite_names_update [submodule "WW3"] path = WW3 url = https://github.com/NOAA-EMC/WW3 diff --git a/FV3 b/FV3 index 07c26d1efa..0a061e6c31 160000 --- a/FV3 +++ b/FV3 @@ -1 +1 @@ -Subproject commit 07c26d1efae47445e4c36ff98942494788e7dc49 +Subproject commit 0a061e6c31180325309a290cd91a09bc09503806 diff --git a/README.md b/README.md index cd17b6afc2..501a0c8bb6 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ The top level directory structure groups source code and input files as follow: | ```tests/``` | Regression and unit testing framework scripts. | | ```build.sh``` | Script to build the model executable (also used by `tests/`) | -E.g. use of `build.sh` to build the coupled model with `FV3_GFS_v15p2` as the CCPP suite. +E.g. use of `build.sh` to build the coupled model with `kingfisher` as the CCPP suite. ``` -$> CMAKE_FLAGS="-DAPP=S2S" CCPP_SUITES="FV3_GFS_v15p2" ./build.sh +$> CMAKE_FLAGS="-DAPP=S2S" CCPP_SUITES="kingfisher" ./build.sh ``` The build system is regularly tested with [Tier-1 and Tier-2 platforms]( https://github.com/ufs-community/ufs-weather-model/wiki/Regression-Test-Policy-for-Weather-Model-Platforms-and-Compilers). diff --git a/doc/UsersGuide/source/BuildingAndRunning.rst b/doc/UsersGuide/source/BuildingAndRunning.rst index 02bfb2a846..0fb189bd09 100644 --- a/doc/UsersGuide/source/BuildingAndRunning.rst +++ b/doc/UsersGuide/source/BuildingAndRunning.rst @@ -276,7 +276,7 @@ For the ``ufs-weather-model ATMAERO`` configuration (standalone ATM coupled to : .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATMAERO -DCCPP_SUITES=FV3_GFS_v17_p8" + export CMAKE_FLAGS="-DAPP=ATMAERO -DCCPP_SUITES=bluebird" .. _atmaq: @@ -286,7 +286,7 @@ For the ``ufs-weather-model ATMAQ`` configuration (standalone ATM coupled to :te .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATMAQ -DCCPP_SUITES=FV3_GFS_v15p2" + export CMAKE_FLAGS="-DAPP=ATMAQ -DCCPP_SUITES=kingfisher" .. _atml: @@ -296,7 +296,7 @@ For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :ter .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=FV3_GFS_v17_p8" + export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=bluebird" S2S Configurations ---------------------- diff --git a/doc/UsersGuide/source/Configurations.rst b/doc/UsersGuide/source/Configurations.rst index 69d659ffa5..bd05153680 100644 --- a/doc/UsersGuide/source/Configurations.rst +++ b/doc/UsersGuide/source/Configurations.rst @@ -157,19 +157,19 @@ it will be expanded to cover the full range of ATM-only supported configurations - Forecast Length (hours) * - `control_c48 `__ - Compare global control C48L127 results with previous trunk version - - FV3_GFS_v16 + - raven - 1200 - 2021-03-22 06:00:00 - 24 * - `control_p8 `__ - Compare global control results with previous trunk version - - FV3_GFS_v17_p8 + - bluebird - 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 + - crow - 1800 - 2016-10-03 00:00:00 - 6 @@ -178,7 +178,7 @@ it will be expanded to cover the full range of ATM-only supported configurations .. 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" + export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=raven,bluebird,crow -D32BIT=ON" **Supported Physics Suites** @@ -188,14 +188,14 @@ it will be expanded to cover the full range of ATM-only supported configurations * - 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 + * - "raven" + - The :term:`CCPP` physics suite developed to emulate the physics of GFS version 16; described in the CCPP documentation `here `__. + * - "bluebird" + - The CCPP physics suite for an early experimental prototype of GFS version 17; described in the CCPP documentation `here `__. + * - "crow" + - The CCPP physics suite developed to emulate the physics of GFS version 15, modified with the Thompson Aerosol-Aware Cloud Microphysics Scheme (see `here `__) and - Mynn Surface Layer Module (see `here `__) + MYNN Surface Layer Module (see `here `__) tailored for a limited area model (LAM) 3-km resolution grid. **Additional Information** @@ -229,7 +229,7 @@ These tests use default values set in the ``export_fv3`` function of ``default_v - Other * - `atmwav_control_noaero_p8 `__ - Compare global control results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_GFS_v16" :raw-html:`

` + - **Suite:** CCPP_SUITE="raven" :raw-html:`

` **Microphysics:** IMP_PHYSICS=8 :raw-html:`

` @@ -262,7 +262,7 @@ These tests use default values set in the ``export_fv3`` function of ``default_v 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: General Physics Parameters: - * **Suite:** CCPP_SUITE= `FV3_GFS_v17_p8 `__ + * **Suite:** CCPP_SUITE= `bluebird `__ * **Microphysics:** IMP_PHYSICS=8 * **Time Step:** DT_ATMOS=720 @@ -365,7 +365,7 @@ These tests use default values set in the ``export_fv3`` function of ``default_v - Forecast Length (hours) * - control_p8_atmlnd_sbs - Compare global control results with previous trunk version - - FV3_GFS_v17_p8 + - "bluebird" - 720 - 2021-03-22 06:00:00 - 24 @@ -374,7 +374,7 @@ These tests use default values set in the ``export_fv3`` function of ``default_v .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=FV3_GFS_v17_p8" + export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=bluebird" **Supported Physics Suites** @@ -385,8 +385,8 @@ These tests use default values set in the ``export_fv3`` function of ``default_v * - Physics Suite - Description - * - FV3_GFS_v17_p8 - - The :term:`CCPP` GFS_v17_p8 physics suite is described in the CCPP documentation `here `__. + * - "bluebird" + - The :term:`CCPP` "bluebird" physics suite is described in the CCPP documentation `here `__. **Additional Information** @@ -433,7 +433,7 @@ physics tests. :numref:`Table %s ` (below) contains a selection of RTs .. code-block:: console - export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=FV3_RAP,FV3_HRRR,FV3_RRFS_v1beta,FV3_RRFS_v1nssl -D32BIT=ON" + export CMAKE_FLAGS="-DAPP=ATM -DCCPP_SUITES=albatross,bald_eagle,pigeon,crossbill -D32BIT=ON" **Supported Physics Suites** @@ -443,12 +443,12 @@ physics tests. :numref:`Table %s ` (below) contains a selection of RTs * - Physics Suite - Description - * - FV3_HRRR - - The FV3_HRRR physics suite is described in the :term:`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 similar to the *FV3_RRFS_v1beta* suite; however, it uses the NSSL 2-moment microphysics scheme instead of the Thompson microphysics scheme. + * - bald_eagle + - The "bald_eagle" physics suite is described in the :term:`CCPP` documentation `here `__. + * - pigeon + - The "pigeon" physics suite is described in the CCPP documentation `here `__. + * - crossbill + - The "crossbill" physics suite is similar to the *pigeon* suite; however, it uses the NSSL 2-moment microphysics scheme instead of the Thompson microphysics scheme. **Additional Information** @@ -574,7 +574,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - Other * - `rhafs_global_1nest_atm `__ - Compare HAFS global with 1 nest and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -597,7 +597,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_global_multiple_4nests_atm `__ - Compare HAFS global with 4 multiple nests and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -623,7 +623,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_global_storm_following_1nest_atm `__ - Compare HAFS global with 1 storm-following moving nest and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -646,7 +646,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_1nest_atm `__ - Compare HAFS regional with 1 nest and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -669,7 +669,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_atm `__ - Compare HAFS regional atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -691,7 +691,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_atm_ocn `__ - Compare HAFS regional atmosphere-ocean coupled HYCOM results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -713,7 +713,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_atm_ocn_wav `__ - Compare HAFS regional atmosphere-ocean-wave coupled results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -735,7 +735,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_atm_thompson_gfdlsf `__ - Compare the results from HAFS regional atmosphere only using the Thompson microphysics scheme and GFDL surface layer scheme with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_thompson_tedmf_gfdlsf" + - **Suite:** CCPP_SUITE="toucan" **Microphysics:** IMP_PHYSICS=8 @@ -757,7 +757,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_atm_wav `__ - Compare HAFS regional atmosphere-wave coupled results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -798,7 +798,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_docn `__ - Compare HAFS regional coupled with regional data ocean from MOM6 results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -821,7 +821,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_docn_oisst `__ - Compare HAFS regional coupled with global data ocean from OISST results with previous trunk version - - **Suite:** CCPP_SUITE=FV3_HAFS_v1_gfdlmp_tedmf_nonsst + - **Suite:** CCPP_SUITE=tanager **Microphysics:** IMP_PHYSICS=11 @@ -844,7 +844,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.true., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_specified_moving_1nest_atm `__ - Compare HAFS regional with 1 specified moving nest and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -867,7 +867,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_storm_following_1nest_atm `__ - Compare HAFS regional with 1 storm-following moving nest and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -890,7 +890,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_storm_following_1nest_atm_ocn `__ - Compare HAFS regional with 1 storm-following moving nest and atmosphere-ocean coupled results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -913,7 +913,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_storm_following_1nest_atm_ocn_debug `__ - Compare HAFS regional with 1 storm-following moving nest and atmosphere-ocean coupled results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -936,7 +936,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_storm_following_1nest_atm_ocn_debug `__ - Compare HAFS regional with 1 storm-following moving nest and atmosphere-ocean coupled results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -959,7 +959,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_storm_following_1nest_atm_ocn_wav `__ - Compare HAFS regional with 1 storm-following moving nest and atmosphere-ocean-wave coupled results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf_nonsst" + - **Suite:** CCPP_SUITE="tanager" **Microphysics:** IMP_PHYSICS=11 @@ -982,7 +982,7 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` - RESTART_INTERVAL=1, atm_omp_num_threads=2, WARM_START=.false., READ_INCREMENT=.false., RES_LATLON_DYNAMICS="'fv3_increment.nc'" * - `hafs_regional_telescopic_2nests_atm `__ - Compare HAFS regional with two telescopic nests and atmosphere only results with previous trunk version - - **Suite:** CCPP_SUITE="FV3_HAFS_v1_gfdlmp_tedmf" + - **Suite:** CCPP_SUITE="flamingo" **Microphysics:** IMP_PHYSICS=11 @@ -1019,10 +1019,12 @@ These tests use the default values set in the ``export_fv3``, ``export_hafs``, ` * - Physics Suite - Description - * - FV3_HAFS_v1_gfdlmp_tedmf - - The FV3_HAFS_v1_gfdlmp_tedmf physics suite is described in the :term:`CCPP` documentation `here `__. - * - FV3_HAFS_v1_gfdlmp_tedmf_nonsst - - The FV3_HAFS_v1_gfdlmp_tedmf_nonsst physics suite is described in the CCPP documentation `here `__. - * - FV3_HAFS_v1_thompson_tedmf_gfdlsf - - The FV3_HAFS_v1_thompson_tedmf_gfdlsf physics suite is described in the CCPP documentation `here `__. - + * - flamingo + - The "flamingo" physics suite is described in the :term:`CCPP` documentation `here `__. + * - tanager + - The "tanager" physics suite is described in the CCPP documentation `here `__. + * - toucan + - The "toucan" physics suite is described in the CCPP documentation `here `__. + +.. + NOTE: The above links do not link to the correct places! These would be documented for HAFS if they are documented at all. diff --git a/doc/UsersGuide/source/FAQ.rst b/doc/UsersGuide/source/FAQ.rst index 939f057bd6..4dce59cf60 100644 --- a/doc/UsersGuide/source/FAQ.rst +++ b/doc/UsersGuide/source/FAQ.rst @@ -29,18 +29,19 @@ The steps are: cd tests #. Find a configure (``*.conf``) file that contains the machine and compiler you are using. For this - example, the Intel compiler on Derecho is used. To create a custom configure file, two lines are + example, the test is being run on the Derecho machine. To create a custom configure file, two lines are needed: a ``COMPILE`` line and a ``RUN`` line. The ``COMPILE`` line should contain the name - of the machine and compiler ``derecho.intel`` and the desired ``SUITES`` for the build. Choose a + of the machine``derecho`` and the desired ``SUITES`` for the build. Choose a ``RUN`` line under this ``COMPILE`` command that uses the desired ``SUITE``. For example: .. code-block:: console - COMPILE | 32BIT=Y CCPP=Y STATIC=Y SUITES=FV3_GFS_v15p2,FV3_GFS_v16beta,FV3_GFS_v15p2_no_nsst,FV3_GFS_v16beta_no_nsst | standard | derecho.intel | fv3 - RUN | fv3_ccpp_gfs_v16beta | standard | | fv3 | + COMPILE | atm_dyn32 | intel | -DAPP=ATM -DCCPP_SUITES=raven,bluebird,hummingbird -D32BIT=ON | | fv3 | + RUN | control_c192 | - derecho | baseline | + Put these two lines into a file called ``my_test.conf``. The parameters used in this run can be - found in the ``fv3_ccpp_gfs_v16beta`` file in the ``ufs-weather-model/tests/tests`` directory. + found in the ``control_c192`` file in the ``ufs-weather-model/tests/tests`` directory. .. note:: These two lines are long and may not appear in entirety in your browser. Scroll to the right to see the entire line. @@ -571,3 +572,12 @@ For the fully coupled S2SWA application, a sample ``ufs.configure`` is shown bel stop_option = nhours stop_ymd = -999 :: + +===================================================================== +How can I run with the same physics as the operational GFS/HAFS/etc.? +===================================================================== + +The UFS utilizes the Common Community Physics Package (CCPP) for its physics. This is a shared `software framework `_ +and `repository of physics code `_ used for sharing physics code among multiple different models and dynamical cores. The physics schemes that will be run depend on the :ref:`Suite Definition File (SDF) `. However, using the same SDF is required to run the same physics, it is not sufficient. While we are working towards more unification in the future, for now physics settings are spread between both the SDF *and* the namelist :ref:`FV3 namelist "input.nml" `. So in order to run a simulation with the same physics as an operational product, or some other specific configuration, you will need to use both the same Suite Definition File **and** the same namelist settings. For the namelist settings available for each specific physics configuration, see the latest `CCPP Scientific Documentation `_. + + diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst index fbf767c263..1f5adb6ee5 100644 --- a/doc/UsersGuide/source/InputsOutputs.rst +++ b/doc/UsersGuide/source/InputsOutputs.rst @@ -1655,25 +1655,129 @@ However, ``ufs.configure`` files for other configurations of the Weather Model a .. 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. -.. _SDF-file: +.. _SDF: --------------------------------------- -The Suite Definition File (SDF) File +The Suite Definition File (SDF) --------------------------------------- -There are two SDFs currently supported for the UFS Medium Range Weather App configuration: - - * ``suite_FV3_GFS_v15p2.xml`` - * ``suite_FV3_GFS_v16beta.xml`` - -There are four SDFs currently supported for the UFS Short Range Weather App configuration: - - * ``suite_FV3_GFS_v16.xml`` - * ``suite_FV3_RRFS_v1beta.xml`` - * ``suite_FV3_HRRR.xml`` - * ``suite_FV3_WoFS_v0.xml`` - -Detailed descriptions of the supported suites can be found with the `CCPP v6.0.0 Scientific Documentation `__. +The `Suite Definition File (SDF) `__ is an XML-format file that specifies the list of physics schemes that can be run by the model. + +^^^^^^^^^^^^^^^^ +Supported suites +^^^^^^^^^^^^^^^^ + +.. _MRWSupportedSuites: + +There is one SDF currently supported for the UFS Medium Range Weather App configuration: + +.. csv-table:: Supported Suites for MRW + :header: "Suite", "Description" + :widths: 15, 30 + + .. _suite_kingfisher: + "kingfisher.xml", "Suite 'kingfisher' (originally named FV3_GFS_v15p2) was developed for research and prototyping of early UFS systems. It was meant to emulate the operational `GFS v15.2 `__ physics, though it has some differences from the operational implementation (which was not CCPP-based)." + + +.. _SRWSupportedSuites: + +There are five SDFs currently supported for the UFS Short Range Weather App configuration: + +.. csv-table:: Supported Suites for SRW + :header: "Suite", "Description" + :widths: 15, 30 + + .. _suite_albatross: + "albatross.xml", "Suite 'albatross' (originally named FV3_RAP) was developed for research and prototyping of early UFS systems. It was meant to emulate the physics of the `Rapid Refresh (RAP) model `__, though it has some differences from the operational implementation (which was not CCPP-based)." + .. _suite_bald_eagle: + "bald_eagle.xml", "Suite 'bald_eagle' (originally named FV3_HRRR) was developed for research and testing for early prototypes of the Rapid Refresh Forecast System (RRFS). It was meant to emulate the physics of the `High-Resolution Rapid Refresh (HRRR) `__ model, though it has some differences from the operational implementation (which was not CCPP-based)." + .. _suite_hummingbird: + "hummingbird.xml", "Suite 'hummingbird' (originally named FV3_WoFS_v0) was developed was used for testing an early prototype of the experimental FV3-based Warn-on-Forecast System (WoFS). Same as suite :ref:`crossbill ` except with Noah Land Surface Model instead of the NoahMP LSM." + .. _suite_pigeon: + "pigeon.xml", "Suite 'pigeon' (originally named FV3_RRFS_v1beta) was developed for an early prototype of the `Rapid Refresh Forecast System (RRFS) `__." + .. _suite_raven: + "raven.xml", "Suite 'raven' (originally named FV3_GFS_v16) was developed for research and prototyping of early UFS systems. It was meant to emulate the operational `GFS v16 `__ suite, though it has some differences from the operational implementation (which was not CCPP-based)." + + +Detailed descriptions of the supported suites can be found in the latest `CCPP Scientific Documentation `__ + +.. _UnsupportedSuites: + +Suites detailed below are provided for informational purposes only, and may not be supported. Detailed descriptions of the supported suites can be found in the latest `CCPP Scientific Documentation `__ + +.. csv-table:: Unsupported Suites + :header: "Suite", "Description" + :widths: 15, 30 + + .. _suite_auklet: + "auklet.xml", "Suite 'auklet' (formerly known as FV3_HRRR_gf) was used for research and testing for early prototypes of the `Rapid Refresh Forecast System (RRFS) `__. Similar to suite :ref:`bald_eagle `, except with the addition of the Grell-Freitas deep convection scheme and GFS convective cloud diagnostics." + .. _suite_bluebird: + "bluebird.xml", "Suite 'bluebird' (formerly known as FV3_GFS_v17_p8) was used for testing an early prototype of the Global Forecast System (GFS) version 17 release. While it is similar to the physics used for this prototype (P8), it is not identical, and the eventual operational implementation of GFS version 17 will likely be quite different." + .. _suite_canary: + "canary.xml", "Suite 'canary' (formerly known as FV3_GFS_v17_p8_rrtmgp) is a suite used for testing an early prototype of the Global Forecast System (GFS) version 17 release ('Prototype 8'). Similar to :ref:`bluebird `, but uses RRTMGP: a re-written an parallelized version of the older RRTMG radiation schemes (see https://earth-system-radiation.github.io/rte-rrtmgp/)." + .. _suite_chickadee: + "chickadee.xml", "Suite 'chickadee' (formerly known as RRFSens_phy3) is one of the suites used in early prototypes of the Rapid Refresh Forecast System (RRFS) multi-physics ensemble." + .. _suite_condor: + "condor.xml", "Suite 'condor' (formerly known as FV3_GFS_v17_p8_ugwpv1) was used for testing early prototypes of the Global Forecast System (GFS) version 17 release. Identical to suite :ref:`bluebird ` but with an upgraded version of the unified gravity wave drag physics (v0 -> v1)." + .. _suite_crossbill: + "crossbill.xml", "Suite 'crossbill' (originally named FV3_RRFS_v1nssl) was developed for research and development of early prototypes of the Rapid Refresh Forecast System (RRFS), specifically including the NSSL 2-moment cloud microphysics scheme when it was added to CCPP (see https://github.com/NOAA-EMC/fv3atm/pull/472 and https://github.com/NCAR/ccpp-physics/pull/761)." + .. _suite_crow: + "crow.xml", Suite 'crow' (formerly known as FV3_GFS_v15_thompson_mynn_lam3km) is an early physics suite used for research and experiments with early high-resolution (3-km) regional UFS grids." + .. _suite_dotterel: + "dotterel.xml", "Suite 'dotterel' (formerly known as FV3_GFS_v17_coupled_p8_sfcocn) was used for testing an early prototype of the Global Forecast System (GFS) version 17 release. Similar to suite :ref:`pelican `, except with a modified near-sea-surface temperature scheme (sfc_ocean) for use with GRIB2 input data." + .. _suite_dove: + "dove.xml", "Suite 'dove' (formerly known as FV3_RAP_noah) was originally developed for research and prototyping of early UFS systems. Similar to :ref:`albatross `, except using the Noah Land Surface Model (instead of RUC LSM) and the GFS surface sea-ice model. " + .. _suite_egret: + "egret.xml", "Suite 'egret' (formerly known as FV3_GFS_v16_csawmg) was a suite added for experiments with the Morrison-Gettelman version 3 microphysics." + .. _suite_falcon: + "falcon.xml", "Suite 'falcon' (formerly known as FV3_global_nest_v1) is a suite that was developed for forecasting atmospheric rivers for the Water in the West project." + .. _suite_flamingo: + "flamingo.xml", "Suite 'flamingo' (formerly known as FV3_HAFS_v1_gfdlmp_tedmf) is the physics suite used by the operational HAFS-A configuration. When using GRIB2 input data, use suite :ref:`tanager ` instead." + .. _suite_flycatcher: + "flycatcher.xml", "Suite 'flycatcher' (formerly known as FV3_HRRR_gf_nogwd) is a suite developed for a prototype of the Rapid Refresh Forecast System (RRFS) for fire weather prediction. Similar to suite :ref:`auklet `, except without gravity wave drag parameterization." + .. _suite_heron: + "heron.xml", "Suite 'heron' (formerly known as FV3_GFS_v16_flake) was added to test the capabilities of the Freshwater Lake (FLake) model (http://www.flake.igb-berlin.de/site/doc) for simulating freshwater lake temperatures." + .. _suite_hornbill: + "hornbill.xml", "Suite 'hornbill' (formerly known as FV3_HAFS_v1_thompson_nonsst) is similar (though not identical) to the physics suite used by the operational HAFS-B configuration. Identical to suite :ref:`lorikeet `, except with a modified near-sea-surface temperature scheme (sfc_ocean) for use with GRIB2 input data." + "ibis.xml", "Suite 'ibis' (formerly known as FV3_RAP_unified_ugwp) is similar to :ref:`'albatross' ` but using the unified gravity wave drag scheme (version 0) rather than the GSL orographic gravity wave drag scheme." + .. _suite_kestrel: + "kestrel.xml", "Suite 'kestrel' (originally named RRFSens_phy4) is one of the suites used in early prototypes of the Rapid Refresh Forecast System (RRFS) multi-physics ensemble." + .. _suite_loon: + "loon.xml", "Suite 'loon' (formerly known as FV3_GFS_v16_fv3wam) was originally developed for early prototypes of the FV3-based Whole Atmosphere Model (WAM)." + .. _suite_lorikeet: + "lorikeet.xml", "Suite 'lorikeet' (formerly known as FV3_HAFS_v1_thompson) is similar (though not identical) to the physics suite used by the operational HAFS-B configuration. When using GRIB2 input data, or coupled with an ocean model, use suite :ref:`hornbill ` instead." + .. _suite_magpie: + "magpie.xml", "Suite 'magpie' (formerly known as FV3_GFS_v17_coupled_p8_ugwpv1) was originally developed for use by the GFS v17 High-resolution prototype 3 (HR3). While it acccurately represents the physics suite used for this prototype, the eventual implementation of the operational GFS version 17 will likely be different." + .. _suite_meadowlark: + "meadowlark.xml", "Suite 'meadowlark' (formerly known as FV3_RAP_noah_sfcdiff_cires_ugwp) was originally developed for research and prototyping of early UFS systems. Designed to emulate the RAP physics, but with several differences, including the surface scheme, land surface model, and gravity wave parameterizations." + .. _suite_parakeet: + "parakeet.xml", "Suite 'parakeet' (formerly known as FV3_GFS_v17_p8_c3) was used for testing an early prototype of the Global Forecast System (GFS) version 17 release. While it is similar to the physics used for this prototype (P8), it is not identical, and the eventual operational implementation of GFS version 17 will likely be quite different." + .. _suite_pelican: + "pelican.xml", "Suite 'pelican' (formerly known as FV3_GFS_v17_coupled_p8) was used for testing an early prototype of the Global Forecast System (GFS) version 17 release. While it is similar to the physics used for this prototype (P8), it is not identical, and the eventual operational implementation of GFS version 17 will likely be quite different. Identical to suite :ref:`bluebird `, except with the 'sfc_cice' physics routine used for coupling with the Community Ice Code (CICE) sea-ice model (https://www.cesm.ucar.edu/models/cice)." + .. _suite_penguin: + "penguin.xml", "Suite 'penguin' (formerly known as RRFSens_phy5) is one of the suites used in early prototypes of the Rapid Refresh Forecast System (RRFS) multi-physics ensemble." + .. _suite_ptarmigan: + "ptarmigan.xml", "Suite 'ptarmigan' (formerly known as RRFSens_phy2) is one of the suites used in early prototypes of the Rapid Refresh Forecast System (RRFS) multi-physics ensemble." + .. _suite_puffin: + "puffin.xml", "Suite 'puffin' (formerly known as RRFSens_phy1) is one of the suites used in early prototypes of the Rapid Refresh Forecast System (RRFS) multi-physics ensemble." + .. _suite_sandpiper: + "sandpiper.xml", "Suite 'sandpiper' (formerly known as FV3_RAP_flake) is identical to suite :ref:`albatross `, but with the addition of the Freshwater Lake (FLake) model (http://www.flake.igb-berlin.de/site/doc) for simulating freshwater lake temperatures." + .. _suite_shrike: + "shrike.xml", "Suite 'shrike' (formerly known as FV3_RAP_sfcdiff) is identical to suite :ref:`albatross `, but with the GFS surface layer scheme rather than the MYNN surface layer scheme." + .. _suite_snowy_owl: + "snowy_owl.xml", "Suite 'snowy_owl' (formerly known as FV3_RAP_clm_lake) was originally developed for research and prototyping of early UFS systems. It was meant to emulate the physics of the Rapid Refresh (RAP) model, though it has some differences from the operational implementation (which was not CCPP-based). This suite is identical to suite :ref:`albatross `, but with the addition of the Community Land Model (CLM) lake model (as is found in the operational RAP)." + .. _suite_starling: + "starling.xml", "Suite 'starling' (formerly known as FV3_GFS_v16_ras) is identical to suite :ref:`raven `, but with the Relaxed Arakawa-Schubert Convection Scheme rather than the scale-aware mass-flux deep convection scheme." + .. _suite_tanager: + "tanager.xml", "Suite 'tanager' (formerly known as FV3_HAFS_v1_gfdlmp_tedmf_nonsst) is similar (though not identical) to the physics suite used by the operational HAFS-A configuration. Identical to suite :ref:`flamingo `, except with a modified near-sea-surface temperature scheme (sfc_ocean) for use with GRIB2 input data." + .. _suite_tern: + "tern.xml", "Suite 'tern' (formerly known as FV3_GFS_v17_p8_mynn) was used for testing an early prototype of the Global Forecast System (GFS) version 17 release." + .. _suite_toucan: + "toucan.xml", "Suite 'toucan' (formerly known as FV3_HAFS_v1_thompson_tedmf_gfdlsf) is similar (though not identical) to the physics suite used by the operational HAFS-B configuration. One specific difference is that this suite uses the GFDL surface layer scheme (similar to that used in the operational HWRF) rather than the GFS surface layer scheme used in HAFS-B." + .. _suite_turnstone: + "turnstone.xml", "Suite 'turnstone' (formerly known as FV3_RAP_cires_ugwp) is similar to :ref:`albatross ` but using the CIRES Unified Gravity Wave Physics (version 0) rather than the GSL orographic gravity wave drag scheme." + .. _suite_wren: + "wren.xml", "Suite 'wren' (formerly known as FV3_HRRR_c3) is similar to suite :ref:`bald_eagle ` but with the addition of the C3 Deep Convection scheme." .. _datm.streams-file: @@ -1809,11 +1913,13 @@ Namelist file ``input.nml`` The atmosphere model reads many parameters from a Fortran namelist file, named ``input.nml``. This file contains several Fortran namelist records, some of which are always required, others of which are only used when selected physics options are chosen: - * The `CCPP Scientific Documentation `__ provides an in-depth description of the namelist settings. Information describing the various physics-related namelist records can be viewed `here `__. + * The `CCPP Scientific Documentation `__ provides an in-depth description of most of the physics-related namelist settings. Information describing the various physics-related namelist records can be viewed `here `__. * The `Stochastic Physics Documentation `__ describes the stochastic physics namelist records. * The `FV3 Dynamical Core Technical Documentation `__ describes some of the other namelist records (dynamics, grid, etc). * The namelist section ``&interpolator_nml`` is not used in this release, and any modifications to it will have no effect on the model results. +The rest of the namelist records are detailed in the following sections: + .. _fms_io_nml_section: ^^^^^^^^^^^^^^^^^^ @@ -2068,7 +2174,7 @@ The variables used in ``&atmos_model_nml`` are described in :numref:`Table %s