cf.Units

class cf.Units(units=None, calendar=None, format=None, names=None, definition=None, _ut_unit=None)

Bases: object

Store, combine and compare physical units and convert numeric values to different units.

Units are as defined in UNIDATA’s Udunits-2 package, with a few exceptions for greater consistency with the CF conventions namely support for CF calendars and new units definitions.

Modifications to the standard Udunits database

Whilst a standard Udunits-2 database may be used, greater consistency with CF is achieved by using a modified database. The following units are either new to, modified from, or removed from the standard Udunits-2 database (version 2.1.24):

Unit name	Symbol	Definition	Status
practical_salinity_unit	psu	1e-3	New unit
level		1	New unit
sigma_level		1	New unit
layer		1	New unit
decibel	dB	1	New unit
bel		10 dB	New unit
sverdrup	Sv	1e6 m3 s-1	Added symbol
sievert		J kg-1	Removed symbol

Plural forms of the new units’ names are allowed, such as practical_salinity_units.

The modified database is in the udunits subdirectory of the etc directory found in the same location as this module.

Accessing units

Units may be set, retrieved and deleted via the units attribute. Its value is a string that can be recognized by UNIDATA’s Udunits-2 package, with the few exceptions given in the CF conventions.

>>> u = Units('m s-1')
>>> u
<Cf Units: 'm s-1'>
>>> u.units = 'days since 2004-3-1'
>>> u
<CF Units: days since 2004-3-1>

Equality and equivalence of units

There are methods for assessing whether two units are equivalent or equal. Two units are equivalent if numeric values in one unit are convertible to numeric values in the other unit (such as kilometres and metres). Two units are equal if they are equivalent and their conversion is a scale factor of 1 and an offset of 0 (such as kilometres and 1000 metres). Note that equivalence and equality are based on internally stored binary representations of the units, rather than their string representations.

>>> u = Units('m/s')
>>> v = Units('m s-1')
>>> w = Units('km.s-1')
>>> x = Units('0.001 kilometer.second-1')
>>> y = Units('gram')

>>> u.equivalent(v), u.equals(v),  u == v
(True, True, True)
>>> u.equivalent(w), u.equals(w)
(True, False)
>>> u.equivalent(x), u.equals(x)
(True, True)
>>> u.equivalent(y), u.equals(y)
(False, False)

Time and reference time units

Time units may be given as durations of time (time units) or as an amount of time since a reference time (reference time units):

>>> v = Units()
>>> v.units = 's'
>>> v.units = 'day'
>>> v.units = 'days since 1970-01-01'
>>> v.units = 'seconds since 1992-10-8 15:15:42.5 -6:00'

Note

It is recommended that the units year and month be used with caution, as explained in the following excerpt from the CF conventions: “The Udunits package defines a year to be exactly 365.242198781 days (the interval between 2 successive passages of the sun through vernal equinox). It is not a calendar year. Udunits includes the following definitions for years: a common_year is 365 days, a leap_year is 366 days, a Julian_year is 365.25 days, and a Gregorian_year is 365.2425 days. For similar reasons the unit month, which is defined to be exactly year/12, should also be used with caution.”

Calendar

The date given in reference time units is associated with one of the calendars recognized by the CF conventions and may be set with the calendar attribute. However, as in the CF conventions, if the calendar is not set then, for the purposes of calculation and comparison, it defaults to the mixed Gregorian/Julian calendar as defined by Udunits:

>>> u = Units('days since 2000-1-1')
>>> u.calendar
AttributeError: Can't get 'Units' attribute 'calendar'
>>> v = Units('days since 2000-1-1')
>>> v.calendar = 'gregorian'
>>> v.equals(u)
True

Arithmetic with units

The following operators, operations and assignments are overloaded:

Comparison operators:

==, !=

Binary arithmetic operations:

+, -, *, /, pow(), **

Unary arithmetic operations:

-, +

Augmented arithmetic assignments:

+=, -=, *=, /=, **=

The comparison operations return a boolean and all other operations return a new units object or modify the units object in place.

>>> u = Units('m')
<CF Units: m>

>>> v = u * 1000
>>> v
<CF Units: 1000 m>

>>> u == v
False
>>> u != v
True

>>> u **= 2
>>> u
<CF Units: m2>

It is also possible to create the logarithm of a unit corresponding to the given logarithmic base:

