From f7b859b0c0a52bd031d104fa2f1c68829208500d Mon Sep 17 00:00:00 2001
From: "Andrew C. Ross" <Andrew.C.Ross@noaa.gov>
Date: Thu, 5 Dec 2024 14:14:49 -0500
Subject: [PATCH] Archive additional metadata and other information to a
 metadata.out directory

---
 xmls/NEP10/CEFI_NEP_cobalt.xml             | 26 ++++++++++++++--------
 xmls/NWA12/CEFI_NWA12_cobalt.xml           | 21 ++++++++++++-----
 xmls/NWA12/CEFI_NWA12_cobalt_fms2_yaml.xml | 21 ++++++++++++-----
 3 files changed, 47 insertions(+), 21 deletions(-)

diff --git a/xmls/NEP10/CEFI_NEP_cobalt.xml b/xmls/NEP10/CEFI_NEP_cobalt.xml
index 4a1a2618f..949a26c15 100644
--- a/xmls/NEP10/CEFI_NEP_cobalt.xml
+++ b/xmls/NEP10/CEFI_NEP_cobalt.xml
@@ -690,15 +690,23 @@ COBALT_INPUT_EOF
     <postProcess>
       <csh><![CDATA[
          cd $work
-         #Make a directory to trick FRE to pick up and archive in ascii
-	 mkdir extra.results
-         mv *velocity_truncations MOM_parameter_doc* SIS_parameter_doc* COBALT_parameter_doc* seaice.stats* ocean.stats* extra.results/
-	 cp diag_table INPUT/*_input INPUT/*_override INPUT/*.xml extra.results/.
-         cp $scriptName extra.results/runscript.csh
-	 #When the ocean uses a mask_table the ocean_static.nc file produced by the model run has holes in coordinates (geolon,geolat)
-         #This causes problems for ferret and python tools for analysis.
-         #Copy a non-masked version of ocean_static.nc to be saved as a history file to be used by the analysis scipts .
-         cp $work/INPUT/ocean_static_no_mask_table.nc $work/ocean_static.nc
+         # Make a directory to trick FRE to pick up and archive the stats files in ascii
+         mkdir extra.results
+         mv seaice.stats* ocean.stats* *velocity_truncations extra.results/
+         # Also archive an assortment of model input files and model metadata
+         mkdir metadata.out
+         mv MOM_parameter_doc* SIS_parameter_doc* COBALT_parameter_doc* metadata.out/
+         cp diag_table input.nml metadata.out/
+         cp INPUT/*_input INPUT/*_override metadata.out/
+         # Save the Git commit hash for each source code submodule
+         git -C $root/$(LIBS_ROOT)/src/mom6 submodule status --recursive > metadata.out/git_submodule_status
+         # Archive a copy of the xml used to run the model and the run scipt (fre sets these)
+         cp $rtsxml metadata.out/
+         cp $scriptName metadata.out/runscript.csh
+         # When the ocean uses a mask_table the ocean_static.nc file produced by the model run has holes in coordinates (geolon,geolat)
+         # This causes problems for ferret and python tools for analysis.
+         # Copy a non-masked version of ocean_static.nc to be saved as a history file to be used by the analysis scipts.
+         cp $work/INPUT/ocean_static_no_mask_table.nc $work/
       ]]></csh>
       <xi:include xpointer="xpointer(//freInclude[@name='MOM6_postprocess']/postProcess/node())"/>
       <xi:include xpointer="xpointer(//freInclude[@name='COBALT_postprocess']/postProcess/node())"/>
diff --git a/xmls/NWA12/CEFI_NWA12_cobalt.xml b/xmls/NWA12/CEFI_NWA12_cobalt.xml
index 8a613f01c..7938aef94 100644
--- a/xmls/NWA12/CEFI_NWA12_cobalt.xml
+++ b/xmls/NWA12/CEFI_NWA12_cobalt.xml
@@ -692,13 +692,22 @@ COBALT_INPUT_EOF
     <postProcess>
       <csh><![CDATA[
          cd $work
-         #Make a directory to trick FRE to pick up and archive in ascii
+         # Make a directory to trick FRE to pick up and archive the stats files in ascii
          mkdir extra.results
-         mv MOM_parameter_doc* SIS_parameter_doc* COBALT_parameter_doc* seaice.stats* ocean.stats* extra.results/
-         cp diag_table extra.results/.
-         #When the ocean uses a mask_table the ocean_static.nc file produced by the model run has holes in coordinates (geolon,geolat)
-         #This causes problems for ferret and python tools for analysis.
-         #Copy a non-masked version of ocean_static.nc to be saved as a history file to be used by the analysis scipts .
+         mv seaice.stats* ocean.stats* *velocity_truncations extra.results/
+         # Also archive an assortment of model input files and model metadata
+         mkdir metadata.out
+         mv MOM_parameter_doc* SIS_parameter_doc* COBALT_parameter_doc* metadata.out/
+         cp diag_table input.nml metadata.out/
+         cp INPUT/*_input INPUT/*_override metadata.out/
+         # Save the Git commit hash for each source code submodule
+         git -C $root/$(LIBS_ROOT)/src/mom6 submodule status --recursive > metadata.out/git_submodule_status
+         # Archive a copy of the xml used to run the model and the run scipt (fre sets these)
+         cp $rtsxml metadata.out/
+         cp $scriptName metadata.out/runscript.csh
+         # When the ocean uses a mask_table the ocean_static.nc file produced by the model run has holes in coordinates (geolon,geolat)
+         # This causes problems for ferret and python tools for analysis.
+         # Copy a non-masked version of ocean_static.nc to be saved as a history file to be used by the analysis scipts.
          cp $work/INPUT/ocean_static_no_mask_table.nc $work/
       ]]></csh>
       <xi:include xpointer="xpointer(//freInclude[@name='MOM6_postprocess']/postProcess/node())"/>
diff --git a/xmls/NWA12/CEFI_NWA12_cobalt_fms2_yaml.xml b/xmls/NWA12/CEFI_NWA12_cobalt_fms2_yaml.xml
index 2193655d5..23b2a6835 100644
--- a/xmls/NWA12/CEFI_NWA12_cobalt_fms2_yaml.xml
+++ b/xmls/NWA12/CEFI_NWA12_cobalt_fms2_yaml.xml
@@ -695,13 +695,22 @@ diag-table-to-yaml -f $work/diag_table -o $work/diag_table.yaml
     <postProcess>
       <csh><![CDATA[
          cd $work
-         #Make a directory to trick FRE to pick up and archive in ascii
+         # Make a directory to trick FRE to pick up and archive the stats files in ascii
          mkdir extra.results
-         mv MOM_parameter_doc* SIS_parameter_doc* COBALT_parameter_doc* seaice.stats* ocean.stats* extra.results/
-         cp diag_table extra.results/.
-         #When the ocean uses a mask_table the ocean_static.nc file produced by the model run has holes in coordinates (geolon,geolat)
-         #This causes problems for ferret and python tools for analysis.
-         #Copy a non-masked version of ocean_static.nc to be saved as a history file to be used by the analysis scipts .
+         mv seaice.stats* ocean.stats* *velocity_truncations extra.results/
+         # Also archive an assortment of model input files and model metadata
+         mkdir metadata.out
+         mv MOM_parameter_doc* SIS_parameter_doc* COBALT_parameter_doc* metadata.out/
+         cp diag_table input.nml metadata.out/
+         cp INPUT/*_input INPUT/*_override metadata.out/
+         # Save the Git commit hash for each source code submodule
+         git -C $root/$(LIBS_ROOT)/src/mom6 submodule status --recursive > metadata.out/git_submodule_status
+         # Archive a copy of the xml used to run the model and the run scipt (fre sets these)
+         cp $rtsxml metadata.out/
+         cp $scriptName metadata.out/runscript.csh
+         # When the ocean uses a mask_table the ocean_static.nc file produced by the model run has holes in coordinates (geolon,geolat)
+         # This causes problems for ferret and python tools for analysis.
+         # Copy a non-masked version of ocean_static.nc to be saved as a history file to be used by the analysis scipts.
          cp $work/INPUT/ocean_static_no_mask_table.nc $work/
       ]]></csh>
       <xi:include xpointer="xpointer(//freInclude[@name='MOM6_postprocess']/postProcess/node())"/>