Merge pull request #36 from fossell/ufs_public_release

Update documentation files for ufs release

.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+#python:
+#  version: 3.7
+#  install:
+#    - requirements: docs/requirements.txt

docs/UPP_Users_guide_V4.rst

@@ -29,26 +29,39 @@ NCEP Unified Post Processor (UPP)
 UPP Introduction
 ================
 
-The NCEP Unified Post Processor has replaced the WRF Post Processor
-(WPP). The UPP software package is based on WPP but has enhanced
-capabilities to post-process output from a variety of NWP models,
-including WRF-NMM, WRF-ARW, Nonhydrostatic Multi-scale Model on the B
-grid (NMMB), Global Forecast System (GFS), Climate Forecast System
-(CFS), and the global Finite-Volume Cubed Sphere dynamical core (FV3).
-
-In addition to the option to output fields on the models native vertical
-levels, UPP interpolates output from the models native grids to National
-Weather Service (NWS) standard levels (pressure, height, etc.) and
-standard output grids (AWIPS, Lambert Conformal, polar-stereographic,
-etc.) in NWS and World Meteorological Organization (WMO) GRIB format.
-
-UPP incorporates the Joint Center for Satellite Data Assimilation
-(JCSDA) Community Radiative Transfer Model (CRTM) to compute model
-derived brightness temperature (TB) for various instruments and
-channels. This additional feature enables the generation of a number of
-simulated satellite products including GOES and AMSRE products for
-WRF-NMM, Hurricane WRF (HWRF), WRF-ARW and GFS. For CRTM documentation,
-refer to:
+The Unified Post Processor (UPP) software package is a software package 
+designed to generate useful products from raw model output. The UPP is 
+currently used in operations with the Global Forecast System (GFS), GFS 
+Ensemble Forecast System (GEFS), North American Mesoscale (NAM), Rapid 
+Refresh (RAP), High Resolution Rapid Refresh (HRRR), Short Range Ensemble 
+Forecast (SREF),  Hurricane WRF (HWRF) applications, and is also used in 
+Unified Forecasting System (UFS) applications.  The UPP provides the capability 
+to compute a variety of diagnostic fields and interpolate to pressure levels 
+or other vertical coordinates. UPP also incorporates the Joint Center for 
+Satellite Data Assimilation (JCSDA) Community Radiative Transfer Model (CRTM) 
+to compute model derived brightness temperature (TB) for various instruments 
+and channels. This additional feature enables the generation of a number of 
+simulated satellite products including GOES products.  Output from the UPP is 
+in National Weather Service (NWS) and World Meteorological Organization (WMO) 
+GRIB2 format and can be used directly by visualization, plotting, or verification 
+packages, or for further downstream post-processing, e.g. statistical 
+post-processing techniques.
+
+   Examples of UPP products include:
+
+     - T, Z, humidity, wind, cloud water, cloud ice, rain, and snow on pressure levels
+     - SLP, shelter level T, humidity, and wind fields
+     - Precipitation-related fields
+     - PBL-related fields
+     - Severe weather products (e.g. CAPE, Vorticity, Wind shear)
+     - Radiative/Surface fluxes
+     - Cloud related fields
+     - Aviation products
+     - Radar reflectivity products
+     - Satellite look-alike products
+
+Community user support is currently provided for FV3-based applications, and on 
+a limited basis, WRF-ARW applications.
 
 http://www.dtcenter.org/upp/users/docs/user_guide/crtm_ug/CRTM_User_Guide.pdf.
 
@@ -742,7 +755,7 @@ Acknowledgement
 
 If significant help was provided via the UPP helpdesk for work resulting
 in a publication, please acknowledge the Developmental Testbed Center
-Mesoscale Modeling Team.
+UPP Team.
 
 For referencing this document please use:
 

docs/conf.py

@@ -41,6 +41,8 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
+# The master toctree document.
+master_doc = 'index'
 
 # -- Options for HTML output -------------------------------------------------
 

docs/index.rst

@@ -10,7 +10,7 @@ Welcome to upp_docs's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   UPP_Users_guide_V4_ufs
+   UPP_Users_guide_V4.rst
 
 Indices and tables
 ==================