cf.Field.dump

Field.dump(id=None, omit=())

Return a string containing a full description of the field.

Parameters :

id: str, optional

Set the common prefix of variable component names. By default ‘Field’ is used.

omit : sequence of strs

Omit the given attributes from the description.

Returns :

out : str

A string containing the description of the field.

Examples

>>> print f.dump()
>>> print f.dump(id='pressure_field')
>>> print f.dump(omit=('space',))