Merge branch 'develop' into feature/sfcsub_ccpp

Fixes ufs-community#424
GeorgeGayno-NOAA · Apr 1, 2021 · 79040d1 · 79040d1
2 parents c569e1f + 7466d6a
commit 79040d1
Show file tree

Hide file tree

Showing 15 changed files with 323 additions and 299 deletions.
diff --git a/README.md b/README.md
@@ -17,12 +17,12 @@ Utility | Programmer(s)
 chgres_cube | George Gayno, Jeff Beck, Larissa Reames
 emcsfc_ice_blend | George Gayno
 emcsfc_snow2mdl | George Gayno
-fvcom_tools | David Wright, University of Michigan
-global_cycle | George Gayno, Shrinivas Moorthi
-grid_tools | R. J. Purser (regional_esg_grid), Tom Black/Ben Blake (shave.fd), Gerard Ketefian (global_equiv_resol), GFDL programmer (topo filtering code).
+fvcom_tools | David Wright, University of Michigan, Ming Hu, GSD/AMB
+global_cycle | George Gayno, Shrinivas Moorthi, Mark Iredell, Xu Li, Hang Lei
+grid_tools | R. J. Purser (regional_esg_grid), Tom Black/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
+vcoord_gen | Fanglin Yang, Mark Iredell
 
 UFS_UTILS Code managers: George Gayno, Kyle Gerheiser
 

diff --git a/sorc/chgres_cube.fd/docs/user_guide.md b/sorc/chgres_cube.fd/docs/user_guide.md
@@ -2,18 +2,18 @@
 
 # Introduction
 
-The chgres_cube program creates initial condition files to “coldstart”
+The program chgres.F90 creates initial condition files to “coldstart”
 the forecast model. The initial conditions are created from either
 Global Forecast System (GFS) gridded binary version 2 (GRIB2), NOAA
 Environmental Modeling System Input/Output (NEMSIO) data, or Network
 Common Data Form (NetCDF) data.
 
