Skip to content

Commit

Permalink
add ccpp techdoc link, rm comments
Browse files Browse the repository at this point in the history
  • Loading branch information
gspetro-NOAA committed Oct 26, 2023
1 parent 0fce6ba commit 40d7173
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 11 deletions.
4 changes: 0 additions & 4 deletions docs/UsersGuide/source/BackgroundInfo/Components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ UFS Preprocessing Utilities (UFS_UTILS)

The SRW Application includes a number of pre-processing utilities (UFS_UTILS) that initialize and prepare the model. Since the SRW App provides forecast predictions over a limited area (rather than globally), these utilities generate a regional grid (``regional_esg_grid/make_hgrid``) along with :term:`orography` (``orog``) and surface climatology (``sfc_climo_gen``) files on that grid. Grids include a strip, or "halo," of six cells that surround the regional grid and feed in lateral boundary condition data. Since different grid and orography files require different numbers of :term:`halo` cells, additional utilities handle topography filtering and shave the number of halo points (based on downstream workflow component requirements). The pre-processing software :term:`chgres_cube` is used to convert the raw external model data into initial and lateral boundary condition files in :term:`netCDF` format. These are needed as input to the :term:`FV3` limited area model (:term:`LAM`). Additional information about the UFS pre-processing utilities can be found in the :doc:`UFS_UTILS Technical Documentation <ufs-utils:index>` and in the `UFS_UTILS Scientific Documentation <https://ufs-community.github.io/UFS_UTILS/ver-1.11.0/index.html>`__.

.. COMMENT: Check that new UFS_UTILS links work!
The SRW Application can be initialized from a range of operational initial condition files. It is possible to initialize the model from the Global Forecast System (:term:`GFS`), North American Mesoscale (:term:`NAM`) Forecast System, Rapid Refresh (:term:`RAP`), and High-Resolution Rapid Refresh (:term:`HRRR`) files in Gridded Binary v2 (:term:`GRIB2`) format. GFS files also come in :term:`NEMSIO` format for past dates.

.. WARNING::
Expand All @@ -42,8 +40,6 @@ Model Physics

The Common Community Physics Package (CCPP), described `here <https://dtcenter.org/community-code/common-community-physics-package-ccpp>`__, supports interoperable atmospheric physics and land surface model options. Atmospheric physics are a set of numerical methods describing small-scale processes such as clouds, turbulence, radiation, and their interactions. The SRW App v2.2.0 release includes five supported physics suites: FV3_RRFS_v1beta, FV3_GFS_v16, FV3_WoFS_v0, FV3_HRRR, and FV3_RAP (new!). The FV3_RRFS_v1beta physics suite is being tested for use in the future operational implementation of the Rapid Refresh Forecast System (:term:`RRFS`) planned for 2023-2024, and the FV3_GFS_v16 is an updated version of the physics suite used in the operational Global Forecast System (GFS) v16. A detailed list of CCPP updates since the SRW App v2.1.0 release is available :ref:`here <CCPPUpdates>`. A full scientific description of CCPP parameterizations and suites can be found in the `CCPP Scientific Documentation <https://dtcenter.ucar.edu/GMTB/UFS_SRW_App_v2.2.0/sci_doc/index.html>`__, and CCPP technical aspects are described in the :doc:`CCPP Technical Documentation <ccpp-techdoc:index>`. The model namelist has many settings beyond the physics options that can optimize various aspects of the model for use with each of the supported suites. Additional information on Stochastic Physics options is available :doc:`here <stochphys:index>`.

.. COMMENT: Update link to CCPP technical docs on RTD! Check on stochastic physics link.
.. note::
SPP is currently only available for specific physics schemes used in the RAP/HRRR physics suite. Users need to be aware of which physics suite definition file (:term:`SDF`) is chosen when turning this option on. Among the supported physics suites, the full set of parameterizations can only be used with the ``FV3_HRRR`` option for ``CCPP_PHYS_SUITE``.

Expand Down
6 changes: 2 additions & 4 deletions docs/UsersGuide/source/BackgroundInfo/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ Since the last release, developers have added a variety of features:
* Air Quality Modeling (AQM) capabilities (unsupported but available; see `PR #613 <https://github.com/ufs-community/ufs-srweather-app/pull/613>`__)
* Miscellaneous documentation updates to reflect the changes above

.. COMMENT: Add new CCPP updates page
The SRW App v2.2.0 citation is as follows and should be used when presenting results based on research conducted with the App:

UFS Development Team. (2023, Oct. 30). Unified Forecast System (UFS) Short-Range Weather (SRW) Application (Version v2.2.0). Zenodo. https://doi.org/10.5281/zenodo.10015544
Expand Down Expand Up @@ -125,7 +123,7 @@ A list of available component documentation is shown in :numref:`Table %s <list_
* - FV3 Scientific Documentation
- https://repository.library.noaa.gov/view/noaa/30725
* - CCPP Technical Documentation
- https://ccpp-techdoc.readthedocs.io/en/latest/
- https://ccpp-techdoc.readthedocs.io/en/ufs_srw_app_v2.2.0/
* - CCPP Scientific Documentation
- https://dtcenter.ucar.edu/GMTB/UFS_SRW_App_v2.2.0/sci_doc/index.html
* - Stochastic Physics Documentation
Expand All @@ -141,7 +139,7 @@ A list of available component documentation is shown in :numref:`Table %s <list_
* - METplus User's Guide
- https://metplus.readthedocs.io/en/main_v4.1/Users_Guide/index.html

.. COMMENT: Update links for stochastic_physics, CCPP Tech docs, UFS_UTILS
.. COMMENT: Check links for stochastic_physics, CCPP Tech docs, UFS_UTILS
User Support and Contributions to Development
Expand Down
4 changes: 1 addition & 3 deletions docs/UsersGuide/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,10 @@ def setup(app):
'ufs-wm': ('https://ufs-weather-model.readthedocs.io/en/ufs-srw-v2.2.0-doc/', None),
'upp': ('https://upp.readthedocs.io/en/upp-srw-v2.2.0-docs/', None),
'ufs-utils': ('https://noaa-emcufs-utils.readthedocs.io/en/ufs_utils_1_11_0/', None),
'ccpp-techdoc': ('https://ccpp-techdoc.readthedocs.io/en/latest/', None),
'ccpp-techdoc': ('https://ccpp-techdoc.readthedocs.io/en/ufs_srw_app_v2.2.0/', None),
'stochphys': ('https://stochastic-physics.readthedocs.io/en/release-public-v3/', None),
}

# COMMENT: Update hpc-stack ref to release docs! https://hpc-stack-epic.readthedocs.io/en/release-srw-public-v2.2.0/

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
Expand Down

0 comments on commit 40d7173

Please sign in to comment.