Merge pull request #920 from darincomeau/add_seaice_production_docs

Add docs and examples for sea ice production tasks

docs/users_guide/analysis_tasks.rst

@@ -42,4 +42,9 @@ Analysis Tasks
    tasks/climatologyMapSeaIceThickSH
    tasks/timeSeriesSeaIceAreaVol
 
+   tasks/climatologyMapSeaIceProductionNH
+   tasks/climatologyMapSeaIceMeltingNH
+   tasks/climatologyMapSeaIceProductionSH
+   tasks/climatologyMapSeaIceMeltingSH
+
    tasks/climatologyMapIcebergConcSH

docs/users_guide/tasks/climatologyMapSeaIceMeltingNH.rst

@@ -0,0 +1,78 @@
+.. _task_climatologyMapSeaIceMeltingNH:
+
+climatologyMapSeaIceMeltingNH
+=============================
+
+An analysis task for plotting maps of Arctic sea ice melting.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceMelting, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceMeltingNH]
+  # options related to plotting horizontally remapped climatologies of
+  # sea ice melting against control model results and observations
+  # in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = amp
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = continuous
+  # the type of norm used in the colormap
+  normTypeResult = linear
+  # A dictionary with keywords for the norm
+  normArgsResult = {'vmin': 0., 'vmax': 5.}
+  # place the ticks automatically by default
+  # colorbarTicksResult = numpy.linspace(-2., 2., 9)
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = continuous
+  # the type of norm used in the colormap
+  normTypeDifference = linear
+  # A dictionary with keywords for the norm
+  normArgsDifference = {'vmin': -3., 'vmax': 3.}
+  # place the ticks automatically by default
+  colorbarTicksDifference = [-3, -2, -1, 0, 1, 2, 3]
+
+  # Times for comparison times
+  seasons =  ['ANN', 'DJF', 'JJA']
+
+  # comparison grid(s) ('latlon', 'antarctic') on which to plot analysis
+  comparisonGrids = ['latlon']
+
+  # 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 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_melting_nh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceMeltingSH.rst

