Reference Documentation¶
Cube Browser API¶
-
class
cube_browser.
Browser
(plots)¶ Compiler for cube_browser plots and associated sliders.
Compiles a single cube_browser plot instance or list of instances into a vertical arrangement of axes with shared coordinate sliders, to be displayed in a Jupyter notebook.
-
on_change
(change)¶ Common slider widget traitlet event handler that refreshes all appropriate plots given a slider state change.
-
-
class
cube_browser.
Contour
(cube, axes, **kwargs)¶ Constructs a line contour plot instance of a cube.
An
iris.plot.contour()
instance is created using coordinates specified in the input arguments as axes coordinates.See
matplotlib.pyplot.contour()
andiris.plot.contour()
for details of other valid keyword arguments.
-
class
cube_browser.
Contourf
(cube, axes, **kwargs)¶ Constructs a filled contour plot instance of a cube.
An
iris.plot.contourf()
instance is created using coordinates specified in the input arguments as axes coordinates.See
matplotlib.pyplot.contourf()
andiris.plot.contourf()
for details of other valid keyword arguments
-
class
cube_browser.
Pcolormesh
(cube, axes, **kwargs)¶ Constructs a pseduocolour plot instance of a cube on a quadrilateral mesh.
An
iris.plot.pcolormesh()
instance is created using coordinates specified in the input arguments as axes coordinates.See
matplotlib.pyplot.pcolormesh()
andiris.plot.pcolormesh()
for details of other valid keyword arguments.
Explorer¶
-
class
cube_browser.explorer.
Explorer
¶ IPyWidgets and workflow for exploring collections of cubes.
-
cubes
¶ The list of cubes the explorer is currently working with.
-
mpl_kwargs
¶ The list of dictionaries of matplotlib keyword arguements in use the PlotControls.
-