GCHP 14.5.2 release

This is the official release commit of GCHP 14.5.2.

Updated version numbers in:
- CHANGELOG.md
- CMakeLists.txt
- docs/source/conf.py

Updated GEOS-Chem submodule to version 14.5.2

Updated geos-chem-shared-docs submodule to commit aeeb8e9

Also updated CHANGELOG.md with the latest information.

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>

Author: yantosca

CHANGELOG.md

@@ -9,6 +9,15 @@ This file documents all notable changes to the GCHP wrapper repository starting
 
 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).
 
+## [14.5.2] - 2025-02-12
+### Added
+- Added text to RTD stating that data download from `s3://geos-chem` is and `s3://gcgrid` is free
+
+### Changed
+- Bumped `jinja2` to version 3.1.5 in `docs/requirements.txt` to fix a security issue
+- Changed the build sequence so that the KPP-Standalone is only built when configuring with `-DKPPSA=y`
+- Updated RTD documentation for fullchem rundir creation, which now asks users if they wish to build KPP-Standalone
+
 ## [14.5.1] - 2025-01-10
 ### Added
 - Added code to `src/CMakeLists.txt` to build & install the KPP standalone executable when `fullchem` or `custom` mechanisms are selected

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required (VERSION 3.13)
 project (gchp_ctm
-  VERSION 14.5.1
+  VERSION 14.5.2
   LANGUAGES Fortran CXX C
 )
 

docs/requirements.txt

@@ -12,4 +12,4 @@ sphinxcontrib-bibtex==2.6.2
 sphinx-autobuild==2021.3.14
 recommonmark==0.7.1
 docutils==0.20.1
-jinja2==3.1.4
+jinja2==3.1.5

docs/source/conf.py

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

docs/source/geos-chem-shared-docs

@@ -193,3 +193,29 @@ created and brief instructions for us. For example:
      -- Example run scripts are in the runScriptSamples subdirectory
      -- For more information visit the GCHP user guide at
         https://readthedocs.org/projects/gchp/
+
+
+Build KPP-Standalone Box Model (optional)
+-----------------------------------------
+
+If you are creating a run directory for a fullchem simulation, the
+next (and final) menu will aks you:
+
+.. code-block:: console
+
+   -----------------------------------------------------------
+   Do you want to build the KPP-Standalone Box Model? (y/n)
+   -----------------------------------------------------------
+   >>>
+
+Type :program:`y` and then :command:`ENTER` you wish to build the
+:program:`KPP-Standalone Box Model`, or :program:`n` then
+:program:`ENTER` to skip this step. If you choose to build
+KPP-Standalone, you will be given this reminder:
+
+.. code-block:: console
+
+   >>>> REMINDER: You must compile with options: -DKPPSA=y <<<<
+
+Please see the Supplemental Guide entitled :ref:`kppsa-guide`
+for further usage instructions.

docs/source/user-guide/rundir-init.rst

@@ -60,6 +60,8 @@ set_target_properties(${EXE_FILE_NAME}
 )
 
 #-----------------------------------------------------------------------------
+# If GCHP has been configured with -DKPPSA=y, then:
+#
 # Define the KPP standalone executable:
 # 1. Specify a cache variable with the default target name
 # 2. Specify the location of the main program
@@ -72,26 +74,28 @@ set_target_properties(${EXE_FILE_NAME}
 # This should now fix the issue reported by @msulprizio in:
 #   https://github.com/geoschem/GCClassic/issues/78
 #-----------------------------------------------------------------------------
-set(KPPSA_FILE_NAME kpp_standalone CACHE STRING
-  "Default name for the KPP standalone executable file")
-mark_as_advanced(KPPSA_FILE_NAME)
-add_executable(${KPPSA_FILE_NAME}
-  GCHP_GridComp/GEOSChem_GridComp/geos-chem/KPP/standalone/kpp_standalone.F90
-)
-if("${MECH}" STREQUAL fullchem OR "${MECH}" STREQUAL custom)
-  target_link_libraries(${KPPSA_FILE_NAME}
-    PUBLIC
-    KPPStandalone
-  )
-  set_target_properties(${KPPSA_FILE_NAME}
-    PROPERTIES
-    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
-  )
-else()
-  set_target_properties(${KPPSA_FILE_NAME}
-    PROPERTIES
-    EXCLUDE_FROM_ALL TRUE
-  )
+if (${KPPSA})
+  set(KPPSA_FILE_NAME kpp_standalone CACHE STRING
+    "Default name for the KPP standalone executable file")
+  mark_as_advanced(KPPSA_FILE_NAME)
+  add_executable(${KPPSA_FILE_NAME}
+    GCHP_GridComp/GEOSChem_GridComp/geos-chem/KPP/standalone/kpp_standalone.F90
+    )
+  if("${MECH}" STREQUAL fullchem OR "${MECH}" STREQUAL custom)
+    target_link_libraries(${KPPSA_FILE_NAME}
+      PUBLIC
+      KPPStandalone
+      )
+    set_target_properties(${KPPSA_FILE_NAME}
+      PROPERTIES
+      RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
+      )
+  else()
+    set_target_properties(${KPPSA_FILE_NAME}
+      PROPERTIES
+      EXCLUDE_FROM_ALL TRUE
+      )
+  endif()
 endif()
 
 #-----------------------------------------------------------------------------

src/CMakeLists.txt

@@ -16,6 +16,9 @@ set(LUO_WETDEP OFF CACHE BOOL
 set(FASTJX OFF CACHE BOOL
   "Switch to use legacy FAST-JX photolysis in GEOS-Chem"
 )
+set(KPPSA OFF CACHE BOOL
+  "Switch to build the KPP-Standalone Box Model"
+)
 
 # Local variables
 set(GC_EXTERNAL_CONFIG      TRUE)
@@ -147,3 +150,4 @@ gc_pretty_print(VARIABLE RRTMG IS_BOOLEAN)
 gc_pretty_print(VARIABLE GTMM IS_BOOLEAN)
 gc_pretty_print(VARIABLE LUO_WETDEP IS_BOOLEAN)
 gc_pretty_print(VARIABLE FASTJX IS_BOOLEAN)
+gc_pretty_print(VARIABLE KPPSA IS_BOOLEAN)