Merge pull request #853 from xylar/add_anomaly_tag

Add an `anomaly` tag

docs/config/output.rst

@@ -131,6 +131,12 @@ specify::
 
   generate = ['all_publicObs', 'no_seaIce']
 
+If an appropriate reference year isn't available for computing  anomalies,
+include 'no_anomaly' in the generate list to skip all tasks that require the
+reference year for computing anomalies::
+
+  generate = ['all_publicObs', 'no_anomaly']
+
 To specify that you wanted to plot climatologies from the ocean component, you
 could use::
 

example.cfg

@@ -165,12 +165,21 @@ htmlSubdirectory = html
 # option:
 #    mpas_analysis config.analysis --generate \
 #         only_ocean,no_timeSeries,timeSeriesSST
+#
+# Note: if an appropriate reference year isn't available for computing
+#       anomalies, include 'no_anomaly' in the generate list
 generate = ['all_publicObs']
 
+
 [climatology]
 ## options related to producing climatologies, typically to compare against
 ## observations and previous runs
 
+# the year from which to compute anomalies if not the start year of the
+# simulation.  This might be useful if a long spin-up cycle is performed and
+# only the anomaly over a later span of years is of interest.
+# anomalyRefYear = 249
+
 # the first year over which to average climatalogies
 startYear = 11
 # the last year over which to average climatalogies
@@ -181,6 +190,11 @@ endYear = 20
 ## options related to producing time series plots, often to compare against
 ## observations and previous runs
 
+# the year from which to compute anomalies if not the start year of the
+# simulation.  This might be useful if a long spin-up cycle is performed and
+# only the anomaly over a later span of years is of interest.
+# anomalyRefYear = 249
+
 # start and end years for timeseries analysis. Use endYear = end to indicate
 # that the full range of the data should be used.  If errorOnMissing = False,
 # the start and end year will be clipped to the valid range.  Otherwise, out

example_e3sm.cfg

@@ -117,12 +117,20 @@ htmlSubdirectory = html
 # option:
 #    mpas_analysis config.analysis --generate \
 #         only_ocean,no_timeSeries,timeSeriesSST
+#
+# Note: if an appropriate reference year isn't available for computing
+#       anomalies, include 'no_anomaly' in the generate list
 generate = ['all_publicObs']
 
 [climatology]
 ## options related to producing climatologies, typically to compare against
 ## observations and previous runs
 
+# the year from which to compute anomalies if not the start year of the
+# simulation.  This might be useful if a long spin-up cycle is performed and
+# only the anomaly over a later span of years is of interest.
+# anomalyRefYear = 249
+
 # the first year over which to average climatalogies
 startYear = 11
 # the last year over which to average climatalogies
@@ -133,6 +141,11 @@ endYear = 20
 ## options related to producing time series plots, often to compare against
 ## observations and previous runs
 
+# the year from which to compute anomalies if not the start year of the
+# simulation.  This might be useful if a long spin-up cycle is performed and
+# only the anomaly over a later span of years is of interest.
+# anomalyRefYear = 249
+
 # start and end years for timeseries analysis. Use endYear = end to indicate
 # that the full range of the data should be used.  If errorOnMissing = False,
 # the start and end year will be clipped to the valid range.  Otherwise, out

mpas_analysis/ocean/climatology_map_ohc_anomaly.py

@@ -71,7 +71,8 @@ def __init__(self, config, mpasClimatologyTask, refYearClimatolgyTask,
         super(ClimatologyMapOHCAnomaly, self).__init__(
             config=config, taskName='climatologyMapOHCAnomaly',
             componentName='ocean',
-            tags=['climatology', 'horizontalMap', fieldName, 'publicObs'])
+            tags=['climatology', 'horizontalMap', fieldName, 'publicObs',
+                  'anomaly'])
 
         sectionName = self.taskName
 

mpas_analysis/ocean/time_series_ohc_anomaly.py

@@ -63,7 +63,7 @@ def __init__(self, config, mpasTimeSeriesTask, controlConfig=None):
             config=config,
             taskName='timeSeriesOHCAnomaly',
             componentName='ocean',
-            tags=['timeSeries', 'ohc', 'publicObs'])
+            tags=['timeSeries', 'ohc', 'publicObs', 'anomaly'])
 
         sectionName = 'timeSeriesOHCAnomaly'
         regionNames = config.getExpression(sectionName, 'regions')

mpas_analysis/ocean/time_series_salinity_anomaly.py

@@ -50,7 +50,7 @@ def __init__(self, config, mpasTimeSeriesTask):  # {{{
             config=config,
             taskName='timeSeriesSalinityAnomaly',
             componentName='ocean',
-            tags=['timeSeries', 'salinity', 'publicObs'])
+            tags=['timeSeries', 'salinity', 'publicObs', 'anomaly'])
 
         sectionName = 'hovmollerSalinityAnomaly'
         regionNames = config.getExpression(sectionName, 'regions')

mpas_analysis/ocean/time_series_ssh_anomaly.py

@@ -71,7 +71,7 @@ def __init__(self, config, mpasTimeSeriesTask, controlConfig):
             config=config,
             taskName='timeSeriesSSHAnomaly',
             componentName='ocean',
-            tags=['timeSeries', 'ssh', 'publicObs'])
+            tags=['timeSeries', 'ssh', 'publicObs', 'anomaly'])
 
         self.controlConfig = controlConfig
         self.filePrefix = None

mpas_analysis/ocean/time_series_temperature_anomaly.py

@@ -50,7 +50,7 @@ def __init__(self, config, mpasTimeSeriesTask):  # {{{
             config=config,
             taskName='timeSeriesTemperatureAnomaly',
             componentName='ocean',
-            tags=['timeSeries', 'temperature', 'publicObs'])
+            tags=['timeSeries', 'temperature', 'publicObs', 'anomaly'])
 
         sectionName = 'hovmollerTemperatureAnomaly'
         regionNames = config.getExpression(sectionName, 'regions')

mpas_analysis/shared/climatology/ref_year_mpas_climatology_task.py

@@ -75,6 +75,8 @@ def __init__(self, config, componentName, taskName=None):  # {{{
             config=new_config,
             componentName=componentName,
             taskName=taskName)
+
+        self.tags.append('anomaly')
         # }}}
 
     def get_start_and_end(self):  # {{{