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 usingvmin
andvmax
. Note that thedensity
keyword can greaty affect plotting speed. If the domain plotted is not square, you may also want to setdensity
as a tuple proportional to the axes aspect ratio.- Returns:
streamlines (
StreamplotSet
) – The plotted surface velocity streamlines.