UFS_UTILS

Utilities for the NCEP models. This is part of the Unified Forecast System project.

Documentation for chgres_cube and other utilities can be found at https://noaa-emcufs-utils.readthedocs.io/en/latest/.

Complete documentation can be found at https://ufs-community.github.io/UFS_UTILS/.

Authors

Utility	Programmer(s)
chgres_cube	George Gayno, Jeff Beck, Larissa Reames
cpld_gridgen	Denise Worthen
emcsfc_ice_blend	George Gayno
emcsfc_snow2mdl	George Gayno
fre-nctools	GFDL progammer
fvcom_tools	David Wright, University of Michigan, Ming Hu, GSD/AMB
gblevents	Hang Lei
gdas_init	George Gayno
global_cycle	George Gayno, Shrinivas Moorthi, Xu Li
grid_tools	R. J. Purser (regional_esg_grid), Ben Blake (shave.fd), Gerard Ketefian (global_equiv_resol), Tsukasa Fujita, JMA (pmat2), GFDL programmer (topo filtering code).
orog_mask_tools	Ning Wang, Jordan Alpert, Shan Sun and Ning Wang
sfc_climo_gen	George Gayno
vcoord_gen	Fanglin Yang
weight_gen	George Gayno

UFS_UTILS Code managers: George Gayno, Jeff Beck, Larissa Reames

Prerequisites

This package uses the hpc-stack for the following NCEPLIBS packages:

• NCEPLIBS-sfcio
• NCEPLIBS-w3emc
• NCEPLIBS-bacio
• NCEPLIBS-nemsio
• NCEPLIBS-sigio
• NCEPLIBS-sp
• NCEPLIBS-ip
• NCEPLIBS-g2

And for the following third party libraries:

• netcdf-c Library
• netcdf-fortran Library
• ESMF
• Jasper
• Zlib
• HDF5
• PNG

It also uses the following repositories:

• Common Community Physics Package

Installing

On Orion, Hercules, Jet, Hera, S4, Gaea and WCOSS2 do the following:

1. Set the 'fixed' directories using the link_fixdirs.sh script in ./fix. Usage: ./link_fixdirs.sh $RUN_ENVIR $machine, where $RUN_ENVIR is "emc" or "nco" (most developers should choose "emc") and $machine is the platform. Example:

./link_fixdirs.sh emc hera

2. Then, invoke the build script:

./build_all.sh

Contents

The sorc directory contains the source code.

The reg_tests directory contains the consistency test code.

The fix directory contains links to directories containing large, static data files used by UFS_UTILS programs.

The tests directory contains unit tests.

The ush directory contains scripts to run UFS_UTILS programs. Most are called from driver scripts.

The util directory contains utility scripts.

The parm directory contains parameter files used by the chgres_cube program.

The driver_scripts directory contains high-level driver scripts to create a model grid on officially supported HPC platforms.

The modulefiles directory contains modules loaded when building UFS_UTILS on supported HPC platforms. They are also loaded at runtime by utility and consistency test scripts.

The docs directory contains the control file for the doxygen documentation build, as well as some markdown files which are part of the documentation. It also contains (in the source subdirectory) the ReadTheDocs documentation files.

The cmake directory contains CMake package find utilities, and utilities to run units tests on some supported HPC platforms.

References

Gayno G., Beck J., Carson L., Pre-Processing: chgres_cube, UFS MRW App Training, 5 November 2020.

Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.