Remove BPCH_DIAG compilation option and related documentation

This merge commit brings updates from the "feature/remove-bpch-diags" branch into the GEOS-Chem 14.4.0 development stream. This removes the BPCH_DIAG compilation option from the CMake scripts and also removes references to binary punch diagnostics in ReadTheDocs documentation. Signed-off-by: Bob Yantosca <[email protected]>
geoschem · Feb 28, 2024 · d51e872 · d51e872
2 parents adf7a5d + 906138b
commit d51e872
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ This file documents all notable changes to the GEOS-Chem Classic wrapper reposit
 
 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] -- TBD
+### Removed
+- `BPCH_DIAG` configuration option and related ReadTheDocs documentation
+
 ## [14.3.0] - 2024-02-07
 ### Changed
 - Updated GEOS-Chem submodule to 14.3.0

diff --git a/CMakeScripts/GC-ConfigureClassic.cmake b/CMakeScripts/GC-ConfigureClassic.cmake
@@ -49,19 +49,6 @@ function(configureGCClassic)
     set(MECH "fullchem" CACHE STRING "Name of the chemistry mechanism to use")
     gc_pretty_print(VARIABLE MECH OPTIONS "fullchem" "carbon" "Hg" "custom")
 
-    #-------------------------------------------------------------------------
-    # Turn on bpch diagnostics?
-    #-------------------------------------------------------------------------
-    set(BPCH_DIAG "OFF" CACHE BOOL 
-        "Switch to enable GEOS-Chem's bpch diagnostics"
-    )
-    gc_pretty_print(VARIABLE BPCH_DIAG IS_BOOLEAN)
-    if(${BPCH_DIAG})
-        target_compile_definitions(GEOSChemBuildProperties
-	    INTERFACE BPCH_DIAG
-	)
-    endif()
-
     #-------------------------------------------------------------------------
     # Set USE_REAL8 as cache variable so as to not override existing definition
     # See https://github.com/geoschem/geos-chem/issues/43.

diff --git a/docs/source/gcclassic-user-guide/compile-cmake.rst b/docs/source/gcclassic-user-guide/compile-cmake.rst
@@ -109,7 +109,6 @@ generate output similar to this:
    -- Found OpenMP: TRUE (found version "4.5")
    -- General settings:
      * MECH:         **fullchem**  carbon  Hg  custom
-     * BPCH_DIAG:    **ON**  OFF
      * USE_REAL8:    **ON**  OFF
      * SANITIZE:     ON  **OFF**
    -- Components:
@@ -276,26 +275,6 @@ options, unless you explicitly specify otherwise.
 
       Use 40 size-resolved bins with TOMAS simulations.
 
-.. option:: BPCH_DIAG
-
-   Toggles the legacy binary punch diagnostics on.
-
-   .. attention::
-
-      This option is deprecated and will be removed soon.  Most
-      binary-punch format diagnostics have been replaced by
-      :ref:`netCDF-based History diagnostics <history-diagnostics>`.
-
-   Accepted values are:
-
-   .. option:: y
-
-      Activate legacy binary-punch diagnostics.
-
-   .. option:: n
-
-      Deactivate legacy binary-punch diagnostics. **(Default option)**
-
 .. option:: APM
 
    Configures GEOS-Chem to use the `APM microphysics package

diff --git a/docs/source/geos-chem-shared-docs b/docs/source/geos-chem-shared-docs