Add analysis task for waves

docs/developers_guide/api.rst

@@ -72,6 +72,7 @@ Ocean tasks
    ClimatologyMapSose
    ClimatologyMapArgoTemperature
    ClimatologyMapArgoSalinity
+   ClimatologyMapWaves
    IndexNino34
    MeridionalHeatTransport
    StreamfunctionMOC

docs/users_guide/analysis_tasks.rst

@@ -18,6 +18,7 @@ Analysis Tasks
    tasks/climatologyMapWoa
    tasks/climatologyMapSchmidtko
    tasks/climatologyMapAntarcticMelt
+   tasks/climatologyMapWaves
 
    tasks/hovmollerOceanRegions
    tasks/timeSeriesAntarcticMelt

docs/users_guide/tasks/climatologyMapWaves.rst

@@ -0,0 +1,108 @@
+.. _task_climatologyMapWaves:
+
+climatologyMapWaves
+===================
+
+An analysis task for comparison of global maps of wave quantities
+(significant wave height and peak period) against observations.
+
+Component and Tags::
+
+  component: ocean
+  tags: climatology, horizontalMap, waves
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+  [climatologyMapWaves]
+  ## options related to plotting climatology maps of wave fields
+  ## ERA5 climatological data
+
+  # comparison grid(s) on which to plot analysis
+  comparisonGrids = ['latlon']
+
+  # Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
+  # Nov, Dec, JFM, AMJ, JAS, OND, ANN)
+  seasons =  ['ANN', 'JFM', 'JAS']
+
+  # a list of fields to plot ('significantWaveHeight', 'peakWavePeriod')
+  fieldList = ['significantWaveHeight', 'peakWavePeriod']
+
+  era5ObsStartYear = 1959
+  era5ObsEndYear = 2021 
+  sscciObsStartYear = 1991
+  sscciObsEndYear = 2018
+
+  [climatologyMapWavesSignificantWaveHeight]
+  ## options related to plotting climatology maps of significant wave height
+
+  # colormap for model/observations
+  colormapNameResult = viridis 
+  # 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': 7.}
+  # place the ticks automatically by default
+  # colorbarTicksResult = numpy.linspace(-2., 10., 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': -5., 'vmax': 5.}
+  # place the ticks automatically by default
+  # colorbarTicksDifference = numpy.linspace(-5., 5., 9)
+
+  [climatologyMapWavesPeakWavePeriod]
+  ## options related to plotting climatology maps of peak wave frequency
+
+  # colormap for model/observations
+  colormapNameResult = plasma 
+  # 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.0, 'vmax':15.0}
+  # place the ticks automatically by default
+  # colorbarTicksResult = numpy.linspace(-2., 10., 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': -5., 'vmax': 5.}
+  # place the ticks automatically by default
+  # colorbarTicksDifference = numpy.linspace(-5., 5., 9)
+
+For more details, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Observations
+------------
+
+:ref:`era5_waves`
+:ref:`sscci_waves`
+
+Example Result
+--------------
+
+.. image:: examples/swh.png
+   :width: 500 px
+   :align: center
+
+.. image:: examples/peak_period.png
+   :width: 500 px
+   :align: center

mpas_analysis/__main__.py

@@ -266,6 +266,11 @@ def build_analysis_list(config, controlConfig):
         config=config, mpasClimatologyTask=seaIceClimatologyTask,
         hemisphere='SH', controlConfig=controlConfig))
 
+    # Wave Analyses
+    analyses.append(ocean.ClimatologyMapWaves(
+        config, oceanClimatologyTasks['avg'], oceanRegionMasksTask,
+        controlConfig))
+
     check_for_duplicate_names(analyses)
 
     return analyses

mpas_analysis/default.cfg

@@ -520,6 +520,8 @@ alkSubdirectory = BGC/ALK
 ph_3dSubdirectory = BGC/pH_3D
 pco2surfaceSubdirectory = BGC/pCO2surface
 chlSubdirectory = BGC/Chl
+era5Subdirectory = ERA5
+sscciSubdirectory = SSCCI
 
 # interpolation order for observations. Likely values are
 #   'bilinear', 'neareststod' (nearest neighbor) or 'conserve'
@@ -2158,6 +2160,74 @@ normArgsDifference = {'vmin': -0.2, 'vmax': 0.2}
 # determine the ticks automatically by default, uncomment to specify
 # colorbarTicksDifference = numpy.linspace(-0.2, 0.2, 9)
 
+[climatologyMapWaves]
+## options related to plotting climatology maps of wave fields
+## ERA5 climatological data
+
+# comparison grid(s) on which to plot analysis
+comparisonGrids = ['latlon']
+
+# Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
+# Nov, Dec, JFM, AMJ, JAS, OND, ANN)
+seasons =  ['ANN', 'JFM', 'JAS']
+
+# a list of fields to plot ('significantWaveHeight', 'peakWavePeriod')
+fieldList = ['significantWaveHeight', 'peakWavePeriod']
+
+era5ObsStartYear = 1959
+era5ObsEndYear = 2021 
+sscciObsStartYear = 1991
+sscciObsEndYear = 2018
+
+[climatologyMapWavesSignificantWaveHeight]
+## options related to plotting climatology maps of significant wave height
+
+# colormap for model/observations
+colormapNameResult = viridis 
+# 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': 7.}
+# place the ticks automatically by default
+# colorbarTicksResult = numpy.linspace(-2., 10., 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': -5., 'vmax': 5.}
+# place the ticks automatically by default
+# colorbarTicksDifference = numpy.linspace(-5., 5., 9)
+
+[climatologyMapWavesPeakWavePeriod]
+## options related to plotting climatology maps of peak wave frequency
+
+# colormap for model/observations
+colormapNameResult = plasma 
+# 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.0, 'vmax':15.0}
+# place the ticks automatically by default
+# colorbarTicksResult = numpy.linspace(-2., 10., 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': -5., 'vmax': 5.}
+# place the ticks automatically by default
+# colorbarTicksDifference = numpy.linspace(-5., 5., 9)
 
 [climatologyMapWoa]
 ## options related to plotting climatology maps of Temperature and Salinity

mpas_analysis/obs/analysis_input_files

@@ -61,6 +61,9 @@ observations/Ocean/ARGO/README.md
 observations/Ocean/EKE/obs.bib
 observations/Ocean/EKE/README.md
 observations/Ocean/EKE/drifter_variance_20180804.nc
+observations/Ocean/ERA5/ERA5_Monthly_1959-2021.nc 
+observations/Ocean/ERA5/obs.bib
+observations/Ocean/ERA5/README.md
 observations/Ocean/SSH/obs.bib
 observations/Ocean/SSH/README.md
 observations/Ocean/SSH/zos_AVISO_L4_199210-201012_20180710.nc
@@ -109,6 +112,9 @@ observations/Ocean/Nino/ERS_SSTv4/README.md
 observations/Ocean/MLD/obs.bib
 observations/Ocean/MLD/holtetalley_mld_climatology_20180710.nc
 observations/Ocean/MLD/README.md
+observations/Ocean/SSCCI/obs.bib
+observations/Ocean/SSCCI/README.md
+observations/Ocean/SSCCI/SS_CCI_1991_2018.nc
 observations/Ocean/SSS/obs.bib
 observations/Ocean/SSS/Aquarius_V3_SSS_Monthly_20180710.nc
 observations/Ocean/SSS/README.md