Starting to list utilities in user_guide.md

build_all.sh

@@ -1,4 +1,11 @@
 #! /usr/bin/env bash
+#
+# This build script is only used on NOAA WCOSS systems. All other
+# users should set module files as needed, and build directly with
+# CMake.
+#
+# George Gayno
+
 set -eux
 
 target=${target:-"NULL"}

docs/user_guide.md

@@ -1,9 +1,52 @@
 @mainpage
 
-## UFS_UTILS
+# UFS_UTILS
 
 Utilities for the NCEP models. This is part of the
 [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) project.
 
-The UFS_UTILS code here: https://github.com/NOAA-EMC/UFS_UTILS.
+The UFS_UTILS code can be found here:
+https://github.com/NOAA-EMC/UFS_UTILS.
+
+## The Utilities
+
+- chgres_cube - Creates cold start initial conditions for FV3 model
+  runs.
+
+- emcsfc_ice_blend - Blends National Ice Center sea ice cover and EMC
+  sea ice concentration data to create a global sea ice analysis used
+  to update the GFS once per day.
+
+- emcsfc_snow2mdl - Blends National Ice Center snow cover and Air
+  Force snow depth data to create a global depth analysis used to
+  update the GFS snow field once per day.
+
+- fre-nctools - Tools to remap data; and to create the geo-reference
+  fields (latitude, longitude, etc.) for an FV3 grid.
+
+- fvcom_tools - - Replaces lake surface and lake ice temperature along
+  with aerial ice concentration generated from the Great Lakes
+  Operational Forecast System (GLOFS) in an FV3 surface restart
+  file. [fvcom documentation](sorc/fvcom_tools.fd/fvcom_readme.md)
+
+- global_chgres - Creates cold start initial conditions for FV3 model
+  runs. Deprecated by the chgres_cube utility. [global_chgres
+  documentation](sorc/global_chgres.fd/global_chgres_users_guide.md)
+
+- global_cycle - Updates the GFS surface conditions using external
+  snow and sea ice analyses. Updates monthly climatological fields
+  such as plant greenness fraction and albedo. Runs as part of the GFS
+  and GDAS cycles.
+
+- grid_tools - Utilities to filter topography, to create regional
+  extended Schmidt gnomonic grids, and to compute the equivalent
+  global resolution of a regional grid.
+
+- nst_tf_chg
+
+- orog_mask_tools
+
+- sfc_climo_gen
+
+- vcoord_gen
 

sorc/chgres_cube.fd/CMakeLists.txt

@@ -1,3 +1,7 @@
+# This is the CMake build file for the chgres_cube utility in the UFS_UTILS package.
+#
+# George Gayno, Mark Potts
+
 set(fortran_src
     atmosphere.F90
     chgres.F90