Instantaneous CAM-SIMA history infrastructure

.gitmodules

@@ -3,7 +3,13 @@
         url           = https://github.com/NCAR/ccpp-framework
         fxtag         = 2024-07-19-dev
         fxrequired    = AlwaysRequired
-        fxDONOTUSEurl = https://github.com/NCAR/ccpp-framework
+	fxDONOTUSEurl = https://github.com/NCAR/ccpp-framework
+[submodule "history"]
+	path = src/history/buffers
+	url = https://github.com/ESMCI/history_output
+	fxtag         = history01_00
+	fxrequired    = AlwaysRequired
+	fxDONOTUSEurl = https://github.com/ESMCI/history_output
 [submodule "mpas"]
         path          = src/dynamics/mpas/dycore
         url           = https://github.com/MPAS-Dev/MPAS-Model.git
@@ -13,8 +19,8 @@
         fxDONOTUSEurl = https://github.com/MPAS-Dev/MPAS-Model.git
 [submodule "ncar-physics"]
         path          = src/physics/ncar_ccpp
-        url           = https://github.com/ESCOMP/atmospheric_physics
-        fxtag         = 67bb908e
+	url           = https://github.com/ESCOMP/atmospheric_physics
+	fxtag         = e95c172d7a5a0ebf054f420b08416228e211baa3
         fxrequired    = AlwaysRequired
         fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 [submodule "ccs_config"]

cime_config/atm_in_paramgen.py

@@ -1447,8 +1447,8 @@ def append_user_nl_file(self, user_nl_file):
                             #Notify loop to check the next line for a comma:
                             is_continue_line = False
                         #End if
-
-                    else:
+                    elif ('hist_' not in line_s[0]):
+                        #Raise parsing error; ignore hist lines to be processed by hist_config.py
                         emsg = "Cannot parse the following line in '{}' :\n'{}'"
                         raise AtmInParamGenError(emsg.format(user_nl_file, line))
                     #End if ("=" sign check)

cime_config/buildlib

@@ -97,6 +97,10 @@ def _build_cam():
                               case.get_value("COMP_INTERFACE")),
                  os.path.join(atm_root, "src", "dynamics", "utils"),
                  os.path.join(atm_root, "src", "physics", "utils"),
+                 os.path.join(atm_root, "src", "history"),
+                 os.path.join(atm_root, "src", "history", "buffers", "src"),
+                 os.path.join(atm_root, "src", "history", "buffers", "src", "hash"),
+                 os.path.join(atm_root, "src", "history", "buffers", "src", "util"),
                  os.path.join(atm_root, "src", "utils")]
         for path in phys_dirs:
             if path not in paths:

cime_config/buildnml

@@ -5,6 +5,7 @@ CAM namelist creator
 """
 import sys
 import os
+import re
 import shutil
 import logging
 import glob
@@ -31,6 +32,8 @@ sys.path.append(_CIME_CONFIG_PATH)
 
 # Import CAM's configure structure:
 from cam_config import ConfigCAM
+# HistoryConfig allows translation from user_nl_cam into Fortran namelists
+from hist_config import HistoryConfig
 
 #Import CAM's ParamGen class:
 from atm_in_paramgen import AtmInParamGen
@@ -51,6 +54,7 @@ class CamBuildnmlError(ValueError):
 # This simplifies the filename mangling for different cases.
 def _create_ic_filename(inst_string, i_or_r,
                         run_refcase, run_refdate, run_reftod):
+    """Simplify the filename mangling for different cases."""
     return f"{run_refcase}.cam{inst_string}.{i_or_r}.{run_refdate}-{run_reftod}.nc"
 
 ##################
@@ -297,7 +301,8 @@ def buildnml(case, caseroot, compname):
             # End if
 
         # Determine location and name of "user_nl_cam" files:
-        user_nl_file = os.path.join(caseroot, "user_nl_cam" + inst_string)
+        user_nl_fname = "user_nl_cam" + inst_string
+        user_nl_file = os.path.join(caseroot, user_nl_fname)
 
         # Check that file actually exists.  If not then throw an error:
         if not os.path.exists(user_nl_file):
@@ -362,6 +367,16 @@ def buildnml(case, caseroot, compname):
         # Create CAM namelist using CIME's nmlgen routine:
         pg_atm.write(namelist_file)
 
+        # Add history namelists to atm_in
+        hist_configs = HistoryConfig(filename=user_nl_file, logger=_LOGGER)
+        with open(namelist_file, 'a', encoding='utf-8') as nl_file:
+            hist_configs.output_class_namelist(nl_file)
+            for key in sorted(hist_configs.keys()):
+                hist_configs[key].output_config_namelist(nl_file, logger=_LOGGER)
+            # end for
+        # end with
+
+
 ###############################################################################
 def _main_func():