xarray.Dataset.hyoga.plot.surface_velocity_streamplot#

Dataset.hyoga.plot.surface_velocity_streamplot(**kwargs)#

Plot surface velocity streamlines.

Parameters

**kwargs (optional) – Keyword arguments passed to matplotlib.Axes.streamplot(). Defaults to a blue colormap and logarithmic scaling, whose limits can be adjusted using vmin and vmax. Note that the density keyword can greaty affect plotting speed. If the domain plotted is not square, you may also want to set density as a tuple proportional to the axes aspect ratio.

Returns

streamlines (StreamplotSet) – The plotted surface velocity streamlines.