diff --git a/CHANGELOG.md b/CHANGELOG.md index 7439861b..44b9ec5c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - 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 @@ -30,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - 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 diff --git a/docs/source/hco-ref-guide/hemco-config.rst b/docs/source/hco-ref-guide/hemco-config.rst index 338499d7..f3451716 100644 --- 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 ` 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. |