Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #486

Merged
merged 18 commits into from
Apr 26, 2022
Merged
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 29 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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.
applications (MRW, SRW, and HAFS).
WenMeng-NOAA marked this conversation as resolved.
Show resolved Hide resolved

The UPP provides the capability to compute a variety of diagnostic
fields and interpolate to pressure levels or other vertical
Expand Down Expand Up @@ -41,23 +41,29 @@ Examples of UPP products include:
- Radar reflectivity products
- Satellite look-alike products

Support for the UFS UPP is provided through the UFS Forum by the
Developmental Testbed Center (DTC) for FV3-based applications.

For full documentation see https://noaa-emc.github.io/UPP/.
## User Support
Support for the UFS UPP is provided through the [UFS Forum](https://forums.ufscommunity.org/)
by the Developmental Testbed Center (DTC).

The UPP uses some of the [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS)
project.
## Documentation
User Guide for latest public release: https://upp.readthedocs.io/en/latest/.

Technical code-level documentation: https://noaa-emc.github.io/UPP/.

## Developer Information
Please see review the [wiki](https://github.com/NOAA-EMC/UPP/wiki)

## Authors

NCEP/EMC Developers

Code Manager: Wen Meng, Huiya Chuang, Kate Fossell
Code Managers: Wen Meng, Huiya Chuang, Kate Fossell

## Prerequisites

This package requires the following NCEPLIBS packages:
The UPP requires certain NCEPLIB packages to be installed via
the HPC-Stack project.

- [NCEPLIBS-g2](https://github.com/NOAA-EMC/NCEPLIBS-g2)
- [NCEPLIBS-g2tmpl](https://github.com/NOAA-EMC/NCEPLIBS-g2tmpl)
Expand All @@ -71,9 +77,9 @@ This package requires the following NCEPLIBS packages:
Also required to build NCEPpost executable (cmake option
BUILD_POSTEXEC):

- [NCEPLIBS-sigio](https://github.com/NOAA-EMC/NCEPLIBS-sigio) -
- [NCEPLIBS-sfcio](https://github.com/NOAA-EMC/NCEPLIBS-sfcio) -
- [NCEPLIBS-nemsio](https://github.com/NOAA-EMC/NCEPLIBS-nemsio) -
- [NCEPLIBS-sigio](https://github.com/NOAA-EMC/NCEPLIBS-sigio)
- [NCEPLIBS-sfcio](https://github.com/NOAA-EMC/NCEPLIBS-sfcio)
- [NCEPLIBS-nemsio](https://github.com/NOAA-EMC/NCEPLIBS-nemsio)
- [NCEPLIBS-gfsio](https://github.com/NOAA-EMC/NCEPLIBS-gfsio)

The [NCEPLIBS-wrf_io](https://github.com/NOAA-EMC/NCEPLIBS-wrf_io)
Expand All @@ -92,29 +98,18 @@ The following third-party libraries are required:

Builds include:

- Operational use GNC build as Wen described for both library and
executable (library used for GFS only at this time)

- MRW App uses UPP packaged with nceplibs and cmake to build/run with
executable (via release/public-v1 branch).

- SRW App uses UPP repo branch/tag directly and uses cmake to
build/run with executable (via release/public-v2 branch).

- Community standalone uses UPP repo branch/tag directly and uses
cmake to build/run with executable (via release/public-v2
branch). For these procedures, we add a
-DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} where INSTALL_PREFIX is the
location of the nceplibs installation as a dependency requirement.

```
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install
(or cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install -DEMC_EXEC_DIR=ON)
make -j 4
make install
```
- Inline post (UPP library): Currently only supported for the GFS, RRFS,
HAFS, and the UFS-MRW Application.

- Offline post (UPP executable): Supported for Regional applications
including SRW, RRFS, HAFS, and standalone applications of UPP.


CMake is used to manage all builds of the UPP.
The script `UPP/tests/compile_upp.sh` can be used to automatically
build UPP on fully supported platforms where HPC-stack is supported.
Details in this script can be used to build on new platforms.


## Disclaimer

Expand Down