iris.experimental.ugrid.metadata

The common metadata API classes for iris.experimental.ugrid.mesh.

Eventual destination: iris.common.metadata.

class iris.experimental.ugrid.metadata.ConnectivityMetadata(standard_name, long_name, var_name, units, attributes, cf_role, start_index, location_axis)

Bases: ConnectivityMetadataNamedtuple, BaseMetadata

Metadata container for a Connectivity.

Create new instance of ConnectivityMetadataNamedtuple(standard_name, long_name, var_name, units, attributes, cf_role, start_index, location_axis)

combine(other, lenient=None)

Return a new metadata instance created by combining each of the associated metadata members.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool) – Enable/disable lenient combination. The default is to automatically detect whether this lenient operation is enabled.

Return type:

Metadata instance.

difference(other, lenient=None)

Perform lenient metadata difference operation.

Return a new metadata instance created by performing a difference comparison between each of the associated metadata members.

A metadata member returned with a value of “None” indicates that there is no difference between the members being compared. Otherwise, a tuple of the different values is returned.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool, optional) – Enable/disable lenient difference. The default is to automatically detect whether this lenient operation is enabled.

Return type:

Metadata instance of member differences or None.

equal(other, lenient=None)

Determine whether the associated metadata members are equivalent.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool, optional) – Enable/disable lenient equivalence. The default is to automatically detect whether this lenient operation is enabled.

Return type:

bool

class iris.experimental.ugrid.metadata.MeshCoordMetadata(standard_name, long_name, var_name, units, attributes, location, axis)

Bases: MeshCoordMetadataNamedtuple, BaseMetadata

Metadata container for a MeshCoord.

Create new instance of MeshCoordMetadataNamedtuple(standard_name, long_name, var_name, units, attributes, location, axis)

combine(other, lenient=None)

Return a new metadata instance created by combining each of the associated metadata members.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool) – Enable/disable lenient combination. The default is to automatically detect whether this lenient operation is enabled.

Return type:

Metadata instance.

difference(other, lenient=None)

Perform lenient metadata difference operation.

Return a new metadata instance created by performing a difference comparison between each of the associated metadata members.

A metadata member returned with a value of “None” indicates that there is no difference between the members being compared. Otherwise, a tuple of the different values is returned.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool, optional) – Enable/disable lenient difference. The default is to automatically detect whether this lenient operation is enabled.

Return type:

Metadata instance of member differences or None.

equal(other, lenient=None)

Determine whether the associated metadata members are equivalent.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool, optional) – Enable/disable lenient equivalence. The default is to automatically detect whether this lenient operation is enabled.

Return type:

bool

class iris.experimental.ugrid.metadata.MeshMetadata(standard_name, long_name, var_name, units, attributes, topology_dimension, node_dimension, edge_dimension, face_dimension)

Bases: MeshMetadataNamedtuple, BaseMetadata

Metadata container for a Mesh.

Create new instance of MeshMetadataNamedtuple(standard_name, long_name, var_name, units, attributes, topology_dimension, node_dimension, edge_dimension, face_dimension)

combine(other, lenient=None)

Return a new metadata instance created by combining each of the associated metadata members.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool) – Enable/disable lenient combination. The default is to automatically detect whether this lenient operation is enabled.

Return type:

Metadata instance.

difference(other, lenient=None)

Perform lenient metadata difference operation.

Return a new metadata instance created by performing a difference comparison between each of the associated metadata members.

A metadata member returned with a value of “None” indicates that there is no difference between the members being compared. Otherwise, a tuple of the different values is returned.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool, optional) – Enable/disable lenient difference. The default is to automatically detect whether this lenient operation is enabled.

Return type:

Metadata instance of member differences or None.

equal(other, lenient=None)

Determine whether the associated metadata members are equivalent.

Parameters:

• other (metadata) – A metadata instance of the same type.

• lenient (bool, optional) – Enable/disable lenient equivalence. The default is to automatically detect whether this lenient operation is enabled.

Return type:

bool