livvext.compare_gridded

module documentation
(source)

Compare up to three gridded datasets. Typically one "Model" and 1 or 2 "Observations"

Function add_colorbar Add colorbar to figure.
Function annotate_plot Add land / ocean, gridlines, colourbar.
Function crop_ais Make AIS plots a circle.
Function get_figure Set up figure based on number of datasets to be plotted.
Function main Generate comparison plots for a particular season.
Constant DESCRIBE_COMPONENTS Undocumented
Constant IMG_GROUP Undocumented
def add_colorbar(color_field, fig, axis, cblabel, cbar_span=False, ndsets=3): (source)

Add colorbar to figure.

def annotate_plot(axis, color_field=None, fig=None, label=None, ylabel=None, xlabel=None, cblabel=None, cnrtxt=None, gridline_args=None, icesheet='gis'): (source)

Add land / ocean, gridlines, colourbar.

def crop_ais(axis, radius=0.5): (source)

Make AIS plots a circle.

def get_figure(n_dsets, proj=None, icesheet='gis'): (source)

Set up figure based on number of datasets to be plotted.

def main(args, config, sea='ANN'): (source)

Generate comparison plots for a particular season.

Parameters
args:argparse.NamespaceCommand line arguments
config:dictLIVVkit configuration dictionary
sea:str, optional"Season" identifier, either DJF, MAM, JJA, SON, ANN, or 1--12 for monthly data, by default "ANN"
Returns
list, dictReturns the list of livvkit.elements
Raises
NotImplementedError_description_
DESCRIBE_COMPONENTS: str = (source)

Undocumented

Value
'''
{component} component of SMB from {model}, {dset_a}, {dset_b}
'''
IMG_GROUP: str = (source)

Undocumented

Value
'components'