plots.metadata.units
====================

.. py:module:: plots.metadata.units


Attributes
----------

.. autoapisummary::

   plots.metadata.units.Q_
   plots.metadata.units.TEMPERATURE_ANOM_UNITS
   plots.metadata.units.UNIT_EQUIVALENCE
   plots.metadata.units.ureg


Functions
---------

.. autoapisummary::

   plots.metadata.units.anomaly_equivalence
   plots.metadata.units.are_equal
   plots.metadata.units.convert
   plots.metadata.units.format_units


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

.. py:data:: Q_

.. py:data:: TEMPERATURE_ANOM_UNITS
   :value: ['kelvin', 'celsius']


.. py:data:: UNIT_EQUIVALENCE

.. py:function:: anomaly_equivalence(units)

   Check if units are equivalent for temperature anomalies.

   This is a special case for temperature anomalies, for which Kelvin and
   Celsius are considered equivalent.

   :param units: The units to check for equivalence.
   :type units: str


.. py:function:: are_equal(unit_1, unit_2)

   Check if two units are equivalent.

   :param unit_1: The first unit.
   :type unit_1: str
   :param unit_2: The second unit.
   :type unit_2: str


.. py:function:: convert(data, source_units, target_units)

   Convert data from one set of units to another.

   :param data: The data to convert.
   :type data: numpy.ndarray
   :param source_units: The units of the data.
   :type source_units: str
   :param target_units: The units to convert to.
   :type target_units: str


.. py:function:: format_units(units, exponential_notation=False)

   Format units for display in LaTeX.

   :param units: The units to format.
   :type units: str

   .. rubric:: Example

   >>> format_units("kg m-2")
   "$kg m^{-2}$"


.. py:data:: ureg