Merge pull request #1058 from eclare108213/snow2

New sea ice fields (pond area fraction, snow melt rate, and snow-ice formation rate) and updates to existing analyses

docs/developers_guide/api.rst

@@ -127,6 +127,9 @@ Sea ice tasks
    ClimatologyMapSeaIceConc
    ClimatologyMapSeaIceThick
    ClimatologyMapSeaIceSnowDepth
+   ClimatologyMapSeaIceSnowiceFormation
+   ClimatologyMapSeaIceSnowMelt
+   ClimatologyMapSeaIcePondArea
    ClimatologyMapSeaIceAreaFractionRidge
    ClimatologyMapSeaIceVolumeRidge
    ClimatologyMapSeaIceAlbedo

docs/users_guide/analysis_tasks.rst

@@ -52,6 +52,12 @@ Analysis Tasks
    tasks/climatologyMapSeaIceSnowDepthNH
    tasks/climatologyMapSeaIceSnowDepthSH
 
+   tasks/climatologyMapSeaIceSnowiceFormationNH
+   tasks/climatologyMapSeaIceSnowiceFormationSH
+   tasks/climatologyMapSeaIceSnowMeltNH
+   tasks/climatologyMapSeaIceSnowMeltSH
+   tasks/climatologyMapSeaIcePondAreaNH
+   tasks/climatologyMapSeaIcePondAreaSH
    tasks/climatologyMapSeaIceAreaFractionRidgeNH
    tasks/climatologyMapSeaIceAreaFractionRidgeSH
    tasks/climatologyMapSeaIceVolumeRidgeNH

docs/users_guide/tasks/climatologyMapSeaIceAlbedoNH.rst

@@ -11,7 +11,7 @@ part of the averaging period and albedo is not well-defined.
 Component and Tags::
 
   component: seaIce
-  tags: climatology, horizontalMap, seaIceBroadbandAlbedo, publicObs, snow
+  tags: climatology, horizontalMap, seaIceBroadbandAlbedo, publicObs, snow_on_sea_ice
 
 Configuration Options
 ---------------------

docs/users_guide/tasks/climatologyMapSeaIceAlbedoSH.rst

@@ -11,7 +11,7 @@ part of the averaging period and albedo is not well-defined.
 Component and Tags::
 
   component: seaIce
-  tags: climatology, horizontalMap, seaIceBroadbandAlbedo, publicObs, snow
+  tags: climatology, horizontalMap, seaIceBroadbandAlbedo, publicObs, snow_on_sea_ice
 
 Configuration Options
 ---------------------

docs/users_guide/tasks/climatologyMapSeaIcePondAreaNH.rst

@@ -0,0 +1,67 @@
+.. _task_climatologyMapSeaIcePondAreaNH:
+
+climatologyMapSeaIcePondAreaNH
+=======================================
+
+An analysis task for plotting maps of Arctic sea ice pond area fraction.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIcePondArea, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIcePondAreaNH]
+  # options related to plotting horizontally remapped climatologies of
+  # pond area fraction against control model results and observations
+  # in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = deep
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0.001, 0.005, 0.01, 0.03, 0.05, 0.1, 0.2, 0.3, 0.4]
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesDifference = [0, 32, 64, 96, 128, 128, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-0.2, -0.1, -0.05, -0.01, -0.005, 0, 0.005, 0.01, 0.05, 0.1, 0.2]
+
+  # Months or seasons to plot
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['arctic_extended']
+
+  # a list of prefixes describing the sources of the observations to be used
+  observationPrefixes = ['']
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``vertical = True`` can be used to plot 3 panels one above another
+(resulting in a tall, thin image) rather than next to each other, the default
+(resulting in a short, wide image).
+
+For details on the remaining configration options, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Example Result
+--------------
+
+.. image:: examples/ice_pondarea_nh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIcePondAreaSH.rst

@@ -0,0 +1,67 @@
+.. _task_climatologyMapSeaIcePondAreaSH:
+
+climatologyMapSeaIcePondAreaSH
+=======================================
+
+An analysis task for plotting maps of Antarctic sea ice pond area fraction.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIcePondArea, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIcePondAreaSH]
+  # options related to plotting horizontally remapped climatologies of
+  # snow melt against control model results and observations
+  # in the southern hemisphere (SH)
+
+  # colormap for model/observations
+  colormapNameResult = deep
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0.001, 0.005, 0.01, 0.03, 0.05, 0.1, 0.2, 0.3, 0.4]
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesDifference = [0, 32, 64, 96, 128, 128, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-0.2, -0.1, -0.05, -0.01, -0.005, 0, 0.005, 0.01, 0.05, 0.1, 0.2]
+
+  # Months or seasons to plot
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'antarctic_extended') on which to plot analysis
+  comparisonGrids = ['antarctic_extended']
+
+  # a list of prefixes describing the sources of the observations to be used
+  observationPrefixes = ['']
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``vertical = True`` can be used to plot 3 panels one above another
+(resulting in a tall, thin image) rather than next to each other, the default
+(resulting in a short, wide image).
+
+For details on the remaining configration options, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Example Result
+--------------
+
+.. image:: examples/ice_pondarea_sh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceSnowMeltNH.rst

