Create Release Version 1.4.0 (#533)

Update the VERSION file and the documentation. Rebuild the doxygen and update the gh-pages branch. Fixes #532 Fixes #521 Part of #103
ufs-community · Jun 4, 2021 · 2bbbb72 · 2bbbb72
1 parent f09acb9
commit 2bbbb72
Show file tree

Hide file tree

Showing 7 changed files with 695 additions and 148 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 Utilities for the NCEP models. This is part of the
 [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) project.
 
-Documentation for the chgres_cube utility can be found at
+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
@@ -17,6 +17,7 @@ Utility | Programmer(s)
 chgres_cube | George Gayno, Jeff Beck, Larissa Reames
 emcsfc_ice_blend | George Gayno
 emcsfc_snow2mdl | George Gayno
+fre-nctools | GFDL progammer
 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).
@@ -28,7 +29,7 @@ UFS_UTILS Code managers: George Gayno, Kyle Gerheiser
 
 ## Prerequisites
 
-This package requires the following NCEPLIBS packages:
+This package uses the [hpc-stack](https://github.com/NOAA-EMC/hpc-stack) for the following NCEPLIBS packages:
  - [NCEPLIBS-sfcio](https://github.com/NOAA-EMC/NCEPLIBS-sfcio)
  - [NCEPLIBS-w3nco](https://github.com/NOAA-EMC/NCEPLIBS-w3nco)
  - [NCEPLIBS-bacio](https://github.com/NOAA-EMC/NCEPLIBS-bacio)
@@ -39,13 +40,15 @@ This package requires the following NCEPLIBS packages:
  - [NCEPLIBS-g2](https://github.com/NOAA-EMC/NCEPLIBS-g2)
  - [NCEPLIBS-wgrib2](https://github.com/NOAA-EMC/NCEPLIBS-wgrib2)
 
-This package also requires:
+And for the following third party libraries:
 
  - [netcdf-c Library](https://github.com/Unidata/netcdf-c)
  - [netcdf-fortran Library](https://github.com/Unidata/netcdf-fortran)
  - [ESMF](https://github.com/esmf-org/esmf)
  - [Jasper](https://github.com/jasper-software/jasper)
-
+ - [Zlib](www.zlib.net)
+ - [HDF5](https://www.hdfgroup.org/solutions/hdf5/)
+ - [PNG](http://www.libpng.org/pub/png/)
 
 ## Installing
 
@@ -101,6 +104,9 @@ 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:

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.3.0
+1.4.0
diff --git a/docs/source/_static/supergrid.png b/docs/source/_static/supergrid.png
diff --git a/docs/source/chgres_cube.rst b/docs/source/chgres_cube.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,7 +19,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'chgres'
+project = 'ufs_utils'
 copyright = '2020 '
 author = 'George Gayno and others'
 
@@ -104,7 +104,7 @@
 html_static_path = ['_static']
 
 def setup(app):
-    app.add_stylesheet('custom.css')  # may also be an URL
+    app.add_css_file('custom.css')  # may also be an URL
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -120,7 +120,7 @@ def setup(app):
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'chgres'
+htmlhelp_basename = 'ufs_utils'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -149,7 +149,7 @@ def setup(app):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'chgres.tex', 'chgres Documentation',
+    (master_doc, 'ufs_utils.tex', 'ufs_utils Documentation',
      author,'manual'),
 ]
 
@@ -159,7 +159,7 @@ def setup(app):
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'chgres', 'chgres Documentation',
+    (master_doc, 'ufs_utils', 'ufs_utils Documentation',
      [author], 1)
 ]
 
@@ -170,8 +170,8 @@ def setup(app):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'chgres', 'chgres Documentation',
-     'author, chgres', 'One line description of project.',
+    (master_doc, 'ufs_utils', 'ufs_utils Documentation',
+     'author, ufs_utils', 'One line description of project.',
      'Miscellaneous'),
 ]
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,13 +1,13 @@
-.. chgres_cube documentation master file, created by
+.. ufs_utils documentation master file, created by
    sphinx-quickstart on Tue Feb 12 08:48:32 2019.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-chgres_cube Documentation
+UFS_UTILS Documentation
 ============================
 
 .. toctree::
    :numbered:
    :maxdepth: 3
 
-   chgres_cube
+   ufs_utils