update documentation

docs/authors.rst

@@ -19,6 +19,7 @@ Contributors
 * Greg Streletz
 * Adrian Turner
 * Luke Van Roekel
+* Elizabeth Hunke
 
 For a list of all the contributions:
 https://github.com/MPAS-Dev/MPAS-Analysis/graphs/contributors

docs/users_guide/analysis_tasks.rst

@@ -44,14 +44,33 @@ Analysis Tasks
    tasks/conservation
 
    tasks/climatologyMapSeaIceConcNH
-   tasks/climatologyMapSeaIceThickNH
    tasks/climatologyMapSeaIceConcSH
+   tasks/climatologyMapSeaIceThickNH
    tasks/climatologyMapSeaIceThickSH
-   tasks/timeSeriesSeaIceAreaVol
+   tasks/climatologyMapSeaIceSnowDepthNH
+   tasks/climatologyMapSeaIceSnowDepthSH
+
+   tasks/climatologyMapSeaIceAreaFractionRidgeNH
+   tasks/climatologyMapSeaIceAreaFractionRidgeSH
+   tasks/climatologyMapSeaIceVolumeRidgeNH
+   tasks/climatologyMapSeaIceVolumeRidgeSH
+   tasks/climatologyMapSeaIceAlbedoNH
+   tasks/climatologyMapSeaIceAlbedoSH
 
    tasks/climatologyMapSeaIceProductionNH
-   tasks/climatologyMapSeaIceMeltingNH
    tasks/climatologyMapSeaIceProductionSH
+   tasks/climatologyMapSeaIceMeltingNH
    tasks/climatologyMapSeaIceMeltingSH
 
+   tasks/climatologyMapSeaIceAreaTendencyThermoNH
+   tasks/climatologyMapSeaIceAreaTendencyThermoSH
+   tasks/climatologyMapSeaIceAreaTendencyTranspNH
+   tasks/climatologyMapSeaIceAreaTendencyTranspSH
+   tasks/climatologyMapSeaIceVolumeTendencyThermoNH
+   tasks/climatologyMapSeaIceVolumeTendencyThermoSH
+   tasks/climatologyMapSeaIceVolumeTendencyTranspNH
+   tasks/climatologyMapSeaIceVolumeTendencyTranspSH
+
+   tasks/timeSeriesSeaIceAreaVol
+
    tasks/climatologyMapIcebergConcSH

docs/users_guide/tasks/climatologyMapSeaIceAlbedoNH.rst

@@ -0,0 +1,72 @@
+.. _task_climatologyMapSeaIceAlbedoNH:
+
+climatologyMapSeaIceAlbedoNH
+==========================
+
+An analysis task for plotting maps of Arctic sea ice broadband albedo.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceBroadbandAlbedo, publicObs, snow
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceAlbedoNH]
+  ## options related to plotting horizontally remapped climatologies of
+  ## sea ice broadband albedo against control model results and observations
+  ## in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = lapaz
+  # 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.1, 0.3, 0.6, 0.7, 0.8, 0.9, 0.95, 0.98, 1.0]
+
+  # 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, 112, 128, 128, 144, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-1., -0.8, -0.6, -0.4, -0.2, -0.1, 0, 0.1, 0.2, 0.4, 0.6, 0.8, 1.]
+
+  # Times for comparison
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['arctic_extended']
+
+  # reference lat/lon for sea ice plots in the northern hemisphere
+  minimumLatitude = 50
+  referenceLongitude = 0
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``minimumLatitude`` determines what the southernmost latitude (in
+degrees) included in the plot will be.  The option ``referenceLongitude``
+defines which longitude will be at the bottom of the plot.
+
+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_albedo_nh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceAlbedoSH.rst