>>> u = Units('seconds')
>>> u.log(10)
<CF Units: lg(re 1 s)>

Modifying data for equivalent units

Any numpy array or python numeric type may be modified for equivalent units using the conform static method.

>>> Units.conform(2, Units('km'), Units('m'))
2000.0

>>> import numpy
>>> a = numpy.arange(5.0)
>>> Units.conform(a, Units('minute'), Units('second'))
array([   0.,   60.,  120.,  180.,  240.])
>>> a
array([ 0.,  1.,  2.,  3.,  4.])

If the inplace keyword is True, then a numpy array is modified in place, without any copying overheads:

>>> Units.conform(a,
                  Units('days since 2000-12-1'),
                  Units('days since 2001-1-1'), inplace=True)
array([-31., -30., -29., -28., -27.])
>>> a
array([-31., -30., -29., -28., -27.])

Initialization

Parameters :

units : str, optional

Set the new units from this string.

calendar : str, optional

Set the calendar for reference time units.

format : bool, optional

Format the string representation of the units in a standardized manner. See the format method.

names : bool, optional

Format the string representation of the units using names instead of symbols. See the format method.

definition : bool, optional

Format the string representation of the units using basic units. See the format method.

_ut_unit : int, optional

Set the new units from this Udunits binary unit representation. This should be an integer returned by a call to ut_parse function of Udunits. Overrides units, if set.

static conform(x, from_units, to_units, inplace=False)

Conform values in one unit to equivalent values in another, compatible unit. Returns the conformed values.

The values may either be a numpy array or a python numeric type. The returned value is of the same type, except that input integers are converted to floats (see the inplace keyword).

Parameters :

x : numpy.ndarray or python numeric

from_units : Units

The original units of x

to_units : Units

The units to which x should be conformed to.

inplace : bool, optional

If True and x is a numpy array then change it in place, creating no temporary copies, with one exception: If x is of integer type and the conversion is not null, then it will not be changed inplace and the returned conformed array will be of float type.

Returns :

out : numpy.ndarray or python numeric

The modified numeric values.

Examples

>>> Units.conform(2, Units('km'), Units('m'))
2000.0

>>> import numpy
>>> a = numpy.arange(5.0)
>>> Units.conform(a, Units('minute'), Units('second'))
array([   0.,   60.,  120.,  180.,  240.])
>>> a
array([ 0.,  1.,  2.,  3.,  4.])

>>> Units.conform(a,
                  Units('days since 2000-12-1'),
                  Units('days since 2001-1-1'), inplace=True)
array([-31., -30., -29., -28., -27.])
>>> a
array([-31., -30., -29., -28., -27.])

Warning

Do not change the calendar of reference time units in the current version. Whilst this is possible, it will almost certainly result in an incorrect interpretation of the data or an error. Allowing the calendar to be changed is under development and will be available soon.

copy()

Return a deep copy.

Equivalent to copy.deepcopy(u).

Returns :

out :

The deep copy.

Examples

>>> v = u.copy()

dump(id=None, omit=())

equals(other, rtol=None, atol=None)

Return True if and only if numeric values in one unit are convertible to numeric values in the other unit and their conversion is a scale factor of 1.

Parameters :

other : Units

The other units.

Returns :

out : bool

True if the units are equal, False otherwise.

Examples

>>> u = Units(units='km')
>>> v = Units(units='1000m')
>>> u.equals(v)
True

>>> u = Units(units='m s-1')
>>> m = Units(units='m')
>>> s = Units(units='s')
>>> u.equals(m)
False
>>> u.equals(m/s)
True
>>> (m/s).equals(u)
True

Undefined units are considered equal:

>>> u = Units()
>>> v = Units()
>>> u.equals(v)
True

equivalent(other)

Returns True if and only if numeric values in one unit are convertible to numeric values in the other unit.

Parameters :

other : Units

The other units.

Returns :

out : bool

True if the units are equivalent, False otherwise.

Examples

>>> u = Units(units='m')
>>> v = Units(units='km')
>>> w = Units(units='s')

>>> u.equivalent(v)
True
>>> u.equivalent(w)
False

>>> u = Units(units='days since 2000-1-1')
>>> v = Units(units='days since 2000-1-1', calendar='366_day')
>>> w = Units(units='seconds since 1978-3-12')

>>> u.equivalent(v)
False
>>> u.equivalent(w)
True

