Support comparison with a reference run

configs/anvil/config.20170926.FCT2.A_WCYCL1850S.ne30_oECv3.anvil

@@ -11,6 +11,13 @@ mainRunName = 20170926.FCT2.A_WCYCL1850S.ne30_oECv3.anvil
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/cori/config.20171201.default.GMPAS-IAF.T62_oRRS30to10v3wLI.cori-knl

@@ -11,6 +11,13 @@ mainRunName = 20171201.default.GMPAS-IAF.T62_oRRS30to10v3wLI.cori-knl
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [execute]
 ## options related to executing parallel tasks
 

configs/cori/job_script.cori-haswell.bash

@@ -32,10 +32,10 @@ if [ ! -f $run_config_file ]; then
     echo "File $run_config_file not found!"
     exit 1
 fi
-if [ ! -f ./run_analysis.py ]; then
-    echo "run_analysis.py not found in current directory!"
+if [ ! -f ./run_mpas_analysis ]; then
+    echo "run_mpas_analysis not found in current directory!"
     exit 1
 fi
 
-srun -N 1 -n 1 ./run_analysis.py $run_config_file
+srun -N 1 -n 1 ./run_mpas_analysis $run_config_file
 

configs/cori/job_script.cori-knl.bash

@@ -32,10 +32,10 @@ if [ ! -f $run_config_file ]; then
     echo "File $run_config_file not found!"
     exit 1
 fi
-if [ ! -f ./run_analysis.py ]; then
-    echo "run_analysis.py not found in current directory!"
+if [ ! -f ./run_mpas_analysis ]; then
+    echo "run_mpas_analysis not found in current directory!"
     exit 1
 fi
 
-srun -N 1 -n 1 ./run_analysis.py $run_config_file
+srun -N 1 -n 1 ./run_mpas_analysis $run_config_file
 

configs/edison/config.20170807.beta1.G_oQU240.edison

@@ -11,6 +11,13 @@ mainRunName = 20170807.beta1.G_oQU240.edison
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/edison/config.20170915.beta2.A_WCYCL1850S.ne30_oECv3_ICG.edison

@@ -12,6 +12,13 @@ mainRunName = 20170915.beta2.A_WCYCL1850S.ne30_oECv3_ICG.edison
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/edison/config.20171102.beta3rc02_1850.ne30_oECv3_ICG.edison

@@ -12,6 +12,13 @@ mainRunName = 20171102.beta3rc02_1850.ne30_oECv3_ICG.edison
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/edison/config.B_low_res_ice_shelves_1696_JWolfe_layout_Edison

@@ -11,6 +11,13 @@ mainRunName = B_low_res_ice_shelves_1696_JWolfe_layout_Edison
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [execute]
 ## options related to executing parallel tasks
 

configs/lanl/config.20170207.MPAS-SeaIce.QU60km_polar.wolf

@@ -11,6 +11,13 @@ mainRunName = MPAS-SeaIce.QU60km_polar
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/lanl/config.MatchBoth_orig

@@ -11,6 +11,13 @@ mainRunName = MatchBoth_orig
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/olcf/config.20170313.beta1.A_WCYCL1850S.ne30_oECv3_ICG.edison

@@ -11,6 +11,13 @@ mainRunName = 20170313.beta1.A_WCYCL1850S.ne30_oECv3_ICG.edison
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/olcf/config.20170915.beta2.A_WCYCL1850S.ne30_oECv3_ICG.edison

@@ -11,6 +11,13 @@ mainRunName = 20170915.beta2.A_WCYCL1850S.ne30_oECv3_ICG.edison
 # MPAS-Analysis)
 preprocessedReferenceRunName = B1850C5_ne30_v0.4
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/olcf/config.GMPAS-IAF_oRRS18to6v3.titan

@@ -4,17 +4,21 @@
 
 # mainRunName is a name that identifies the simulation being analyzed.
 mainRunName = GMPAS-IAF_oRRS18to6v3
-# referenceRunName is the name of a reference run to compare against (or None
-# to turn off comparison with a reference, e.g. if no reference case is
-# available)
-referenceRunName = None
+
 # preprocessedReferenceRunName is the name of a reference run that has been
 # preprocessed to compare against (or None to turn off comparison).  Reference
 # runs of this type would have preprocessed results because they were not
 # performed with MPAS components (so they cannot be easily ingested by
 # MPAS-Analysis)
 preprocessedReferenceRunName = None
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [input]
 ## options related to reading in the results to be analyzed
 

