CFVariable

class CFVariable(name, *args, registry=None, **kwargs)

Bases: object

Lightweight CF-style representation of physical variables. Integrated with the xarray accessor via cfvariable.

Parameters

• name (str) – The canonical variable name.

• registry (CFVariableRegistry) – The associated registry.

• *args, **kwargs – Passed to CFVariable.update. The long_name, standard_units, and short_name can be passed positionally (in that order).

Attributes Summary

aliases	Aliases for the variable name.
axis_formatter	The axis formatter used when plotting against this variable.
axis_reverse	Whether to reverse the axis when plotting against this variable.
axis_scale	The axis scale when plotting against this variable.
children	The variable children.
color	The color associated with the variable.
colormap	The colormap associated with the variable.
colormap_line	The truncated colormap associated with the variable.
identifiers	Tuple of unique variable identifiers (the name, the standard_name, and the aliases).
long_label	Readable plot label using the long name and units.
long_name	The plot-friendly variable name.
name	The canonical variable name.
reference	The “reference” value associated with this variable.
scalar_label	Scalar label.
short_label	Readable plot label using the short name and units.
short_name	The shorter plot-friendly variable name.
sigfig	The number of significant figures for scalar labels of this variable.
standard_name	The CF-style standard name.
standard_units	The plot-friendly standard units.
symbol	Mathematical symbol for this variable.
units_label	The active accessor units or the standard units formatted for matplotlib labels.
units_pint	The standard unit string translated to pint.Unit.

Methods Summary

child(name, *args[, other_parents])	Return a new child variable with properties inherited from the current one.
update([long_name, standard_units, …])	Update the variable.