Merge branch 'geoschem:main' into ci

geoschem · Jan 28, 2025 · 2b22fd5 · 2b22fd5
2 parents 1fcf644 + 0ae25d2
commit 2b22fd5
Show file tree

Hide file tree

Showing 54 changed files with 1,119 additions and 1,310 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,34 @@ 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).
 
+## [3.10.1] - 2025-01-10
+### Added
+- Added optional LUN argument to ConfigInit to allow external models to pass LUN of existing log file
+- Added two log LUN variables (stdLogLUN and hcoLogLUN) to HcoState%Config for stdout and HEMCO log and initialize both in ConfigInit to stdout or optional LUN (if passed)
+- Added output argument LUN to HCO_LOGFILE_OPEN to update HcoState%Config%hcoLogLun to LUN of new log (if using)
+- Added optional LUN argument to HCO_MSG, HCO_WARNING, and HCO_ERROR to specify log to print to
+- Added special log handling for CESM to ignore LogFile entry in HEMCO_Config.rc (will get passed CAM log LUN to use instead)
+
+### Changed
+- Changed interfaces HCO_MSG, HCO_WARNING, and HCO_ERROR to each be a single subroutine that does not use HcoState%Config%Err
+- Changed HCO_MSG, HCO_WARNING, and HCO_ERROR to be independent of verbose and cores
+- Updated calls to HCO_MSG to send output to HcoState%Config%hcoLogLUN
+- Updated calls to HCO_WARNING to print to stdout unless related to units
+- Replaced usage of HCO_IsVerb with HcoState_Config%doVerbose
+- Changed documentation in HCO_Error_Mod.F90 to summarize error and log handling in HEMCO
+- Updated ReadTheDocs "Understand what error messages mean" supplemental guide
+
+### Fixed
+- Fixed excessive prints when using MPI
+- Fixed F77 formating in hcox_dustdead_mod.F
+
+### Removed
+- Removed warnings count in HcoState%Config%Err
+- Removed RC argument in HCO_WARNING
+- Deleted subroutine HCO_IsVerb
+- Remove print of HcoDiagn%MassScal since never set in the model
+- Added ReadTheDocs documentation for the HEMCO `LogFile` setting
+
 ## [3.10.0] - 2024-11-07
 ### Added
 - Added TSOIL1 field to `ExtState`

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.10.0 LANGUAGES Fortran)
+project(HEMCO VERSION 3.10.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.10.0'
+release = '3.10.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
@@ -292,10 +292,20 @@ description file.  This is usually named :file:`HEMCO_sa_Grid.rc`.
 LogFile
 -------
 
-Path and name of the output log file (which is typically named
-:file:`HEMCO.log`).  If set to the
-:ref:`hco-cfg-set-wildcard` character, all HEMCO
-output is written to **stdout** (i.e. the screen).
+Path and name of the output log file.
+
++------------------------------------+--------------------------------------------+
+| Value                              | What it does                               |
++====================================+============================================+
+| ``*``                              | HEMCO will write to stdout (screen output) |
++------------------------------------+--------------------------------------------+
+| A file path (e.g. ``./HEMCO.log``) | HEMCO will open and write to that file     |
++------------------------------------+--------------------------------------------+
+
+.. note::
+
+   If you are using HEMCO within CESM, then :literal:`LogFile` will be
+   ignored and HEMCO will write to the CAM log file :file:`atm.log`.
 
 .. _hco-cfg-set-mask-fractions:
 
@@ -416,7 +426,7 @@ the units set in the :ref:`HEMCO configuration file <hco-cfg>`
 and the netCDF :literal:`units` attribute found in the source file.
 
 +---------+-----------------------------------------------------------+
-| Setting | What it does                                              |
+| Value   | What it does                                              |
 +=========+===========================================================+
 | ``0``   | **No tolerance**.  A units mismatch will halt a HEMCO     |
 |         | simulation.                                               |
+270 −51		supplemental-guides/error-guide.rst
+497 −0		supplemental-guides/using-kpp-standalone.rst