@@ -0,0 +1,67 @@
+.. _task_climatologyMapSeaIceSnowMeltNH:
+
+climatologyMapSeaIceSnowMeltNH
+=======================================
+
+An analysis task for plotting maps of Arctic sea ice cell-averaged snow melt rate.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceSnowMelt, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceSnowMeltNH]
+  # options related to plotting horizontally remapped climatologies of
+  # snow melt against control model results and observations
+  # in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = inferno
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0, 0.01, 0.02, 0.05, 0.1, 0.25, 0.5, 1., 1.5]
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesDifference = [0, 32, 64, 96, 128, 128, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-0.2, -0.1, -0.05, -0.01, -0.005, 0, 0.005, 0.01, 0.05, 0.1, 0.2]
+
+  # Months or seasons to plot
+  seasons =  ['ANN', 'FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['arctic_extended']
+
+  # a list of prefixes describing the sources of the observations to be used
+  observationPrefixes = ['']
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``vertical = True`` can be used to plot 3 panels one above another
+(resulting in a tall, thin image) rather than next to each other, the default
+(resulting in a short, wide image).
+
+For details on the remaining configration options, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Example Result
+--------------
+
+.. image:: examples/ice_snowmelt_nh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceSnowMeltSH.rst

@@ -0,0 +1,67 @@
+.. _task_climatologyMapSeaIceSnowMeltSH:
+
+climatologyMapSeaIceSnowMeltSH
+=======================================
+
+An analysis task for plotting maps of Antarctic sea ice cell-averaged snow melt rate.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceSnowMelt, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceSnowMeltSH]
+  # options related to plotting horizontally remapped climatologies of
+  # snow melt rate against control model results and observations
+  # in the southern hemisphere (SH)
+
+  # colormap for model/observations
+  colormapNameResult = inferno
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0, 0.01, 0.02, 0.05, 0.1, 0.25, 0.5, 1., 1.5]
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesDifference = [0, 32, 64, 96, 128, 128, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-0.2, -0.1, -0.05, -0.01, -0.005, 0, 0.005, 0.01, 0.05, 0.1, 0.2]
+
+  # Months or seasons to plot
+  seasons =  ['ANN', 'FM', 'ON']
+
+  # comparison grid(s) (typically 'antarctic_extended') on which to plot analysis
+  comparisonGrids = ['antarctic_extended']
+
+  # a list of prefixes describing the sources of the observations to be used
+  observationPrefixes = ['']
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``vertical = True`` can be used to plot 3 panels one above another
+(resulting in a tall, thin image) rather than next to each other, the default
+(resulting in a short, wide image).
+
+For details on the remaining configration options, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Example Result
+--------------
+
+.. image:: examples/ice_snowmelt_sh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceSnowiceFormationNH.rst

@@ -0,0 +1,67 @@
+.. _task_climatologyMapSeaIceSnowiceFormationNH:
+
+climatologyMapSeaIceSnowiceFormationNH
+=======================================
+
+An analysis task for plotting maps of Arctic sea ice cell-averaged snow-ice formation rate.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceSnowiceFormation, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceSnowiceFormationNH]
+  # options related to plotting horizontally remapped climatologies of
+  # snow-ice formation against control model results and observations
+  # in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = cork
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0, 0.01, 0.05, 0.1, 0.25, 0.5, 0.75, 1.0, 1.5]
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesDifference = [0, 32, 64, 96, 128, 128, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-0.2, -0.1, -0.05, -0.02, -0.01, 0, 0.01, 0.02, 0.05, 0.1, 0.2]
+
+  # Months or seasons to plot
+  seasons =  ['ANN', 'FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['arctic_extended']
+
+  # a list of prefixes describing the sources of the observations to be used
+  observationPrefixes = ['']
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``vertical = True`` can be used to plot 3 panels one above another
+(resulting in a tall, thin image) rather than next to each other, the default
+(resulting in a short, wide image).
+
+For details on the remaining configration options, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Example Result
+--------------
+
+.. image:: examples/ice_snowiceformation_nh.png
+   :width: 720 px
+   :align: center