From ce84b5df7ef47750d54c0046c28494163fe3bc23 Mon Sep 17 00:00:00 2001 From: Kate Fossell Date: Tue, 10 Dec 2019 13:12:26 -0700 Subject: [PATCH 1/4] Modifying introduction --- docs/UPP_Users_guide_V4.rst | 58 ++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 23 deletions(-) diff --git a/docs/UPP_Users_guide_V4.rst b/docs/UPP_Users_guide_V4.rst index 3391db17c..0c5ac7f21 100644 --- a/docs/UPP_Users_guide_V4.rst +++ b/docs/UPP_Users_guide_V4.rst @@ -31,28 +31,40 @@ 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). -At this time, community user support is only provided for the WRF-ARW -and FV3 systems. - -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. @@ -1560,7 +1572,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: From 5baf0d9ade1d6d948c64cb29545a67c7997110ca Mon Sep 17 00:00:00 2001 From: Kate Fossell Date: Mon, 16 Dec 2019 11:35:32 -0700 Subject: [PATCH 2/4] Add readthedocs config file --- .readthedocs.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..286f0b31d --- /dev/null +++ b/.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 From 77b4376a16ff97d8434d65cd00779e51c8353d33 Mon Sep 17 00:00:00 2001 From: Kate Fossell Date: Mon, 16 Dec 2019 11:44:01 -0700 Subject: [PATCH 3/4] Modify name of main rst doc in index for readthedocs build test --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index c347c3843..27ff640ee 100644 --- a/docs/index.rst +++ b/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 ================== From 862a1414dad0d9a756475d32515a9919a1441082 Mon Sep 17 00:00:00 2001 From: Kate Fossell Date: Mon, 16 Dec 2019 11:55:37 -0700 Subject: [PATCH 4/4] Change master file to index --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 8b29cc76e..ae4186a60 100644 --- a/docs/conf.py +++ b/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 -------------------------------------------------