plots.sources

Submodules

Functions

get_source(*args[, data, x, y, z, u, v, regrid])

Get a Source object from the given data.

get_vector_sources([data, x, y, u, v])

Package Contents

plots.sources.get_source(*args, data=None, x=None, y=None, z=None, u=None, v=None, regrid=True, **kwargs)

Get a Source object from the given data.

Parameters:
  • *args – The positional arguments to pass to the Source constructor.

  • data (numpy.ndarray, xarray.DataArray, earthkit.data.core.Base, optional) – The data to be plotted.

  • x (numpy.ndarray or str, optional) – The x-coordinates of the data. If a string, it is assumed to be the name of the x-coordinate variable in data.

  • y (numpy.ndarray or str, optional) – The y-coordinates of the data. If a string, it is assumed to be the name of the y-coordinate variable in data.

  • z (numpy.ndarray or str, optional) – The z-coordinates of the data. If a string, it is assumed to be the name of the z-coordinate variable in data.

  • u (numpy.ndarray or str, optional) – The u-component of the data. If a string, it is assumed to be the name of the u-component variable in data.

  • v (numpy.ndarray or str, optional) – The v-component of the data. If a string, it is assumed to be the name of the v-component variable in data.

  • **kwargs – Additional keyword arguments to pass to the Source constructor.

plots.sources.get_vector_sources(data=None, x=None, y=None, u=None, v=None, **kwargs)