Merge branch 'docs/dev' into dev/3.5.2

Signed-off-by: Melissa Sulprizio <[email protected]>

CHANGELOG.md

@@ -5,7 +5,7 @@ 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.5.2]
+## [3.5.2] - 2022-11-29
 ### Added
  - Added sanitizer option for detecting memory leaks in HEMCO
  standalone during build
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  - Replaced placeholder error messages in
  `src/Core/hco_config_mod.F90` with more informational messages
  (often including the line of the HEMCO_Config.rc in the printout)
+ - Added improved documentation for time cycle flag `EFYO` in ReadTheDocs
 
 ### Fixed
  - Removed memory leaks that were identified by the code sanitizer

CMakeLists.txt

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

docs/source/conf.py

@@ -23,7 +23,7 @@
 author = 'GEOS-Chem Support Team'
 
 # The full version, including alpha/beta/rc tags
-release = '3.5.0'
+release = '3.5.2'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/hco-ref-guide/hemco-config.rst

@@ -139,7 +139,7 @@ These settings control HEMCO simulation options.
 
 .. option:: Separator
 
- Separator symbol. On Unix/Linux systems, this should be set to
+ Separator symbol. On Unix/4Linux systems, this should be set to
  :literal:`/`.
 
 .. option:: Mask fractions
@@ -871,9 +871,9 @@ are:
 
  .. option:: EF
 
-  **Exact, Forced:** Same as :option:`E`, but HEMCO stops with an
-  error if no data field can be found for the current simulation
-  date and time.
+ **Exact, Forced:** Same as :option:`E`, but HEMCO stops with an
+ error if no data field can be found for the current simulation
+ date and time.
 
  .. option:: EC
 
@@ -883,10 +883,32 @@ are:
 
  **Exact, Read/Query Continuously, Forced.**
 
+ .. option:: EFYO
+
+ **Exact, Forced, Simulation Year, Once**: Same as :option:`EF`,
+ with the following additions:
+
+ - :envvar:`Y`: HEMCO will stop thie simulation if the simulation
+ year does not match the year in the file timestamp.
+ - :envvar:`O`: HEMCO will only read the file once.
+
+ This setting is typically only used for model restart files
+ (such as `GEOS-Chem Classic restart files
+ <https://geos-chem.readthedocs.io/en/stable/gcc-guide/04-data/restart-files-gc.html>`_).
+ This ensures that the simulation will stop unless the restart
+ file timestamp matches the simulation start date and time.
+
+ .. attention::
+
+ Consider changing the time cycle flag from :option:`EFYO` to
+ :option:`CYS` if you would like your simulation to read a
+ data file (such as a simulation restart file) whose file
+ timestamp differs from the simulaton start date and time.
+
  .. option:: EY
 
  **Exact, Use Smulation Year:** Same as :option:`E`, except don't
- allow :envvar:`Emission year`  setting to override year value.
+ allow :envvar:`Emission year` setting to override year value.
 
  .. option:: A