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

.. py:module:: plots.sources.earthkit


Classes
-------

.. autoapisummary::

   plots.sources.earthkit.EarthkitSource


Functions
---------

.. autoapisummary::

   plots.sources.earthkit.get_points


Module Contents
---------------

.. py:class:: EarthkitSource

   Bases: :py:obj:`earthkit.plots.sources.single.SingleSource`


   Source class for earthkit data.

   :param data: The data to be plotted.
   :type data: earthkit.data.core.Base
   :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 crs: The CRS of the data.
   :type crs: cartopy.crs.CRS, optional
   :param regrid: Whether to regrid the data.
   :type regrid: bool, optional
   :param \*\*kwargs: Metadata keys and values to attach to this Source.


   .. py:property:: crs

      The CRS of the data.


   .. py:property:: data

      Return the original earthkit data.


   .. py:method:: datetime(*args, **kwargs)

      Get the datetime of the data.

      :param \*args: The positional arguments to pass to the data object's `datetime` method.
      :param \*\*kwargs: The keyword arguments to pass to the data object's `datetime` method.



   .. py:property:: dims

      Return the dimensions of the data.


   .. py:method:: extract_x()

      Extract the x values from the data.



   .. py:method:: extract_xy()

      Extract the x and y values from the data.



   .. py:method:: extract_xyz()

      Extract the x, y and z values from the data.



   .. py:method:: extract_y()

      Extract the y values from the data.



   .. py:method:: extract_z()

      Extract the z values from the data.



   .. py:property:: magnitude_values

      The magnitude values of the data (applicable to vector data).


   .. py:method:: metadata(key, default=None)

      Extract metadata from the data.

      :param key: The metadata key to extract.
      :type key: str
      :param default: The default value to return if the key is not found.
      :type default: any, optional



   .. py:property:: u_values

      The u values of the data.


   .. py:property:: v_values

      The v values of the data.


   .. py:property:: x_values

      The x values of the data.


   .. py:property:: y_values

      The y values of the data.


   .. py:property:: z_values

      The z values of the data.


.. py:function:: get_points(dx)

   Get points for a grid with a given resolution.

   :param dx: The resolution of the grid.
   :type dx: float