HEMCO 3.7.1 release

This merge brings the HEMCO 3.7.1 development stream into the main branch. Please see https://hemco.readthedocs.io for more information about this version. Signed-off-by: Bob Yantosca <[email protected]>
geoschem · Oct 10, 2023 · ac46ac5 · ac46ac5
2 parents d870f32 + 30be8c7
commit ac46ac5
Show file tree

Hide file tree

Showing 29 changed files with 2,580 additions and 3,190 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased 3.7.1] - TBD
+### Changed
+- Updated version numbers to 3.7.1
+- Make Hg0 emission factors in `hcox_gfed_include_gfed4.H` multipliers  of the CO emission factor
+- Removed superfluous routine `GetExtSpcVal_Dr` in `src/Core/hco_extlist_mod.F90`
+- NetCDF routines in `src/Shared/NcdfUtil` now use the Fortran-90 API
+- Overhauled vertical regridding `src/Core/hco_interp_mod.F90`
+    - Removed `INFLATE` (but retained its behavior only for 47L -> 72L vertical regridding, warning users that this isn't recommended)
+    - `ModelLev_Interpolate` is only called when the input is 47/48, 72/73, or 102/103 levels (otherwise, MESSy is used).
+    - A bug that averaged the wrong number of levels in `COLLAPSE` is fixed (and edges are now sampled instead of averaged).
+    - Removed the now superfluous `NC_ISMODELLEVEL` and `NC_SISIGMALEVEL` from `src/Shared/NcdfUtil/hco_ncdf_mod.F90`
+    - Removed old code and references to `GEOS-4`.
+
+### Fixed
+- Fixed incorrect `XMIN`, `XMAX` values in  `HEMCO_sa_Grid.025x03125.rc` and `HEMCO_sa_Grid.05x0625.rc`
+- Fixed line length too long for the `GC_72_EDGE_SIGMA` variable in `src/Core/hcoio_read_std_mod.F90`
+
 ## [3.7.0] - 2023-10-05
 ### Added
 - HEMCO extensions now display a first-time message, whether `Verbose` is `true` or `false`.

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,7 +1,7 @@
 # HEMCO/CMakeLists.txt
 
 cmake_minimum_required(VERSION 3.5)
-project(HEMCO VERSION 3.7.0 LANGUAGES Fortran)
+project(HEMCO VERSION 3.7.1 LANGUAGES Fortran)
 # Reminder: Make sure to also update version in src/Core/hco_error_mod.F90
 
 #-----------------------------------------------------------------------------

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,7 +23,7 @@
 author = 'GEOS-Chem Support Team'
 
 # The full version, including alpha/beta/rc tags
-release = '3.7.0'
+release = '3.7.1'
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/docs/source/geos-chem-shared-docs b/docs/source/geos-chem-shared-docs
diff --git a/docs/source/hco-ref-guide/hemco-config.rst b/docs/source/hco-ref-guide/hemco-config.rst
@@ -35,7 +35,21 @@ comment lines:
    ### BEGIN SECTION SETTINGS
    ###############################################################################
 
-   settings go here
+   ROOT:                        /path/to/hemco/data/dir
+   METDIR:                      /path/to/hemco/met/dir
+   GCAPSCENARIO:                not_used
+   GCAPVERTRES:                 47
+   Logfile:                     *
+   DiagnFile:                   HEMCO_Diagn.rc
+   DiagnPrefix:                 ./OutputDir/HEMCO_diagnostics
+   DiagnFreq:                   00000000 010000
+   Wildcard:                    *
+   Separator:                   /
+   Unit tolerance:              1
+   Negative values:             0
+   Only unitless scale factors: false
+   Verbose:                     false
+   VerboseOnCores:              root       # Accepted values: root all
 
    ### END SECTION SETTINGS ###
 
@@ -60,6 +74,18 @@ These settings control HEMCO simulation options.
    Root folder of meteorology data files that are needed for HEMCO
    extensions.  Usually this is a subdirectory of :option:`ROOT`.
 
+.. option:: GCAPSCENARIO:
+
+   Specifies the future scenario when using GCAP meteorology.
+
+   Default value: :literal:`not used`
+
+.. option:: GCAPVERTRES
+
+   Specifies the number of vertical levels for GCAP meteorology.
+
+   Default value: :literal:`47`
+
 .. option:: MODEL
 
    If present, the :literal:`$MODEL` token will be set to the
@@ -118,20 +144,20 @@ These settings control HEMCO simulation options.
 
 .. option:: Verbose
 
-   Integer value that controls the amount of additional information
-   printed to the HEMCO log file.  Allowable values are :literal:`0`
-   (no additional output) to :literal:`3` (lots of additional output).
-   Setting  :literal:`3` is useful for debugging.
+   Activates (:literal:`true`) or deactivates (:literal:`false`)
+   additional printout for debugging purposes.
 
-   **Default setting**: :literal:`0`.
+   **Default setting**: :literal:`false`
 
-.. option:: Warnings
+.. option:: VerboseOnCores
 
-   Integer value that controls the amount of warnings printed
-   to the HEMCO log file.  Allowable values are :literal:`0` (no
-   warnings) to :literal:`3` (all warnings).
+   Specifies whether :option:`Verbose` printout will be restricted to
+   the :literal:`root` core, or will be printed on :literal:`all`
+   cores.  This facilitates running HEMCO in Earth System Models,
+   where the additional overhead of printing verbose output on every
+   core could negatively impact performance.
 
-   **Default setting**: :literal:`1` (only severe warnings).
+   **Default setting:** :literal:`root`
 
 .. option:: Wildcard