Merge pull request #3338 from olyson/b4b-dev_contrib_scripts

Update SpinupStability and run_clm_historical scripts

Author: ekluzek

tools/contrib/README

@@ -6,7 +6,7 @@ available before adding it. These scripts may not be as well tested or supported
 tools. They are also ONLY assumed to work on the NCAR supercomputer. So paths will be hardwired to
 assume NCAR directory structures.
 
-The python scripts require the following settings before running on cheyenne:
+The python scripts require the following settings before running on Derecho:
 
 module load conda
 ../../py_env_create
@@ -16,28 +16,28 @@ Brief description of scripts:
 
 create_scrip_file.ncl
         Create a SCRIP grid file needed for running with WRF
-run_clm_historical
-	does all the setup and submission required to do a 1850-2010 CLM 
-	historical simulation in three separate submissions
-        v1 - Andrew Slater+Dave Lawrence, 8/2015
+run_clm_historical.v11.csh
+	does all the setup and submission required to do a 1850-2023 CLM 
+	historical simulation in five separate submissions
+        v11 - Oleson, 07/2025
 
 modify_singlept_site
         Modify some data on a surface dataset created by site_and_regional/subset_data
 
-SpinupStability_SP_v9.ncl
+SpinupStability_SP_v10.ncl
         This script assesses the equilibrium state of a Satellite Phenology (SP) 
         spinup run, works on either monthly or annual mean history files - Keith
-        Oleson 12/2021
+        Oleson 07/2025
 
-SpinupStability_BGC_v10.ncl
+SpinupStability_BGC_v11.ncl
         This script assesses the equilibrium state of a Biogeochemistry (BGC) 
         spinup run, works on either monthly or annual mean history files - Keith
-        Oleson 12/2021
+        Oleson 07/2025
 
-SpinupStability_BGC_v11_SE.ncl
+SpinupStability_BGC_v12_SE.ncl
         This script assesses the equilibrium state of a ne30pg3 (spectral element)
         Biogeochemistry (BGC) spinup run, works on either monthly or annual mean 
-        history files - Keith Oleson 03/2025
+        history files - Oleson 07/2025
 
 run_clmtowers
         This script will run any number of flux tower sites.

tools/contrib/SpinupStability_BGC_v10.ncl tools/contrib/SpinupStability_BGC_v11.ncltools/contrib/SpinupStability_BGC_v10.ncl renamed to tools/contrib/SpinupStability_BGC_v11.ncl

@@ -1,14 +1,9 @@
 ; NCL script
-; SpinupStability_BGC_v10.ncl
+; SpinupStability_BGC_v11.ncl
 ; Script to examine stability of BGC spinup simulation.
 ; This version operates on either monthly mean or multi-annual mean multi-variable history files 
 ; NOTE: THIS SCRIPT IS ONLY INTENDED FOR USE WITH 2-D LAT/LON GRIDS
-; Keith Oleson, Mar 2020
-
-load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
-load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
-load "~oleson/lnd_diag/run/contributed.ncl"
-load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/shea_util.ncl"
+; Keith Oleson, July 2025
 
 begin
 
@@ -30,17 +25,18 @@ begin
 ;  annual_hist flag to False if your case has monthly mean history files.
 ;  AND set the region (supported options: Global, Arctic, SPT).
 ;  AND set the subper (subsampling period in years, number of years that atm forcing repeats).
-; The script assumes that your history files are in /glade/scratch/$username/archive/$caseid/lnd/hist
+; The script assumes that your history files are in /glade/derecho/scratch/$username/archive/$caseid/lnd/hist
 ; You need a run consisting of at least three cycles of atmospheric data
 ;=======================================================================;
 
 ; GLOBAL EXAMPLE
-  caseid = "clm50_release-clm5.0.15_2deg_GSWP3V1_1850AD"
-  username = "oleson"
+  caseid = "ctsm53026_BNF_AD"
+  username = "slevis"
   annual_hist = True
   region = "Global"              ; Global, Arctic, or SPT (single point)
   subper = 20                    ; Subsampling period in years
   paleo = False                  ; Use paleo map
+  hist_ext = "h0"                ; Set to either h0 (ctsm5.3.061 or earlier) or h0a (ctsm5.3.062 or later)
 
 ; SPT (single point) EXAMPLE
 ; caseid = "clm50_release-clm5.0.15_SPT_GSWP3V1_1850spin"
@@ -49,12 +45,13 @@ begin
 ; region = "SPT"                 ; Global, Arctic, or SPT (single point)
 ; subper = 20                    ; Subsampling period in years
 ; paleo = False                  ; Use paleo map
+; hist_ext = "h0"                ; Set to either h0 (ctsm5.3.061 or earlier) or h0a (ctsm5.3.062 or later)
 
   do_plot = True
 ; do_plot = False
 ;=======================================================================;
 
-  data_dir = "/glade/scratch/"+username+"/archive/"+caseid+"/lnd/hist/"
+  data_dir = "/glade/derecho/scratch/"+username+"/archive/"+caseid+"/lnd/hist/"
   if ( systemfunc("test -d "+data_dir+"; echo $?" ) .ne. 0 )then
      print( "Input directory does not exist or not found: "+data_dir );
      print( "Make sure username and caseid and base directory is set correctly" )
@@ -85,9 +82,9 @@ begin
   end if
 
   if (annual_hist) then
-    fls                       = systemfunc("ls " + data_dir + caseid+".clm2.h0a.*-*-*-*"+".nc")
+    fls                       = systemfunc("ls " + data_dir + caseid+".clm2."+hist_ext+".*-*-*-*"+".nc")
   else
