cf.AuxiliaryCoordinate.dump

AuxiliaryCoordinate.dump(omit=(), domain=None, key=None, level=0)[source]

Return a string containing a full description of the coordinate.

Parameters :
omit : sequence of strs

Omit the given CF properties from the description.

Returns :
out : str

A string containing the description.

Examples

>>> x = c.dump()
>>> print c.dump()
>>> print c.dump(id='time_coord')
>>> print c.dump(omit=('long_name',))

Previous topic

cf.AuxiliaryCoordinate.delprop

Next topic

cf.AuxiliaryCoordinate.equals

This Page