easyclimate.plot.mpas.cell_quiver

Quiver plots for MPAS cell winds.

Functions

plot_cell_quiver(ds, u_da, v_da, *[, ax, lon_min, ...])

Plot cell-centered vector wind on MPAS mesh.

Module Contents

easyclimate.plot.mpas.cell_quiver.plot_cell_quiver(ds, u_da, v_da, *, ax=None, lon_min=None, lon_max=None, lat_min=None, lat_max=None, center_lon=None, input_radians=True, lon_name_cell='lonCell', lat_name_cell='latCell', nx_bins=35, ny_bins=20, thin_method='nearest_center', use_thinning_cache=True, add_quiverkey=True, quiverkey_value=None, quiverkey_label=None, quiverkey_x=0.88, quiverkey_y=1.04, transform=None, regrid_shape=None, regrid_global_epsilon=1e-06, title=None, **quiver_kwargs)

Plot cell-centered vector wind on MPAS mesh.

Parameters

dsxarray.Dataset

MPAS dataset containing cell coordinate variables.

u_da, v_daxarray.DataArray or numpy.ndarray

Cell-centered zonal/eastward and meridional/northward vector components. Each input must be one-dimensional on nCells after selection.

axmatplotlib.axes.Axes, optional

Axes on which to draw. By default, use the current axes.

lon_min, lon_max, lat_min, lat_maxfloat

Plot extent in degrees. These bounds are required so vector thinning is robust on variable-resolution meshes.

center_lonfloat, optional

Longitude center used for wrapping. If None, infer it from the extent or valid cell centers.

input_radiansbool, default: True

If True, MPAS longitude and latitude variables are interpreted as radians and converted to degrees.

lon_name_cell, lat_name_cellstr

MPAS cell coordinate variable names.

nx_bins, ny_binsint, default: 35, 20

Number of longitude and latitude bins used to thin vectors.

thin_method{“nearest_center”, “max_speed”, “mean”}, default: “nearest_center”

Rule used to choose or aggregate one vector per bin.

use_thinning_cachebool, default: True

If True, cache coordinate-only bin metadata for repeated calls.

add_quiverkeybool, default: True

If True, add a reference quiver key.

quiverkey_valuefloat, optional

Reference vector magnitude for the quiver key. If None, use the 75th percentile of thinned vector speeds.

quiverkey_labelstr, optional

Label for the quiver key. If None, build a metres-per-second label from quiverkey_value.

quiverkey_x, quiverkey_yfloat, default: 0.88, 1.04

Quiver-key position in axes coordinates.

transformcartopy.crs.CRS, optional

Coordinate reference system of the input coordinates for Cartopy axes.

regrid_shapeint or (int, int) or None, optional

Regrid vectors onto a regular grid in the target map projection before plotting. This is only supported for Cartopy GeoAxes.

regrid_global_epsilonfloat, default: 1.0e-6

Small longitude shrink applied to full-width global regridding windows.

titlestr, optional

Axes title. If None, use a default wind title.

**quiver_kwargs

Additional keyword arguments passed to Axes.quiver.

Returns

matplotlib.quiver.Quiver

Quiver object returned by Axes.quiver.

MPAS Cell-centered quiver plots

MPAS Cell-centered quiver plots