Remove the comparison grid name from sea ice gallery groups

The comparison grid name is confusing and redundant.
MPAS-Dev · Nov 6, 2024 · 1f04a00 · 1f04a00
1 parent cf1c0ab
commit 1f04a00
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 10 deletions.
diff --git a/mpas_analysis/sea_ice/climatology_map_berg_conc.py b/mpas_analysis/sea_ice/climatology_map_berg_conc.py
@@ -158,7 +158,8 @@ def __init__(self, config, mpasClimatologyTask, hemisphere,
                     groupSubtitle=None,
                     groupLink='{}_conc'.format(hemisphere.lower()),
                     galleryName=galleryName,
-                    extend='neither')
+                    extend='neither',
+                    prependComparisonGrid=False)
 
                 self.add_subtask(subtask)
 

diff --git a/mpas_analysis/sea_ice/climatology_map_melting.py b/mpas_analysis/sea_ice/climatology_map_melting.py
@@ -161,7 +161,8 @@ def __init__(self, config, mpas_climatology_task, hemisphere,
                     groupSubtitle=None,
                     groupLink=f'{hemisphere.lower()}_melting',
                     galleryName=gallery_name,
-                    extend='max')
+                    extend='max',
+                    prependComparisonGrid=False)
 
                 self.add_subtask(subtask)
 

diff --git a/mpas_analysis/sea_ice/climatology_map_production.py b/mpas_analysis/sea_ice/climatology_map_production.py
@@ -161,7 +161,8 @@ def __init__(self, config, mpas_climatology_task, hemisphere,
                     groupSubtitle=None,
                     groupLink=f'{hemisphere.lower()}_production',
                     galleryName=gallery_name,
-                    extend='max')
+                    extend='max',
+                    prependComparisonGrid=False)
 
                 self.add_subtask(subtask)
 

diff --git a/mpas_analysis/sea_ice/climatology_map_sea_ice_conc.py b/mpas_analysis/sea_ice/climatology_map_sea_ice_conc.py
@@ -184,7 +184,8 @@ def _add_obs_tasks(self, seasons, comparisonGridNames, hemisphere,
                         galleryName='Observations: SSM/I {}'.format(
                             prefix),
                         maskMinThreshold=minConcentration,
-                        extend='neither')
+                        extend='neither',
+                        prependComparisonGrid=False)
 
                     self.add_subtask(subtask)
 
@@ -230,7 +231,8 @@ def _add_ref_tasks(self, seasons, comparisonGridNames, hemisphere,
                     groupLink='{}_conc'.format(hemisphere.lower()),
                     galleryName=galleryName,
                     maskMinThreshold=minConcentration,
-                    extend='neither')
+                    extend='neither',
+                    prependComparisonGrid=False)
 
                 self.add_subtask(subtask)
 

diff --git a/mpas_analysis/sea_ice/climatology_map_sea_ice_thick.py b/mpas_analysis/sea_ice/climatology_map_sea_ice_thick.py
@@ -166,7 +166,8 @@ def __init__(self, config, mpasClimatologyTask, hemisphere,
                     groupLink=f'{hemisphere.lower()}_thick',
                     galleryName=galleryName,
                     maskMinThreshold=0,
-                    extend='neither')
+                    extend='neither',
+                    prependComparisonGrid=False)
 
                 self.add_subtask(subtask)
 

diff --git a/mpas_analysis/shared/plot/plot_climatology_map_subtask.py b/mpas_analysis/shared/plot/plot_climatology_map_subtask.py
@@ -219,13 +219,15 @@ def __init__(self, parentTask, season, comparisonGridName,
         self.maskMinThreshold = None
         self.maskMaxThreshold = None
         self.extend = 'both'
+        self.prependComparisonGrid = None
 
     def set_plot_info(self, outFileLabel, fieldNameInTitle, mpasFieldName,
                       refFieldName, refTitleLabel, unitsLabel,
                       imageCaption, galleryGroup, groupSubtitle, groupLink,
                       galleryName, diffTitleLabel='Model - Observations',
                       configSectionName=None, maskMinThreshold=None,
-                      maskMaxThreshold=None, extend=None):
+                      maskMaxThreshold=None, extend=None,
+                      prependComparisonGrid=True):
         """
         Store attributes related to plots, plot file names and HTML output.
 
@@ -282,7 +284,11 @@ def set_plot_info(self, outFileLabel, fieldNameInTitle, mpasFieldName,
 
         extend : {'neither', 'both', 'min', 'max'}, optional
             Determines the ``contourf``-coloring of values that are outside the
-            range of the levels provided if using an indexed colormap.
+            range of the levels provided if using an indexed colormap
+
+        prependComparisonGrid : bool, optional
+            Whether to prepend the name of the comparison grid to the gallery
+            group
         """
 
         self.outFileLabel = outFileLabel
@@ -325,6 +331,8 @@ def set_plot_info(self, outFileLabel, fieldNameInTitle, mpasFieldName,
         if extend is not None:
             self.extend = extend
 
+        self.prependComparisonGrid = prependComparisonGrid
+
     def setup_and_check(self):
         """
         Perform steps to set up the analysis and check for errors in the setup.
@@ -647,14 +655,19 @@ def _plot_projection(self, remappedModelClimatology,
             vertical=vertical,
             extend=self.extend)
 
-        upperGridName = capwords(comparisonGridName.replace('_', ' '))
+        if self.prependComparisonGrid:
+            upperGridName = capwords(comparisonGridName.replace('_', ' '))
+            galleryGroup = f'{upperGridName} {self.galleryGroup}'
+        else:
+            galleryGroup = self.galleryGroup
+
         caption = f'{season} {self.imageCaption}'
         write_image_xml(
             config,
             filePrefix,
             componentName=componentName,
             componentSubdirectory=componentSubdirectory,
-            galleryGroup=f'{upperGridName} {self.galleryGroup}',
+            galleryGroup=galleryGroup,
             groupSubtitle=self.groupSubtitle,
             groupLink=f'{comparisonGridName}_{self.groupLink}',
             gallery=self.galleryName,