format(names=None, definition=None)

Formats the string stored in the units attribute in a standardized manner. The units attribute is modified in place and its new value is returned.

Parameters :

names : bool, optional

Use unit names instead of symbols.

definition : bool, optional

The formatted string is given in terms of basic-units instead of stopping any expansion at the highest level possible.

Returns :

out : str

The formatted string.

Examples

>>> u = Units(units='W')
>>> u.units
'W'
>>> u.format()
>>> u.units
'W'
>>> u.format(names=True)
>>> u.units
'watt'
>>> u.format(definition=True)
>>> u.units
'm2.kg.s-3'
>>> u.format(names=True, definition=True)
'meter^2-kilogram-second^-3'
>>> u.format()
'W'

>>> u.units='dram'
>>> u.format(names=True)
'1.848345703125e-06 meter^3'

Formatting is also available during object initialization:

>>> u = Units(units='m/s', format=True)
>>> u.units
'm.s-1'

>>> u = Units(units='dram', names=True)
>>> u.units
'1.848345703125e-06 m3'

>>> u = Units(units='W', names=True, definition=True)
>>> u.units
'meter^2-kilogram-second^-3'

log(base)

Returns the logarithmic unit corresponding to the given logarithmic base.

Parameters :

base : int or float

The logarithmic base.

Returns :

out : Units

The logarithmic unit corresponding to the given logarithmic base.

Examples

>>> u = Units(units='W', names=True)
>>> u
<CF Units: watt>

>>> u.log(10)
<CF Units: lg(re 1 W)>
>>> u.log(2)
<CF Units: lb(re 1 W)>

>>> import math
>>> u.log(math.e)
<CF Units: ln(re 1 W)>

>>> u.log(3.5)
<CF Units: 0.798235600147928 ln(re 1 W)>

calendar

The calendar CF attribute for reference time units.

Note that deleting the calendar will adjust the reference time units for the default CF calendar (‘gregorian’), if necessary.

Examples

>>> u = Units()
>>> u.calendar = 'gregorian'
>>> u.calendar
'gregorian'

>>> u = Units(calendar='365_day')
>>> u.calendar
'365_day'
>>> del u.calendar

is_latitude

True if the units are latitude units, i.e. if the units attribute is ‘degrees_north’, false otherwise.

Examples

>>> u = Units(units='degrees_north')
>>> u.is_latitude
True

>>> u = Units(units='degrees')
>>> u.is_latitude
False

>>> u = Units(units='degrees_east')
>>> u.is_latitude
False

is_longitude

True if the units are longitude units, i.e. if the units attribute is ‘degrees_east’, false otherwise.

Examples

>>> u = Units(units='degrees_east')
>>> u.is_longitude
True

>>> u = Units(units='degrees')
>>> u.is_longitude
False

>>> u = Units(units='degrees_north')
>>> u.is_longitude
False

is_pressure

True if the units are pressure units, false otherwise.

Examples

>>> u = Units(units='bar')
>>> u.is_pressure
True

>>> u = Units(units='hours since 2100-1-1', calendar='noleap')
>>> u.is_pressure
False

is_reftime

True if the units are reference time units, false otherwise.

Note that time units are not reference time units and that the existence of the calendar attribute on its own is not sufficient for identifying the presence of reference time units.

Examples

>>> u = Units(units='days since 1989-1-1')
>>> u.is_reftime
True

>>> u = Units(units='hours since 2100-1-1', calendar='noleap')
>>> u.is_reftime
True

>>> u = Units(units='kg')
>>> u.is_reftime
False

>>> u = Units(units='hours')
>>> u.is_reftime
False

>>> u = Units(calendar='360_day')
>>> u.is_reftime
False

is_time

True if the units are time units, False otherwise.

Note that reference time units are not time units.

Examples

>>> u = Units(units='days')
>>> u.is_time
True

>>> u = Units(units='hours since 2100-1-1', calendar='noleap')
>>> u.is_time
False

>>> u = Units(calendar='360_day')
>>> u.is_time
False

>>> u = Units(units='kg')
>>> u.is_time
False

units

The units string. May be any string allowed by the units attribute in the CF conventions.

Examples

>>> u = Units()
>>> u.units = 'kg'
>>> u.units
'kg'

>>> u = Units(units='percent')
>>> u.units
'percent'
>>> del u.units