-This is part of the [NCEPLIBS
-UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
-
-This user guide is part of the <a href="../index.html">UFS_UTILS
+This document is part of the <a href="../index.html">UFS_UTILS
 documentation</a>.
 
+The chgres_cube program is part of the [NCEPLIBS
+UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
+
 ## Where to find GFS GRIB2, NEMSIO and NetCDF data
 
 ### GRIB2

diff --git a/sorc/emcsfc_ice_blend.fd/docs/user_guide.md b/sorc/emcsfc_ice_blend.fd/docs/user_guide.md
@@ -3,15 +3,16 @@
 
 # Introduction
 
-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.
+The emcsfc_ice_blend.f90 program 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.
 
-This is part of the [NCEPLIBS
+This document is part of the <a href="../index.html">UFS_UTILS
+documentation</a>.
+
+The emcsfc_ice_blend program is part of the [NCEPLIBS
 UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
 
-This is part of the <a href="../index.html">UFS_UTILS documentation</a>.
 
-The emcsfc_ice_blend code can be found here:
-https://github.com/NOAA-EMC/UFS_UTILS/tree/develop/sorc/emcsfc_ice_blend.fd.
+
 
diff --git a/sorc/emcsfc_snow2mdl.fd/docs/user_guide.md b/sorc/emcsfc_snow2mdl.fd/docs/user_guide.md
@@ -3,15 +3,14 @@
 
 # Introduction
 
-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.
+The emcsfc_snow2mdl program (driver.F90) 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.
 
-This is part of the [NCEPLIBS
-UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
+This document is part of the <a href="../index.html">UFS_UTILS
+documentation</a>.
 
-This is part of the <a href="../index.html">UFS_UTILS documentation</a>.
+The emcsfc_snow2mdl program is part of the [NCEPLIBS
+UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
 
-The emcsfc_snow2mdl code can be found here:
-https://github.com/NOAA-EMC/UFS_UTILS/tree/develop/sorc/emcsfc_snow2mdl.fd.
 
diff --git a/sorc/emcsfc_snow2mdl.fd/driver.F90 b/sorc/emcsfc_snow2mdl.fd/driver.F90
@@ -6,20 +6,6 @@
 !! or global gfs gaussian grid using nesdis/ims snow cover, autosnow snow
 !! cover and/or afwa depth data.
 !!      
-!! Program History Log
-!! -  2005-dec-16  gayno     initial version
-!! -  2007-nov-30  gayno     added processing of nam b-grids.
-!!                          improved thinning for gfs grids.
-!! -  2008-feb-01  gayno     added option to use autosnow data
-!!                          in southern hemisphere.
-!! -  2014-feb-14  gayno     read grib 1 or grib2 version of nesdis/ims
-!!                          data
-!! -  2014-sep-30  gayno     read grib 1 or grib2 version of model
-!!                          lat, lon and mask files.  convert
-!!                          nh weekly snow climatology to grib 2.
-!!                          option to output model depth and cover 
-!!                          analysis in grib2.
-!!
 !! The ims snow cover product is now produced by the national
 !! ice center, not nesdis.  however, in this code, references
 !! to ims still use the "nesdis" identifier.
@@ -139,6 +125,20 @@
 !!      defined threshold, the depth is set to 0,
 !!      regardless of the afwa depth value.
 !!
+!! Program History Log
+!! -  2005-dec-16  gayno     initial version
+!! -  2007-nov-30  gayno     added processing of nam b-grids.
+!!                          improved thinning for gfs grids.
+!! -  2008-feb-01  gayno     added option to use autosnow data
+!!                          in southern hemisphere.
+!! -  2014-feb-14  gayno     read grib 1 or grib2 version of nesdis/ims
+!!                          data
+!! -  2014-sep-30  gayno     read grib 1 or grib2 version of model
+!!                          lat, lon and mask files.  convert
+!!                          nh weekly snow climatology to grib 2.
+!!                          option to output model depth and cover 
+!!                          analysis in grib2.
+!!
 !! @return 0 for success, error code otherwise.      
 !! @author gayno @date 2005-dec-16
  program driver

diff --git a/sorc/fvcom_tools.fd/docs/user_guide.md b/sorc/fvcom_tools.fd/docs/user_guide.md
@@ -3,16 +3,16 @@
 
 # Introduction
 
-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. See [fvcom
-documentation](@ref fvcom_readme).
+The process_FVCOM.f90 program 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. See [fvcom documentation](@ref fvcom_readme).
 
-This is part of the [NCEPLIBS
+This document is part of the <a href="../index.html">UFS_UTILS
+documentation</a>.
+
+The fvcom_tools program is part of the [NCEPLIBS
 UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
 
-This is part of the <a href="../index.html">UFS_UTILS documentation</a>.
 
-The fvcom_tools code can be found here:
-https://github.com/NOAA-EMC/UFS_UTILS/tree/develop/sorc/fvcom_tools.fd.
 
diff --git a/sorc/global_cycle.fd/docs/user_guide.md b/sorc/global_cycle.fd/docs/user_guide.md
@@ -3,16 +3,13 @@
 
 # Introduction
 
-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.
+The program cycle.f90 updates the GFS surface conditions using
+external snow and sea ice analyses. It updates monthly climatological
+fields such as plant greenness fraction and albedo. It runs as part of
+the GFS and GDAS cycles.
 
-This is part of the [NCEPLIBS
-UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
-
-This is part of the <a href="../index.html">UFS_UTILS documentation</a>.
-
-The global_cycle code can be found here:
-https://github.com/NOAA-EMC/UFS_UTILS/tree/develop/sorc/global_cycle.fd.
+This document is part of the <a href="../index.html">UFS_UTILS
+documentation</a>.
 
+The global_cycle program is part of the [NCEPLIBS
+UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
diff --git a/sorc/grid_tools.fd/docs/user_guide.md b/sorc/grid_tools.fd/docs/user_guide.md
@@ -3,15 +3,19 @@
 
 # Introduction
 
-Utilities to filter topography, to create regional extended Schmidt
-gnomonic grids, and to compute the equivalent global resolution of a
-regional grid.
+The grid_tools include:
+* filter_topo.F90 - filter topography
+* global_equiv_resol.f90 - compute the equivalent global resolution of
+  a regional grid
+* regional_esg_grid.f90 - create regional extended Schmidt gnomonic
+  grids
+* shave_nc.F90 - shave down domains of FV3 files
 
-This is part of the [NCEPLIBS
+This document is part of the <a href="../index.html">UFS_UTILS
+documentation</a>.
+
+The grid_tools programs are part of the [NCEPLIBS
 UFS_UTILS](https://github.com/NOAA-EMC/UFS_UTILS) project.
 
-This is part of the <a href="../index.html">UFS_UTILS documentation</a>.
 
-The grid_tools code can be found here:
-https://github.com/NOAA-EMC/UFS_UTILS/tree/develop/sorc/grid_tools.fd.
 
diff --git a/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 b/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90
@@ -1,6 +1,6 @@
 !> @file
 !! @brief This program does ???
-!! @author R. J. Purser
+!! @author GFDL Programmer
 
 !> This program does ???
 !!