feature/reg_tests This commit references ufs-community#99.

Update global_cycle script prologs.

reg_tests/global_cycle/C768.fv3gfs.sh

@@ -1,7 +1,11 @@
 #!/bin/bash
 
-set -x
+#------------------------------------------------------------------
+# Run global_cycle for a C768 test case.  Compare output
+# to a baseline set of files using the 'nccmp' utility.
+#------------------------------------------------------------------
 
+set -x
 
 export MAX_TASKS_CY=6
 

reg_tests/global_cycle/driver.cray.sh

@@ -1,5 +1,23 @@
 #!/bin/bash
 
+#-----------------------------------------------------------------------------
+#
+# Run global_cycle regression test on WCOSS-Cray.
+#
+# Set $DATA to your working directory.  Set the project code (BSUB -P)
+# and queue (BSUB -q) as appropriate.
+#
+# Invoke the script as follows:  cat $script | bsub
+#
+# Log output is placed in regression.log.  A summary is
+# placed in summary.log
+#
+# The test fails when its output does not match the baseline files
+# as determined by the 'nccmp' utility.  This baseline files are
+# stored in HOMEreg.
+#
+#-----------------------------------------------------------------------------
+
 #BSUB -oo regression.log
 #BSUB -eo regression.log
 #BSUB -q debug
@@ -12,10 +30,14 @@
 module load PrgEnv-intel cfp-intel-sandybridge/1.1.0
 module list
 
-export NODES=1
-
 export DATA=/gpfs/hps3/stmp/$LOGNAME/reg_tests.cycle
 
+#-----------------------------------------------------------------------------
+# Should not have to change anything below.
+#-----------------------------------------------------------------------------
+
+export NODES=1
+
 export HOMEreg=/gpfs/hps3/emc/global/noscrub/George.Gayno/ufs_utils.git/reg_tests/global_cycle
 
 export OMP_NUM_THREADS_CY=4

reg_tests/global_cycle/driver.dell.sh

@@ -1,15 +1,33 @@
 #!/bin/bash
 
+#-----------------------------------------------------------------------------
+#
+# Run global_cycle regression test on WCOSS-Dell.
+#
+# Set $DATA to your working directory.  Set the project code (BSUB -P)
+# and queue (BSUB -q) as appropriate.
+#
+# Invoke the script as follows:  cat $script | bsub
+#
+# Log output is placed in regression.log.  A summary is
+# placed in summary.log
+#
+# The test fails when its output does not match the baseline files
+# as determined by the 'nccmp' utility.  This baseline files are
+# stored in HOMEreg.
+#
+#-----------------------------------------------------------------------------
+
 #BSUB -W 00:05
 #BSUB -n 6
 #BSUB -R span[ptile=6]
 #BSUB -x
 #BSUB -o regression.log
 #BSUB -e regression.log
 #BSUB -R "affinity[core(1)]"
-#BSUB -q debug
 #BSUB -M 2400
 #BSUB -J glc_regt
+#BSUB -q debug
 #BSUB -P GFS-DEV
 
 set -x
@@ -24,11 +42,14 @@ module load netcdf_parallel/4.7.4
 
 set -x
 
-
 export DATA=/gpfs/dell1/stmp/$LOGNAME/reg_tests.cycle
 
+#-----------------------------------------------------------------------------
+# Should not have to change anything below.
+#-----------------------------------------------------------------------------
 
 export HOMEreg=/gpfs/dell2/emc/modeling/noscrub/George.Gayno/ufs_utils.git/reg_tests/global_cycle
+
 export OMP_NUM_THREADS_CY=2
 
 export APRUNCY="mpirun -l"

reg_tests/global_cycle/driver.hera.sh

@@ -1,5 +1,23 @@
 #!/bin/bash
 
+#-----------------------------------------------------------------------------
+#
+# Run global_cycle regression test on Hera.
+#
+# Set $DATA to your working directory.  Set the project code (SBATCH -A)
+# and queue (SBATCH -q) as appropriate.
+#
+# Invoke the script as follows:  sbatch $script
+#
+# Log output is placed in regression.log.  A summary is
+# placed in summary.log
+#
+# The test fails when its output does not match the baseline files
+# as determined by the 'nccmp' utility.  This baseline files are
+# stored in HOMEreg.
+#
+#-----------------------------------------------------------------------------
+
 #SBATCH -J cycle_reg_test
 #SBATCH -A fv3-cpu
 #SBATCH --open-mode=truncate
@@ -23,8 +41,12 @@ module list
 
 export DATA=/scratch2/NCEPDEV/stmp1/$LOGNAME/reg_tests.cycle
 
+#-----------------------------------------------------------------------------
+# Should not have to change anything below.
+#-----------------------------------------------------------------------------
 
 export HOMEreg=/scratch1/NCEPDEV/da/George.Gayno/noscrub/reg_tests/global_cycle
+
 export OMP_NUM_THREADS_CY=2
 
 export APRUNCY="srun"

reg_tests/global_cycle/driver.jet.sh

@@ -1,5 +1,23 @@
 #!/bin/bash
 
+#-----------------------------------------------------------------------------
+#
+# Run global_cycle regression test on Jet.
+#
+# Set $DATA to your working directory.  Set the project code (SBATCH -A)
+# and queue (SBATCH -q) as appropriate.
+#
+# Invoke the script as follows:  sbatch $script
+#
+# Log output is placed in regression.log.  A summary is
+# placed in summary.log
+#
+# The test fails when its output does not match the baseline files
+# as determined by the 'nccmp' utility.  This baseline files are
+# stored in HOMEreg.
+#
+#-----------------------------------------------------------------------------
+
 #SBATCH -J cycle_driver
 #SBATCH -A emcda
 #SBATCH --open-mode=truncate
@@ -23,8 +41,12 @@ module list
 
 export DATA=/lfs3/HFIP/emcda/$LOGNAME/stmp/reg_tests.cycle
 
+#-----------------------------------------------------------------------------
+# Should not have to change anything below.
+#-----------------------------------------------------------------------------
 
 export HOMEreg=/lfs3/HFIP/emcda/George.Gayno/reg_tests/global_cycle
+
 export OMP_NUM_THREADS_CY=2
 
 export APRUNCY="srun"