compass.ocean.tests.isomip_plus.viz.plot.MoviePlotter

class compass.ocean.tests.isomip_plus.viz.plot.MoviePlotter(inFolder, streamfunctionFolder, outFolder, expt, sectionY, dsMesh, ds, showProgress)[source]

A plotter object to hold on to some info needed for plotting images from ISOMIP+ simulation results

Variables:

  • inFolder (str) – The folder with simulation results

  • streamfunctionFolder (str) – The folder where streamfunction input files were computed

  • outFolder (str) – The folder where images will be written

  • expt ({'Ocean0', 'Ocean1', 'Ocean2'}) – The name of the experiment

  • sectionY (float) – The location along the y axis of a transect in the x-z plane to plot

  • dsMesh (xarray.Dataset) – A data set with mesh data

  • ds (xarray.Dataset) – A data set with the montly-mean simulation results

  • oceanMask (numpy.ndarray) – A mask of cells that are in the ocean domain (probably all ones)

  • cavityMask (numpy.ndarray) – A mask of cells that are in the sub-ice-shelf cavity

  • oceanPatches (PatchCollection) – A set of polygons covering ocean cells

  • cavityPatches (PatchCollection) – A set of polygons covering only cells in the cavity

  • Z (X,) – The horiz. and vert. coordinates of the x-z cross section

  • sectionMask (numpy.ndarray) – A mask for the cross section indicating where values are valid (i.e. above the bathymetry)

  • showProgress (bool) – Whether to show a progressbar

__init__(inFolder, streamfunctionFolder, outFolder, expt, sectionY, dsMesh, ds, showProgress)[source]

Create a plotter object to hold on to some info needed for plotting images from ISOMIP+ simulation results

Parameters:

  • inFolder (str) – The folder with simulation results

  • streamfunctionFolder (str) – The folder where streamfunction input files were computed

  • outFolder (str) – The folder where images will be written

  • expt ({'Ocean0', 'Ocean1', 'Ocean2'}) – The name of the experiment

  • sectionY (float) – The location along the y axis of a transect in the x-z plane to plot

  • dsMesh (xarray.Dataset) – The MPAS mesh

  • ds (xarray.Dataset) – The time series output

  • showProgress (bool) – Whether to show a progressbar

Methods

__init__(inFolder, streamfunctionFolder, ...)

Create a plotter object to hold on to some info needed for plotting images from ISOMIP+ simulation results

images_to_movies(outFolder[, ...])

Convert all the image sequences into movies with ffmpeg

plot_3d_field_top_bot_section(da, ...[, ...])

Plot a series of images of a given 3D variable showing the value at the top (sea surface or ice-ocean interface), sea floor and in an x-z section

plot_barotropic_streamfunction([vmin, vmax])

Plot a series of image of the barotropic streamfunction

plot_haney_number([haneyFolder])

Plot a series of images of the Haney number rx1 at the sea surface or ice-ocean interface, sea floor and in an x-z section

plot_horiz_series(da, nameInTitle, prefix, ...)

Plot a series of image of a given variable

plot_ice_shelf_boundary_variables()

Plot a series of image for each of several variables related to the ice shelf-ocean interface: heat flux from the ocean, heat flux into the ice, thermal driving, haline driving, and the friction velocity under ice

plot_layer_interfaces([figsize])

Plot layer interfaces, the sea surface height and the bottom topography of the cross section at fixed y.

plot_melt_rates([vmin, vmax])

Plot a series of image of the melt rate

plot_overturning_streamfunction([vmin, vmax])

Plot a series of image of the overturning streamfunction

plot_potential_density()

Plot a series of images of salinity at the sea surface or ice-ocean interface, sea floor and in an x-z section

plot_salinity()

Plot a series of images of salinity at the sea surface or ice-ocean interface, sea floor and in an x-z section

plot_temperature()

Plot a series of images of temperature at the sea surface or ice-ocean interface, sea floor and in an x-z section

update_date(tIndex)