configs/theta/config.20171031.tenYearTest.GMPAS-IAF.T62_oEC60to30v3wLI.60layer.theta

@@ -11,6 +11,13 @@ mainRunName = 20171031.tenYearTest.GMPAS-IAF.T62_oEC60to30v3wLI.60layer.theta
 # MPAS-Analysis)
 preprocessedReferenceRunName = None
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [execute]
 ## options related to executing parallel tasks
 

docs/api.rst

@@ -59,6 +59,7 @@ Ocean tasks
    TimeSeriesTemperatureAnomaly
    TimeSeriesSalinityAnomaly
    TimeSeriesSST
+   TimeSeriesAntarcticMelt
 
 .. currentmodule:: mpas_analysis.ocean.compute_anomaly_subtask
 
@@ -166,13 +167,18 @@ Climatology
    compute_monthly_climatology
    compute_climatology
    add_years_months_days_in_month
+   get_unmasked_mpas_climatology_directory
+   get_unmasked_mpas_climatology_file_name
+   get_masked_mpas_climatology_file_name
+   get_remapped_mpas_climatology_file_name
 
    MpasClimatologyTask
    MpasClimatologyTask.add_variables
    MpasClimatologyTask.get_file_name
 
    RemapMpasClimatologySubtask
-   RemapMpasClimatologySubtask.get_file_name
+   RemapMpasClimatologySubtask.get_masked_file_name
+   RemapMpasClimatologySubtask.get_remapped_file_name
 
    RemapObservedClimatologySubtask
    RemapObservedClimatologySubtask.get_observation_descriptor
@@ -187,7 +193,10 @@ Time Series
    :toctree: generated/
 
     cache_time_series
+    compute_moving_avg_anomaly_from_start
+    compute_moving_avg
 
+    MpasTimeSeriesTask
 
 Interpolation
 -------------

mpas_analysis/config.default

@@ -22,17 +22,21 @@
 
 # mainRunName is a name that identifies the simulation being analyzed.
 mainRunName = runName
-# referenceRunName is the name of a reference run to compare against (or None
-# to turn off comparison with a reference, e.g. if no reference case is
-# available)
-referenceRunName = None
+
 # preprocessedReferenceRunName is the name of a reference run that has been
 # preprocessed to compare against (or None to turn off comparison).  Reference
 # runs of this type would have preprocessed results because they were not
 # performed with MPAS components (so they cannot be easily ingested by
 # MPAS-Analysis)
 preprocessedReferenceRunName = None
 
+# config file for a reference run to which this run will be compared.  The
+# analysis should have already been run to completion once with this config
+# file, so that the relevant MPAS climatologies already exist and have been
+# remapped to the comparison grid.  Leave this option commented out if no
+# reference run is desired.
+# referenceRunConfigFile = /path/to/config/file
+
 [execute]
 ## options related to executing parallel tasks
 
@@ -73,7 +77,7 @@ oceanStreamsFileName = streams.ocean
 seaIceNamelistFileName = mpas-cice_in
 seaIceStreamsFileName = streams.cice
 
-# names of ocean and sea ice meshes (e.g. EC60to30, QU240, RRS30to10, etc.)
+# names of ocean and sea ice meshes (e.g. oEC60to30, oQU240, oRRS30to10, etc.)
 mpasMeshName = mesh
 
 # The system has a limit to how many files can be open at one time.  By
@@ -96,6 +100,7 @@ maxChunkSize = 10000
 # placed in the output mappingSubdirectory
 # mappingDirectory = /dir/for/mapping/files
 
+
 [output]
 ## options related to writing out plots, intermediate cached data sets, logs,
 ## etc.
@@ -109,7 +114,6 @@ scratchSubdirectory = scratch
 plotsSubdirectory = plots
 logsSubdirectory = logs
 mpasClimatologySubdirectory = clim/mpas
-mpasRemappedClimSubdirectory = clim/mpas/remapped
 mappingSubdirectory = mapping
 timeSeriesSubdirectory = timeseries
 timeCacheSubdirectory = timecache