oceanspy.animate.horizontal_section

oceanspy.animate.horizontal_section(od, display=True, FuncAnimation_kwargs=None, **kwargs)[source]

Animate horizontal section plots.

Parameters:
od: OceanDataset

oceandataset used to plot.

display: bool

If True, display the animation.

FuncAnimation_kwargs: dict

Keyword arguments from matplotlib.animation.FuncAnimation()

**kwargs:

Keyword arguments from oceanspy.plot.horizontal_section()

Returns:
anim: matplotlib.animation.FuncAnimation

Animation object