|
| 1 | + |
| 2 | +# Unified Post-Processing (UPP) |
| 3 | + |
| 4 | +The Unified Post Processor (UPP) software package is a software |
| 5 | +package designed to generate useful products from raw model |
| 6 | +output. |
| 7 | + |
| 8 | +The UPP is currently used in operations with the Global Forecast |
| 9 | +System (GFS), GFS Ensemble Forecast System (GEFS), North American |
| 10 | +Mesoscale (NAM), Rapid Refresh (RAP), High Resolution Rapid Refresh |
| 11 | +(HRRR), Short Range Ensemble Forecast (SREF), Hurricane WRF (HWRF) |
| 12 | +applications, and is also used in Unified Forecasting System (UFS) |
| 13 | +applications. |
| 14 | + |
| 15 | +The UPP provides the capability to compute a variety of diagnostic |
| 16 | +fields and interpolate to pressure levels or other vertical |
| 17 | +coordinates. |
| 18 | + |
| 19 | +UPP also incorporates the Joint Center for Satellite Data Assimilation |
| 20 | +(JCSDA) Community Radiative Transfer Model (CRTM) to compute model |
| 21 | +derived brightness temperature (TB) for various instruments and |
| 22 | +channels. This additional feature enables the generation of a number |
| 23 | +of simulated satellite products including GOES products. |
| 24 | + |
| 25 | +Output from the UPP is in National Weather Service (NWS) and World |
| 26 | +Meteorological Organization (WMO) GRIB2 format and can be used |
| 27 | +directly by visualization, plotting, or verification packages, or for |
| 28 | +further downstream post-processing, e.g. statistical post-processing |
| 29 | +techniques. |
| 30 | + |
| 31 | +Examples of UPP products include: |
| 32 | + |
| 33 | +- T, Z, humidity, wind, cloud water, cloud ice, rain, and snow on pressure levels |
| 34 | +- SLP, shelter level T, humidity, and wind fields |
| 35 | +- Precipitation-related fields |
| 36 | +- PBL-related fields |
| 37 | +- Severe weather products (e.g. CAPE, Vorticity, Wind shear) |
| 38 | +- Radiative/Surface fluxes |
| 39 | +- Cloud related fields |
| 40 | +- Aviation products |
| 41 | +- Radar reflectivity products |
| 42 | +- Satellite look-alike products |
| 43 | + |
| 44 | +Support for the UFS UPP is provided through the UFS Forum by the |
| 45 | +Developmental Testbed Center (DTC) for FV3-based applications. |
| 46 | + |
| 47 | +The UPP uses some of the [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) |
| 48 | +project. |
| 49 | + |
| 50 | +## Authors |
| 51 | + |
| 52 | +NCEP/EMC Developers |
| 53 | + |
| 54 | +Code Manager: Wen Meng, Huiya Chuang, Kate Fossell |
| 55 | + |
| 56 | +## Prerequisites |
| 57 | + |
| 58 | +This package requires the following NCEPLIBS packages: |
| 59 | + |
| 60 | +- [NCEPLIBS-g2](https://github.com/NOAA-EMC/NCEPLIBS-g2) |
| 61 | +- [NCEPLIBS-g2tmpl](https://github.com/NOAA-EMC/NCEPLIBS-g2tmpl) |
| 62 | +- [NCEPLIBS-sp](https://github.com/NOAA-EMC/NCEPLIBS-sp) |
| 63 | +- [NCEPLIBS-ip](https://github.com/NOAA-EMC/NCEPLIBS-ip) |
| 64 | +- [NCEPLIBS-bacio](https://github.com/NOAA-EMC/NCEPLIBS-bacio) |
| 65 | +- [NCEPLIBS-w3emc](https://github.com/NOAA-EMC/NCEPLIBS-w3emc) |
| 66 | +- [NCEPLIBS-w3nco](https://github.com/NOAA-EMC/NCEPLIBS-w3nco) |
| 67 | +- [CRTM](https://github.com/noaa-emc/emc_crtm) |
| 68 | + |
| 69 | +Also required to build NCEPpost executable (cmake option |
| 70 | +BUILD_POSTEXEC): |
| 71 | + |
| 72 | +- [NCEPLIBS-sigio](https://github.com/NOAA-EMC/NCEPLIBS-sigio) - |
| 73 | +- [NCEPLIBS-sfcio](https://github.com/NOAA-EMC/NCEPLIBS-sfcio) - |
| 74 | +- [NCEPLIBS-nemsio](https://github.com/NOAA-EMC/NCEPLIBS-nemsio) - |
| 75 | +- [NCEPLIBS-gfsio](https://github.com/NOAA-EMC/NCEPLIBS-gfsio) |
| 76 | + |
| 77 | +The [NCEPLIBS-wrf_io](https://github.com/NOAA-EMC/NCEPLIBS-wrf_io) |
| 78 | +library is required to build with NCEPpost with WRF-IO library (cmake |
| 79 | +option BUILD_WITH_WRFIO). |
| 80 | + |
| 81 | +The following third-party libraries are required: |
| 82 | + |
| 83 | +- [netcdf-c](https://github.com/Unidata/netcdf-c) |
| 84 | +- [netcdf-fortran](https://github.com/Unidata/netcdf-fortran) |
| 85 | +- [Jasper](https://github.com/jasper-software/jasper) |
| 86 | +- [libpng](http://www.libpng.org/pub/png/libpng.html) |
| 87 | +- [libz](https://zlib.net/) |
| 88 | + |
| 89 | +## Building |
| 90 | + |
| 91 | +Builds include: |
| 92 | + |
| 93 | +- Operational use GNC build as Wen described for both library and |
| 94 | + executable (library used for GFS only at this time) |
| 95 | + |
| 96 | +- MRW App uses UPP packaged with nceplibs and cmake to build/run with |
| 97 | + executable (via release/public-v1 branch). |
| 98 | + |
| 99 | +- SRW App uses UPP repo branch/tag directly and uses cmake to |
| 100 | + build/run with executable (via release/public-v2 branch). |
| 101 | + |
| 102 | +- Community standalone uses UPP repo branch/tag directly and uses |
| 103 | + cmake to build/run with executable (via release/public-v2 |
| 104 | + branch). For these procedures, we add a |
| 105 | + -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} where INSTALL_PREFIX is the |
| 106 | + location of the nceplibs installation as a dependency requirement. |
| 107 | + |
| 108 | +``` |
| 109 | +mkdir build |
| 110 | +cd build |
| 111 | +cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install |
| 112 | +make |
| 113 | +make test |
| 114 | +make install |
| 115 | +``` |
| 116 | + |
| 117 | +## Disclaimer |
| 118 | + |
| 119 | +The United States Department of Commerce (DOC) GitHub project code is |
| 120 | +provided on an "as is" basis and the user assumes responsibility for |
| 121 | +its use. DOC has relinquished control of the information and no longer |
| 122 | +has responsibility to protect the integrity, confidentiality, or |
| 123 | +availability of the information. Any claims against the Department of |
| 124 | +Commerce stemming from the use of its GitHub project will be governed |
| 125 | +by all applicable Federal law. Any reference to specific commercial |
| 126 | +products, processes, or services by service mark, trademark, |
| 127 | +manufacturer, or otherwise, does not constitute or imply their |
| 128 | +endorsement, recommendation or favoring by the Department of |
| 129 | +Commerce. The Department of Commerce seal and logo, or the seal and |
| 130 | +logo of a DOC bureau, shall not be used in any manner to imply |
| 131 | +endorsement of any commercial product or activity by DOC or the United |
| 132 | +States Government. |
0 commit comments