plots.sources
=============

.. py:module:: plots.sources


Submodules
----------

.. toctree::
   :maxdepth: 1

   /_api/plots/sources/earthkit/index
   /_api/plots/sources/gridspec/index
   /_api/plots/sources/multi/index
   /_api/plots/sources/numpy/index
   /_api/plots/sources/single/index
   /_api/plots/sources/xarray/index


Functions
---------

.. autoapisummary::

   plots.sources.get_source
   plots.sources.get_vector_sources


Package Contents
----------------

.. py:function:: 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.

   :param \*args: The positional arguments to pass to the Source constructor.
   :param data: The data to be plotted.
   :type data: numpy.ndarray, xarray.DataArray, earthkit.data.core.Base, optional
   :param x: The x-coordinates of the data. If a string, it is assumed to be the name
             of the x-coordinate variable in data.
   :type x: numpy.ndarray or str, optional
   :param y: The y-coordinates of the data. If a string, it is assumed to be the name
             of the y-coordinate variable in data.
   :type y: numpy.ndarray or str, optional
   :param z: The z-coordinates of the data. If a string, it is assumed to be the name
             of the z-coordinate variable in data.
   :type z: numpy.ndarray or str, optional
   :param u: The u-component of the data. If a string, it is assumed to be the name
             of the u-component variable in data.
   :type u: numpy.ndarray or str, optional
   :param v: The v-component of the data. If a string, it is assumed to be the name
             of the v-component variable in data.
   :type v: numpy.ndarray or str, optional
   :param \*\*kwargs: Additional keyword arguments to pass to the Source constructor.


.. py:function:: get_vector_sources(data=None, x=None, y=None, u=None, v=None, **kwargs)