plots.metadata.units

Attributes

Q_
TEMPERATURE_ANOM_UNITS
UNIT_EQUIVALENCE
ureg

Functions

anomaly_equivalence(units)	Check if units are equivalent for temperature anomalies.
are_equal(unit_1, unit_2)	Check if two units are equivalent.
convert(data, source_units, target_units)	Convert data from one set of units to another.
format_unit_simple(unit, registry, **options)
format_units(units[, format])	Format units for display in LaTeX.

Module Contents

plots.metadata.units.Q_

plots.metadata.units.TEMPERATURE_ANOM_UNITS = ['kelvin', 'celsius']

plots.metadata.units.UNIT_EQUIVALENCE

plots.metadata.units.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.

Parameters:

units (str) – The units to check for equivalence.

plots.metadata.units.are_equal(unit_1, unit_2)

Check if two units are equivalent.

Parameters:

• unit_1 (str) – The first unit.

• unit_2 (str) – The second unit.

plots.metadata.units.convert(data, source_units, target_units)

Convert data from one set of units to another.

Parameters:

• data (numpy.ndarray) – The data to convert.

• source_units (str) – The units of the data.

• target_units (str) – The units to convert to.

plots.metadata.units.format_unit_simple(unit, registry, **options)

plots.metadata.units.format_units(units, format=None)

Format units for display in LaTeX.

Parameters:

units (str) – The units to format.

Example

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

plots.metadata.units.ureg