@@ -0,0 +1,72 @@
+.. _task_climatologyMapSeaIceAlbedoSH:
+
+climatologyMapSeaIceAlbedoSH
+============================
+
+An analysis task for plotting maps of Antarctic sea ice broadband albedo.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceBroadbandAlbedo, publicObs, snow
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceAlbedoSH]
+  ## options related to plotting horizontally remapped climatologies of
+  ## sea ice broadband albedo against control model results and observations
+  ## in the southern hemisphere (SH)
+
+  # colormap for model/observations
+  colormapNameResult = lapaz
+  # 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.1, 0.3, 0.6, 0.7, 0.8, 0.9, 0.95, 0.98, 1.0]
+
+  # 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, 112, 128, 128, 144, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-1., -0.8, -0.6, -0.4, -0.2, -0.1, 0, 0.1, 0.2, 0.4, 0.6, 0.8, 1.]
+
+  # Times for comparison
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['antarctic_extended']
+
+  # reference lat/lon for sea ice plots in the southern hemisphere
+  minimumLatitude = -50
+  referenceLongitude = 180
+
+  # arrange subplots vertically?
+  vertical = False
+
+The option ``minimumLatitude`` determines what the northernmost latitude (in
+degrees) included in the plot will be.  The option ``referenceLongitude``
+defines which longitude will be at the bottom of the plot.
+
+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_albedo_sh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceAreaFractionRidgeNH.rst

@@ -0,0 +1,64 @@
+.. _task_climatologyMapSeaIceAreaFractionRidgeNH:
+
+climatologyMapSeaIceAreaFractionRidgeNH
+=======================================
+
+An analysis task for plotting maps of Arctic sea ice ridged area fraction.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceAreaFractionRidge, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceAreaFractionRidgeNH]
+  ## options related to plotting horizontally remapped climatologies of
+  ## ridged area fraction of sea ice
+  ## in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = tokyo
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 50, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1]
+
+  # 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, 112, 128, 128, 144, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-1., -0.8, -0.6, -0.4, -0.2, -0.1, 0, 0.1, 0.2, 0.4, 0.6, 0.8, 1.]
+
+  # Times for comparison
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['antarctic_extended']
+
+  # 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_ridgearea_nh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceAreaFractionRidgeSH.rst

@@ -0,0 +1,64 @@
+.. _task_climatologyMapSeaIceAreaFractionRidgeSH:
+
+climatologyMapSeaIceAreaFractionRidgeSH
+=======================================
+
+An analysis task for plotting maps of Antarctic sea ice ridged area fraction.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceAreaFractionRidge, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceAreaFractionRidgeSH]
+  ## options related to plotting horizontally remapped climatologies of
+  ## ridged area fraction of sea ice
+  ## in the southern hemisphere (SH)
+
+  # colormap for model/observations
+  colormapNameResult = tokyo
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [20, 50, 80, 110, 140, 170, 200, 230, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1]
+
+  # 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, 112, 128, 128, 144, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-1., -0.8, -0.6, -0.4, -0.2, -0.1, 0, 0.1, 0.2, 0.4, 0.6, 0.8, 1.]
+
+  # Times for comparison
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['antarctic_extended']
+
+  # 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_ridgearea_sh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceAreaTendencyThermoNH.rst

@@ -0,0 +1,64 @@
+.. _task_climatologyMapSeaIceAreaTendencyThermoNH:
+
+climatologyMapSeaIceAreaTendencyThermoNH
+========================================
+
+An analysis task for plotting maps of Arctic sea ice area tendency due to thermodynamics.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceAreaTendencyThermodynamics, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceAreaTendencyThermoNH]
+  ## options related to plotting horizontally remapped climatologies of
+  ## sea ice area tendency due to thermodynamics against control model results and observations
+  ## in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = curl
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = indexed
+  # color indices into colormapName for filled contours
+  colormapIndicesResult = [0, 32, 64, 96, 112, 128, 128, 144, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsResult = [-5., -4., -3., -2., -1., -0.5, 0, 0.5, 1., 2., 3., 4., 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, 112, 128, 128, 144, 160, 192, 224, 255]
+  # colormap levels/values for contour boundaries
+  colorbarLevelsDifference = [-1., -0.8, -0.6, -0.4, -0.2, -0.1, 0, 0.1, 0.2, 0.4, 0.6, 0.8, 1.]
+
+  # Times for comparison
+  seasons =  ['FM', 'ON']
+
+  # comparison grid(s) (typically 'arctic_extended') on which to plot analysis
+  comparisonGrids = ['arctic_extended']
+
+  # 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_areatendthermo_nh.png
+   :width: 720 px
+   :align: center