Add time average manual pages

underwoo · underwoo · commit d9e2db81dd14 · 2024-11-28T16:13:04.000-05:00
Correct authorship for some files in the man pages, change bug report address to GitHub issue URL, and add copyright year
diff --git a/configure.ac b/configure.ac
@@ -33,9 +33,12 @@ m4_define([git_revision],
 AC_REVISION([git_revision])
 m4_define([git_hashval],
   [m4_esyscmd_s([git rev-parse HEAD 2> /dev/null || echo "unknown githash"])])
+AC_REVISION([git_hashval])
 m4_define([git_date],
   [m4_esyscmd_s([git show --no-patch --format=%as HEAD 2> /dev/null || date +%Y-%m-%d])])
 AC_REVISION([git_date])
+m4_define([copyright_year],
+  [m4_substr(git_date, 0, 4)])
 
 AC_CONFIG_SRCDIR([src/land_utils/combine-ncc.F90])
 AC_CONFIG_MACRO_DIR([m4])
@@ -201,14 +204,20 @@ AS_IF([test $ac_cv_type_long_double_wider = no],
 AM_CONDITIONAL([HAVE_TEST25_INPUT], [test -e ${srcdir}/t/Test25-input/grid_spec.nc])
 
 # Set macros
+AS_VAR_SET([GIT_REVISION], ["git_revision"])dnl
 AC_DEFINE([GIT_REVISION], ["git_revision"],
           [Holds the 'git describe' information if configure ran within a git working directory])dnl
+AC_SUBST(GIT_REVISION)dnl
+AS_VAR_SET([GIT_HEADHASH], ["git_hashval"])dnl
 AC_DEFINE([GIT_HEADHASH], ["git_hashval"],
           [Holds the 'git rev-parse HEAD' information if configure ran within a git working directory])dnl
-AC_DEFINE([COPYRIGHT_YEAR], ["m4_substr(git_date, 0, 4)"],
+AC_SUBST(GIT_HEADHASH)dnl
+AS_VAR_SET([COPYRIGHT_YEAR], ["copyright_year"])dnl
+AC_DEFINE([COPYRIGHT_YEAR], ["copyright_year"],
           [Year to place in Copyright notices printed with --version information])dnl
+AC_SUBST(COPYRIGHT_YEAR)dnl
 
-#Code for setting rpath based ncview's configure.in code.
+# Code for setting rpath based ncview's configure.in code.
 AS_IF([test x$ac_compiler_gnu = xyes], [RPATH_FLAGS=""
   for word in $NETCDF_LDFLAGS $NETCDF_FCLDFLAGS
   do
diff --git a/man/Makefile.am b/man/Makefile.am
@@ -26,8 +26,12 @@ EXTRA_DIST = \
   list_ncvars.txt \
   list_ncvars.csh.txt \
   mppnccombine.txt \
+  plevel_interp.txt \
   plevel.sh.txt \
   scatter-ncc.txt \
+  timavg.txt \
+  timavg.csh.1 \
+  time_average.txt \
   asciidoc.conf
 
 # Documentation settings
@@ -45,9 +49,14 @@ man_MANS += \
   is-compressed.1 \
   list_ncvars.1 \
   list_ncvars.csh.1 \
+  plevel_interp.1 \
   plevel.sh.1 \
   mppnccombine.1 \
-  scatter-ncc.1
+  scatter-ncc.1 \
+  timavg.1 \
+  timavg.csh.1 \
+  time_average.1
+
 endif
 
 .txt.1:
@@ -56,6 +65,8 @@ endif
           -d manpage \
           -f manpage \
           -afre_version=$(PACKAGE_VERSION) \
+          -apackage_bugreport=$(PACKAGE_BUGREPORT) \
+          -acopyright_year=$(COPYRIGHT_YEAR) \
           --asciidoc-opts="-f $(ASCIIDOC_CFG)" \
           $<
 
diff --git a/man/combine-ncc.txt b/man/combine-ncc.txt
@@ -43,15 +43,15 @@ https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/build/ch08s02.h
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
 Sergey Malyshev
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2009-2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/combine_restarts.txt b/man/combine_restarts.txt
@@ -44,16 +44,15 @@ SEE ALSO
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
-Designed and written by
-Seth Underwood.
+Seth Underwood
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2015, 2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/decompress-ncc.txt b/man/decompress-ncc.txt
@@ -46,15 +46,15 @@ https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/build/ch08s02.h
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
 Sergey Malyshev
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2009-2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/iceberg_comb.sh.txt b/man/iceberg_comb.sh.txt
@@ -40,17 +40,15 @@ SEE ALSO
 
 BUGS
 ----
-Send bug reports to GFDL's Helpdesk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
-Designed and written by
-Niki Zadeh and
-Seth Underwood.
+Niki Zadeh and Seth Underwood
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2015,2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/is-compressed.txt b/man/is-compressed.txt
@@ -35,15 +35,15 @@ https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/build/ch08s02.h
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
 Sergey Malyshev
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2009-2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/list_ncvars.csh.txt b/man/list_ncvars.csh.txt
@@ -59,15 +59,15 @@ SEE ALSO
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
 Aleksey Yakovelv
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2009, 2017, 2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/list_ncvars.txt b/man/list_ncvars.txt
@@ -77,15 +77,15 @@ SEE ALSO
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
-Aleksey Yakovelv
+Bruce Wyman
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2009, 2017, 2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/mppnccombine.txt b/man/mppnccombine.txt
@@ -97,15 +97,15 @@ a different blocking factor, simply multiply the estimate by k.
 
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
 
 AUTHORS
 -------
 Hans Vahlenkamp
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2008-2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/plevel.sh.txt b/man/plevel.sh.txt
@@ -72,13 +72,21 @@ list entries included any fields in the input files, and additional
 fields: slp, hght. Requesting slp or hght may require additional input
 fields to be available in the input file.
 
+SEE ALSO
+--------
+*plevel_interp*(1)
+
 BUGS
 ----
-Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
+Open bug reports at {package_bugreport}.
+
+AUTHORS
+-------
+Aleksey Yakovelv and Seth Underwood
 
 COPYRIGHT AND LICENSE
 ---------------------
-Copyright 2009, 2017, 2024 Geophysical Fluid Dynamics Laboratory
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
 
 The Flexible Modeling System (FMS) is free software; you can
 redistribute it and/or modify it and are expected to follow the terms
diff --git a/man/plevel_interp.txt b/man/plevel_interp.txt
@@ -0,0 +1,145 @@
+plevel_interp(1)
+================
+
+NAME
+----
+
+plevel_interp - Interpolates data from model levels to pressure level
+
+SYNOPSIS
+--------
+[verse]
+plevel_interp
+
+DESCRIPTION
+-----------
+
+plevel_interp reads a NetCDF file and interpolates data from model levels to
+pressure levels. The input model grid is a hybrid sigma-pressure coordinate and
+the output pressure levels may be specified. The minimum required input fields
+are _bk_, _pk_, and _ps_.
+
+This program also reads in a required namelist file, _plev.input.nml_, which
+must have at least an _input_ namelist, which will specify the input file name,
+the output file name, the output pressure levels, and the names of the fields to
+be interpolated.  The input and output files must be specified.  The namelist
+_input_ variables are:
+
+NAMELISTS
+---------
+
+The _input_ namelist contains the following variables:
+
+*character(len=256)* :: _in_file_name_::
+Input NetCDF file.
+
+*character(len=256)* :: _out_file_name_::
+Output NetCDF file.
+
+*character(len=NF90_MAX_NAME), dimension(MAX_FIELD_NAMES)* :: _field_names_::
+Names of (additional) fields to be interpolated.  If do_all_fields and
+do_all_3d_fields are false, then these fields must be present.
+
+*real, dimension(MAX_PLEVS)* :: _pout_::
+Output pressure levels in pascals.
+
+*logical* :: _do_all_fields_ = .false.::
+If .true., interpolate all fields in the input file.
+
+*logical* :: _do_all_3d_fields_ = .false.::
+If .true., interpolate all 3D fields in the input file.
+
+*logical* :: _mask_extrap_ = .false.::
+If .true., set points below the bottom level to the missing value
+
+*integer* :: _time_beg_ = 1::
+Starting time index.
+
+*integer* :: _time_end_ = 0::
+Ending time index.  If 0, use the last time index.
+
+*integer* :: _time_inc_ = 1::
+Time index increment.
+
+*logical* :: _allow_zero_topog_ = .false.::
+If .true., allow zero topography.
+
+*logical* :: _allow_zero_sphum_ = .false.::
+If .true., allow zero specific humidity.
+
+*logical* :: _use_default_missing_value_ = .false.::
+If .true., use the NetCDF default for missing/fill value
+
+*integer* :: _verbose_ = 1::
+Verbose level.  The higher the number, the more output. Useful for debugging.
+
+*integer* :: _user_deflation_ = -1::
+Deflation level for new variables. -1 means use input file settings.
+
+*integer* :: _user_shuffle_ = -1::
+Shuffle setting for new variables. -1 means use input file settings.
+
+*character(len=4096)* :: _command_line_::
+This program is typically called using the plevel.sh script. This variable will
+hold the string used to launch this program, which is added to the history
+attibute of the written NetCDF file.  If this variable is empty, then the
+namelist options with their values will be added to the history attribte.
+
+The namelist _names_ variables are:
+
+*character(len=NF90_MAX_NAME)* :: _temp_name_ = 'temp'::
+Name of the temperature varuable.
+
+*character(len=NF90_MAX_NAME)* :: _sphum_name_ = 'sphum'::
+Name of the specific humidity variable.
+
+*character(len=NF90_MAX_NAME)* :: _hght_name_ = 'hght'::
+Name of the height variable.
+
+*character(len=NF90_MAX_NAME)* :: _slp_name_ = 'slp'::
+Name of the surface level pressure variable.
+
+*character(len=NF90_MAX_NAME)* :: _ps_name_ = 'ps'::
+Name of the pressure variable.
+
+*character(len=NF90_MAX_NAME)* :: _zsurf_name_ = 'zsurf'::
+Name of the absolute surface elevation variable.
+
+*character(len=NF90_MAX_NAME)* :: _bk_name_ = 'bk'::
+Name of the bk variable.
+
+*character(len=NF90_MAX_NAME)* :: _pk_name_ = 'pk'::
+name of the pk variable.
+
+FILES
+-----
+
+_plev.input.nml_::
+File that contains the _input_ and optional _names_ Fortran namelists.
+
+SEE ALSO
+--------
+*plevel*(1), *netcdf*(3)
+
+BUGS
+----
+Open bug reports at {package_bugreport}.
+
+AUTHORS
+-------
+Bruce Wyman
+
+COPYRIGHT AND LICENSE
+---------------------
+Copyright {copyright_year} Geophysical Fluid Dynamics Laboratory
+
+The Flexible Modeling System (FMS) is free software; you can
+redistribute it and/or modify it and are expected to follow the terms
+of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any
+later version.
+
+FMS is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
diff --git a/man/scatter-ncc.txt b/man/scatter-ncc.txt
diff --git a/man/timavg.txt b/man/timavg.txt
diff --git a/man/time_average.txt b/man/time_average.txt
