Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
8 changes: 4 additions & 4 deletions docs/AddNewVariable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ requires good knowledge of Fortran and thorough understanding of the code.

NOAA UPP developers who wish to add new variables to the UPP, please follow the following procedures:

1. Read and follow procedures on the `UPP wiki page <https://github.com/NOAA-EMC/EMC_post/wiki/UPP-Code-Development>`_
1. Read and follow procedures on the `UPP wiki page <https://github.com/NOAA-EMC/UPP/wiki/UPP-Code-Development>`_
on how to contribute your code changes to the UPP main development. Doing so will ensure your changes are merged
to the UPP development quickly.

Expand Down Expand Up @@ -122,7 +122,7 @@ with examples in the sections below.
and directly output into the Grib2 output files (i.e. in this case no additional computations/calculations
are needed for the field).
- Additions to each of the routines are highlighted.
- Locations of routines are in EMC_post/sorc/ncep_post.fd unless specified otherwise.
- Locations of routines are in UPP/sorc/ncep_post.fd unless specified otherwise.
- The new variable, TG3, added in this example is found in the gfs.t00z.sfcf006.nc; however, both the
gfs.t00z.sfcf006.nc and gfs.t00z.atmf006.nc output files are required to run UPP for GFS.
- TG3 is the averaged climatology of surface temperature, which the LSMs use to specify bottom soil T,
Expand Down Expand Up @@ -177,7 +177,7 @@ with examples in the sections below.

2 0 231 1 TG3

e) Add the new variable to the EMC_post/parm/post_avblflds.xml, which lists all fields available
e) Add the new variable to the UPP/parm/post_avblflds.xml, which lists all fields available
for output in GRIB2 format. This file is generally not modified unless adding a new field or
modifying an existing one.
- Post_avblfldidx: the unique array number given in the RQSTFLD.f routine.
Expand Down Expand Up @@ -371,7 +371,7 @@ with examples in the sections below.

::

>> cd EMC_post/build
>> cd UPP/build
>> make install

Assuming the modified code built successfully and you were able to produce Grib2 output, you can check the Grib2
Expand Down
15 changes: 7 additions & 8 deletions docs/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,21 @@ Building and running UPP V9.0.0 has been tested on the following platforms using
+---------------+----------------------+

Move to the directory where you want to clone and build UPP and clone the repository into the directory
EMC_post.
UPP.

.. code-block:: console

git clone -b release-tag-name --recurse-submodules https://github.com/NOAA-EMC/EMC_post
git clone -b branch-or-tag-name https://github.com/NOAA-EMC/UPP

where, ``release-tag-name`` is the release tag you wish to clone (e.g. for stand-alone UPP version 9, use
the release tag :bolditalic:`upp_v9.0.0`).
where, ``branch-or-tag-name`` is the release branch or tag you wish to clone.

Move into the top level UPP directory and create and move into the build directory. Then build the UPP code
using the cmake utility.
The path ``INSTALL_PREFIX`` should point to the location of the pre-installed NCEP libraries.

.. code-block:: console

cd EMC_post
cd UPP
mkdir build && cd build

cmake .. -DCMAKE_INSTALL_PREFIX=.. -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX}
Expand All @@ -76,14 +75,14 @@ The path ``INSTALL_PREFIX`` should point to the location of the pre-installed NC

Move back to the top level UPP directory and create a directory for the CRTM fix files to be unpacked
in. Download the fix files from the Github `release page
<https://github.com/NOAA-EMC/EMC_post/releases/tag/upp_v9.0.0>`_ or use the wget command. Unpack the
<https://github.com/NOAA-EMC/UPP/releases/tag/upp_v9.0.0>`_ or use the wget command. Unpack the
tar file.

.. code-block:: console

cd ../
mkdir crtm && cd crtm
wget https://github.com/NOAA-EMC/EMC_post/releases/download/upp_v9.0.0/fix.tar.gz
wget https://github.com/NOAA-EMC/UPP/releases/download/upp_v9.0.0/fix.tar.gz
tar -xzf fix.tar.gz

.. note::
Expand All @@ -96,7 +95,7 @@ tar file.
UPP Directory Structure
=======================

Under the main directory **EMC_post** reside the following relevant subdirectories (The * indicates a
Under the main directory **UPP** reside the following relevant subdirectories (The * indicates a
directory that exists only after the build is complete):

| **bin***: Contains the :bolditalic:`upp.x` executable after successful compilation
Expand Down
6 changes: 3 additions & 3 deletions docs/Running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ A script for running the UPP package is included in the **/scripts** directory:

mkdir parm

4. Optional: If desired, edit the control **XML** file(s) in **/EMC_post/parm** to reflect the fields
4. Optional: If desired, edit the control **XML** file(s) in **/UPP/parm** to reflect the fields
and levels you want UPP to output. It is recommended that you make copies of the original
beforehand.

Expand Down Expand Up @@ -64,8 +64,8 @@ Run Script Overview

| **TOP_DIR**: Top level directory for building and running UPP
| **DOMAINPATH**: Working directory for this run
| **UNIPOST_HOME**: Location of the **EMC_post** directory
| **POSTEXEC**: Location of the **EMC_post** executable
| **UNIPOST_HOME**: Location of the **UPP** directory
| **POSTEXEC**: Location of the **UPP** executable
| **modelDataPath**: Location of the model output data files to be processed
| **txtCntrlFile**: Name and location of the flat text file that lists desired fields for
output.
Expand Down