cfdm.core.DimensionCoordinate.set_climatology

DimensionCoordinate.set_climatology(climatology)[source]

Set whether or not coordinates are climatological.

Only coordinate constructs with units of reference time (or unset units) can be set as climatological.

New in version (cfdm): 1.8.9.0

See also

del_climatology, get_climatology, is_climatology, set_climatology,

Parameters
climatology: bool

Whether or not the coordinates are climatological.

Returns

None

Examples

>>> c = cfdm.core.DimensionCoordinate()
>>> c.set_climatology(True)
>>> c.is_climatology()
True
>>>  c.get_climatology()
True
>>> c.del_climatology()
True
>>> c.is_climatology()
False
>>> print(c.get_climatology(None))
None
>>> print(c.del_climatology(None))
None
>>> c.set_climatology(False)
>>> c.is_climatology()
False