@@ -0,0 +1,88 @@
+.. _task_climatologyMapSeaIceMeltingSH:
+
+climatologyMapSeaIceMeltingSH
+=============================
+
+An analysis task for plotting maps of Antarctic sea ice melting against
+observations.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceMelting, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceMeltingSH]
+  # options related to plotting horizontally remapped climatologies of
+  # sea ice melting against control model results and observations
+  # in the southern hemisphere (SH)
+
+  # colormap for model/observations
+  colormapNameResult = amp
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = continuous
+  # the type of norm used in the colormap
+  normTypeResult = linear
+  # A dictionary with keywords for the norm
+  normArgsResult = {'vmin': 0., 'vmax': 5.}
+  # place the ticks automatically by default
+  # colorbarTicksResult = numpy.linspace(-2., 2., 9)
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = continuous
+  # the type of norm used in the colormap
+  normTypeDifference = linear
+  # A dictionary with keywords for the norm
+  normArgsDifference = {'vmin': -3., 'vmax': 3.}
+  # place the ticks automatically by default
+  colorbarTicksDifference = [-3, -2, -1, 0, 1, 2, 3]
+
+  # Times for comparison times
+  seasons =  ['ANN', 'DJF', 'JJA']
+
+  # comparison grid(s) ('latlon', 'antarctic') on which to plot analysis
+  comparisonGrids = ['latlon']
+
+  # reference lat/lon for sea ice plots in the northern hemisphere
+  minimumLatitude = -50
+  referenceLongitude = 180
+
+  # arrange subplots vertically?
+  vertical = False
+
+  # observations files
+  meltingSH = AnIceFlux/aniceflux_v01_clim_mean_1982-2008.nc
+
+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.
+
+By default, plots are produced comparing modeled sea ice melting against
+``AnIceFlux`` (annual climatology only).
+
+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`
+
+Observations
+------------
+
+* :ref:`aniceflux`
+
+Example Result
+--------------
+
+.. image:: examples/ice_melting_sh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceProductionNH.rst

@@ -0,0 +1,78 @@
+.. _task_climatologyMapSeaIceProductionNH:
+
+climatologyMapSeaIceProductionNH
+================================
+
+An analysis task for plotting maps of Arctic sea ice production.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceProduction, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceProductionNH]
+  # options related to plotting horizontally remapped climatologies of
+  # sea ice production against control model results and observations
+  # in the northern hemisphere (NH)
+
+  # colormap for model/observations
+  colormapNameResult = dense
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = continuous
+  # the type of norm used in the colormap
+  normTypeResult = linear
+  # A dictionary with keywords for the norm
+  normArgsResult = {'vmin': 0., 'vmax': 5.}
+  # place the ticks automatically by default
+  # colorbarTicksResult = numpy.linspace(-2., 2., 9)
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = continuous
+  # the type of norm used in the colormap
+  normTypeDifference = linear
+  # A dictionary with keywords for the norm
+  normArgsDifference = {'vmin': -3., 'vmax': 3.}
+  # place the ticks automatically by default
+  colorbarTicksDifference = [-3, -2, -1, 0, 1, 2, 3]
+
+  # Times for comparison times
+  seasons =  ['ANN', 'DJF', 'JJA']
+
+  # comparison grid(s) ('latlon', 'antarctic') on which to plot analysis
+  comparisonGrids = ['latlon']
+
+  # 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 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_production_nh.png
+   :width: 720 px
+   :align: center

docs/users_guide/tasks/climatologyMapSeaIceProductionSH.rst

@@ -0,0 +1,88 @@
+.. _task_climatologyMapSeaIceProductionSH:
+
+climatologyMapSeaIceProductionSH
+================================
+
+An analysis task for plotting maps of Antarctic sea ice production against
+observations.
+
+Component and Tags::
+
+  component: seaIce
+  tags: climatology, horizontalMap, seaIceProduction, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapSeaIceProductionSH]
+  # options related to plotting horizontally remapped climatologies of
+  # sea ice production against control model results and observations
+  # in the southern hemisphere (SH)
+
+  # colormap for model/observations
+  colormapNameResult = dense
+  # whether the colormap is indexed or continuous
+  colormapTypeResult = continuous
+  # the type of norm used in the colormap
+  normTypeResult = linear
+  # A dictionary with keywords for the norm
+  normArgsResult = {'vmin': 0., 'vmax': 5.}
+  # place the ticks automatically by default
+  # colorbarTicksResult = numpy.linspace(-2., 2., 9)
+
+  # colormap for differences
+  colormapNameDifference = balance
+  # whether the colormap is indexed or continuous
+  colormapTypeDifference = continuous
+  # the type of norm used in the colormap
+  normTypeDifference = linear
+  # A dictionary with keywords for the norm
+  normArgsDifference = {'vmin': -3., 'vmax': 3.}
+  # place the ticks automatically by default
+  colorbarTicksDifference = [-3, -2, -1, 0, 1, 2, 3]
+
+  # Times for comparison times
+  seasons =  ['ANN', 'DJF', 'JJA']
+
+  # comparison grid(s) ('latlon', 'antarctic') on which to plot analysis
+  comparisonGrids = ['latlon']
+
+  # reference lat/lon for sea ice plots in the northern hemisphere
+  minimumLatitude = -50
+  referenceLongitude = 180
+
+  # arrange subplots vertically?
+  vertical = False
+
+  # observations files
+  productionSH = AnIceFlux/aniceflux_v01_clim_mean_1982-2008.nc
+
+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.
+
+By default, plots are produced comparing modeled sea ice production against
+``AnIceFlux`` (annual climatology only).
+
+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`
+
+Observations
+------------
+
+* :ref:`aniceflux`
+
+Example Result
+--------------
+
+.. image:: examples/ice_production_sh.png
+   :width: 720 px
+   :align: center