-    fls                       = systemfunc("ls " + data_dir + caseid+".clm2.h0a.*-*"+".nc")
+    fls                       = systemfunc("ls " + data_dir + caseid+".clm2."+hist_ext+".*-*"+".nc")
   end if
   flsdims                   = dimsizes(fls)
 

…s/contrib/SpinupStability_BGC_v11_SE.ncl …s/contrib/SpinupStability_BGC_v12_SE.ncltools/contrib/SpinupStability_BGC_v11_SE.ncl renamed to tools/contrib/SpinupStability_BGC_v12_SE.ncl tools/contrib/SpinupStability_BGC_v11_SE.ncl renamed to tools/contrib/SpinupStability_BGC_v12_SE.ncl

@@ -1,9 +1,9 @@
 ; NCL script
-; SpinupStability_BGC_v11_SE.ncl
+; SpinupStability_BGC_v12_SE.ncl
 ; Script to examine stability of spinup simulation.
 ; This version operates on either monthly mean or multi-annual mean multi-variable history files 
 ; and supports ne30 grids only
-; Keith Oleson, March 2025
+; Keith Oleson, July 2025
 ;
 ; ARH mods, April 2020 - modified to work for unstructured grids via remapping to FV 1 deg. grid.
 ; KO mods, March 2025 - regrid history file using ncremap to get area and landfrac instead of 
@@ -41,6 +41,7 @@ begin
  region = "Global"              ; Global
  subper = 20                    ; Subsampling period in years
  paleo = False                  ; Use paleo map ; UNTESTED IN THIS VERSION
+ hist_ext = "h0"                ; Set to either h0 (ctsm5.3.061 or earlier) or h0a (ctsm5.3.062 or later)
 
 ;--- ARH mods ---
  map_method = "conserve"      ;bilinear,conserve or patch
@@ -81,9 +82,9 @@ begin
   totecosysc_thresh = 1.0        ; disequilibrium threshold for individual gridcells (gC/m2/yr)
 
   if (annual_hist) then
-    fls                     = systemfunc("ls " + data_dir + caseid+".clm2.h0a.*-*-*-*"+".nc")
+    fls                     = systemfunc("ls " + data_dir + caseid+".clm2."+hist_ext+".*-*-*-*"+".nc")
   else
-    fls                     = systemfunc("ls " + data_dir + caseid+".clm2.h0a.*-*"+".nc")
+    fls                     = systemfunc("ls " + data_dir + caseid+".clm2."+hist_ext+".*-*"+".nc")
   end if
   flsdims                   = dimsizes(fls)
 

tools/contrib/SpinupStability_SP_v9.ncl tools/contrib/SpinupStability_SP_v10.ncltools/contrib/SpinupStability_SP_v9.ncl renamed to tools/contrib/SpinupStability_SP_v10.ncl

@@ -1,13 +1,8 @@
 ; NCL script
-; SpinupStability_SP_v9.ncl
+; SpinupStability_SP_v10.ncl
 ; Script to examine stability of SP spinup simulation.
 ; This version operates on either monthly mean or multi-annual mean multi-variable history files 
-; Keith Oleson, Sep 2018
-
-load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
-load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
-load "~oleson/lnd_diag/run/contributed.ncl"
-load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/shea_util.ncl"
+; Keith Oleson, July 2025
 
 begin
 
@@ -27,21 +22,24 @@ begin
 ; To run this script, just enter in your case name and username below. 
 ;  AND set the annual_hist flag to "True" if your case has annual mean history files or set 
 ;  annual_hist flag to "False" if your case has monthly mean history files.
-; The script ; assumes that your history files are in /glade/scratch/$username/archive/$caseid/lnd/hist
+; The script assumes that your history files are in /glade/derecho/scratch/$username/archive/$caseid/lnd/hist
 ;=======================================================================;
 
-  caseid = "cesm20exp10j_1deg_CPLHST_nndep_1850pAD"
+  caseid = "clm50sp_cesm23a02cPPEn08ctsm51d030_1deg_GSWP3V1_1850spin"
   username = "oleson"
   annual_hist = "False"
   cplot = "Global"
   subper = 20
   h2osoi_layer = 8               ; Desired soil layer (layer 8 is about 1m)
   tsoi_layer = 10                ; Desired soil layer (layer 10 is about 3m)
+  hist_ext = "h0"                ; Set to either h0 (ctsm5.3.061 or earlier) or h0a (ctsm5.3.062 or later)
 
   do_plot = "True"
 ;=======================================================================;
 
-  data_dir = "/glade/scratch/"+username+"/archive/"+caseid+"/lnd/hist/"
+  data_dir = "/glade/derecho/scratch/"+username+"/archive/"+caseid+"/lnd/hist/"
+; FOR TESTING
+; data_dir = "/glade/campaign/cgd/tss/common/Land_Only_Simulations/CTSM51_DEV/CLM50_CTSM51_LAND_ONLY_RELEASE/"+caseid+"/lnd/hist/"
 
 ; Thresholds 
   glob_thresh_fsh = 0.02         ; global threshold for FSH equilibrium (delta W m-2 / yr)
@@ -54,9 +52,9 @@ begin
   tws_thresh = 0.001             ; disequilibrium threshold for individual gridcells (m)
 
   if (annual_hist .eq. "True") then
-    fls                       = systemfunc("ls " + data_dir + caseid+".clm2.h0a.*-*-*-*"+".nc")
+    fls                       = systemfunc("ls " + data_dir + caseid+".clm2."+hist_ext+".*-*-*-*"+".nc")
   else
-    fls                       = systemfunc("ls " + data_dir + caseid+".clm2.h0a.*-*"+".nc")
+    fls                       = systemfunc("ls " + data_dir + caseid+".clm2."+hist_ext+".*-*"+".nc")
   end if
   flsdims                   = dimsizes(fls)