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

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


Attributes
----------

.. autoapisummary::

   plots.sources.earthkit.VARIABLE_KEYS


Classes
-------

.. autoapisummary::

   plots.sources.earthkit.EarthkitSource


Functions
---------

.. autoapisummary::

   plots.sources.earthkit.get_points


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

.. py:class:: EarthkitSource(*args, x=None, y=None, z=None, **kwargs)

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


   Source class for earthkit data, allowing flexible x, y, z extraction using
   dimension names or values and supporting regridding if needed.


   .. py:property:: crs

      Return 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:method:: extract_u(u=None)


   .. py:method:: extract_v(v=None)


   .. 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:: 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:data:: VARIABLE_KEYS
   :value: ['short_name', 'standard_name', 'long_name', 'name']


.. py:function:: get_points(dx)

   Get points for a grid with a given resolution.