# Copyright (c) 2017, Los Alamos National Security, LLC (LANS)
# and the University Corporation for Atmospheric Research (UCAR).
#
# Unless noted otherwise source code is licensed under the BSD license.
# Additional copyright and license information can be found in the LICENSE file
# distributed with this code, or at http://mpas-dev.github.com/license.html
#
import xarray as xr
from pyremap import LatLonGridDescriptor
from mpas_analysis.shared import AnalysisTask
from mpas_analysis.shared.climatology import RemapMpasClimatologySubtask, \
RemapObservedClimatologySubtask
from mpas_analysis.shared.plot import PlotClimatologyMapSubtask
from mpas_analysis.shared.io.utility import build_obs_path
[docs]
class ClimatologyMapIcebergConc(AnalysisTask):
"""
An analysis task for comparison of iceberg concentration against
observations
"""
# Authors
# -------
# Darin Comeau, Xylar Asay-Davis
[docs]
def __init__(self, config, mpasClimatologyTask, hemisphere,
controlConfig=None):
"""
Construct the analysis task.
Parameters
----------
config : mpas_tools.config.MpasConfigParser
Configuration options
mpasClimatologyTask : ``MpasClimatologyTask``
The task that produced the climatology to be remapped and plotted
hemisphere : {'NH', 'SH'}
The hemisphere to plot
controlconfig : mpas_tools.config.MpasConfigParser, optional
Configuration options for a control run (if any)
"""
# Authors
# -------
# Darin Comeau, Xylar Asay-Davis
taskName = 'climatologyMapIcebergConc{}'.format(hemisphere)
fieldName = 'IcebergConc'
tags = ['icebergs', 'climatology', 'horizontalMap', fieldName]
if hemisphere == 'NH':
tags = tags + ['arctic']
else:
tags = tags + ['antarctic']
# call the constructor from the base class (AnalysisTask)
super(ClimatologyMapIcebergConc, self).__init__(
config=config, taskName=taskName,
componentName='seaIce',
tags=tags)
mpasFieldName = 'timeMonthly_avg_bergAreaCell'
iselValues = None
sectionName = taskName
if hemisphere == 'NH':
hemisphereLong = 'Northern'
else:
hemisphereLong = 'Southern'
# read in what seasons we want to plot
seasons = config.getexpression(sectionName, 'seasons')
if len(seasons) == 0:
raise ValueError('config section {} does not contain valid list '
'of seasons'.format(sectionName))
comparisonGridNames = config.getexpression(sectionName,
'comparisonGrids')
if len(comparisonGridNames) == 0:
raise ValueError('config section {} does not contain valid list '
'of comparison grids'.format(sectionName))
# the variable self.mpasFieldName will be added to mpasClimatologyTask
# along with the seasons.
remapClimatologySubtask = RemapMpasClimatologySubtask(
mpasClimatologyTask=mpasClimatologyTask,
parentTask=self,
climatologyName='{}{}'.format(fieldName, hemisphere),
variableList=[mpasFieldName],
comparisonGridNames=comparisonGridNames,
seasons=seasons,
iselValues=iselValues)
if controlConfig is None:
refTitleLabel = 'Observations (Altiberg)'
galleryName = 'Observations: Altiberg'
diffTitleLabel = 'Model - Observations'
refFieldName = 'icebergConc'
obsFileName = build_obs_path(
config, 'iceberg',
'concentrationAltiberg{}'.format(hemisphere))
remapObservationsSubtask = RemapAltibergConcClimatology(
parentTask=self, seasons=seasons,
fileName=obsFileName,
outFilePrefix='{}{}'.format(refFieldName,
hemisphere),
comparisonGridNames=comparisonGridNames)
self.add_subtask(remapObservationsSubtask)
else:
controlRunName = controlConfig.get('runs', 'mainRunName')
galleryName = None
refTitleLabel = 'Control: {}'.format(controlRunName)
refFieldName = mpasFieldName
diffTitleLabel = 'Main - Control'
remapObservationsSubtask = None
for season in seasons:
for comparisonGridName in comparisonGridNames:
imageCaption = \
'{} Climatology Map of {}-Hemisphere Iceberg ' \
'Concentration.'.format(season, hemisphereLong)
galleryGroup = \
'{}-Hemisphere Iceberg Concentration'.format(
hemisphereLong)
# make a new subtask for this season and comparison grid
subtask = PlotClimatologyMapSubtask(
parentTask=self, season=season,
comparisonGridName=comparisonGridName,
remapMpasClimatologySubtask=remapClimatologySubtask,
remapObsClimatologySubtask=remapObservationsSubtask,
controlConfig=controlConfig)
subtask.set_plot_info(
outFileLabel='bergconc{}'.format(hemisphere),
fieldNameInTitle='Iceberg concentration',
mpasFieldName=mpasFieldName,
refFieldName=refFieldName,
refTitleLabel=refTitleLabel,
diffTitleLabel=diffTitleLabel,
unitsLabel=r'fraction',
imageCaption=imageCaption,
galleryGroup=galleryGroup,
groupSubtitle=None,
groupLink='{}_conc'.format(hemisphere.lower()),
galleryName=galleryName,
extend='neither')
self.add_subtask(subtask)
class RemapAltibergConcClimatology(RemapObservedClimatologySubtask):
"""
A subtask for reading and remapping iceberg concentration from Altiberg
observations
"""
# Authors
# -------
# Darin Comeau, Xylar Asay-Davis
def get_observation_descriptor(self, fileName):
"""
get a MeshDescriptor for the observation grid
Parameters
----------
fileName : str
observation file name describing the source grid
Returns
-------
obsDescriptor : ``MeshDescriptor``
The descriptor for the observation grid
"""
# Authors
# -------
# Darin Comeau, Xylar Asay-Davis
# create a descriptor of the observation grid using the lat/lon
# coordinates
obsDescriptor = LatLonGridDescriptor.read(fileName=fileName,
latVarName='latitude',
lonVarName='longitude')
return obsDescriptor
def build_observational_dataset(self, fileName):
"""
read in the data sets for observations, and possibly rename some
variables and dimensions
Parameters
----------
fileName : str
observation file name
Returns
-------
dsObs : ``xarray.Dataset``
The observational dataset
"""
# Authors
# -------
# Darin Comeau, Xylar Asay-Davis
dsObs = xr.open_dataset(fileName)
dsObs = dsObs.rename({'probability': 'icebergConc', 'time': 'Time'})
dsObs.coords['month'] = dsObs['Time.month']
dsObs.coords['year'] = dsObs['Time.year']
dsObs = dsObs.transpose('Time', 'latitude', 'longitude')
return dsObs