Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional MPAS-seaice plots for snow analyses #1036

Merged
merged 12 commits into from
Nov 28, 2024
Merged
1 change: 1 addition & 0 deletions docs/authors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
10 changes: 10 additions & 0 deletions docs/developers_guide/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,16 @@ Sea ice tasks

ClimatologyMapSeaIceConc
ClimatologyMapSeaIceThick
ClimatologyMapSeaIceSnowDepth
ClimatologyMapSeaIceAreaFractionRidge
ClimatologyMapSeaIceVolumeRidge
ClimatologyMapSeaIceAlbedo
ClimatologyMapSeaIceProduction
ClimatologyMapSeaIceMelting
ClimatologyMapSeaIceAreaTendencyThermo
ClimatologyMapSeaIceAreaTendencyTransp
ClimatologyMapSeaIceVolumeTendencyThermo
ClimatologyMapSeaIceVolumeTendencyTransp
TimeSeriesSeaIce
ClimatologyMapIcebergConc

Expand Down
25 changes: 22 additions & 3 deletions docs/users_guide/analysis_tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
75 changes: 75 additions & 0 deletions docs/users_guide/tasks/climatologyMapSeaIceAlbedoNH.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
.. _task_climatologyMapSeaIceAlbedoNH:

climatologyMapSeaIceAlbedoNH
==========================

An analysis task for plotting maps of Arctic sea ice broadband albedo.
Care must be taken when evaluating albedo - long-time averages do not
make a lot of sense, especially when the sun is below the horizon for
part of the averaging period and albedo is not well-defined.

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
75 changes: 75 additions & 0 deletions docs/users_guide/tasks/climatologyMapSeaIceAlbedoSH.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
.. _task_climatologyMapSeaIceAlbedoSH:

climatologyMapSeaIceAlbedoSH
============================

An analysis task for plotting maps of Antrctic sea ice broadband albedo.
Care must be taken when evaluating albedo - long-time averages do not
make a lot of sense, especially when the sun is below the horizon for
part of the averaging period and albedo is not well-defined.

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
64 changes: 64 additions & 0 deletions docs/users_guide/tasks/climatologyMapSeaIceAreaFractionRidgeNH.rst
Original file line number Diff line number Diff line change
@@ -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
64 changes: 64 additions & 0 deletions docs/users_guide/tasks/climatologyMapSeaIceAreaFractionRidgeSH.rst
Original file line number Diff line number Diff line change
@@ -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
Loading