cfdm.Field.nc_set_component_sample_dimension_groups

Field.nc_set_component_sample_dimension_groups(component, groups)[source]

Set the netCDF sample dimension groups of components.

Sets the netCDF sample dimension groups for all components of a given type.

Some components exist within multiple constructs, but when written to a netCDF dataset the netCDF names associated with such components will be arbitrarily taken from one of them. The netCDF names can be set on all such occurrences individually, or preferably by using this method to ensure consistency across all such components.

New in version (cfdm): 1.8.6.0

Parameters
component: str

Specify the component type. One of:

component

Description

'count'

Count variables for contiguous ragged arrays

'index'

Index variables for indexed ragged arrays

groups: sequence of str

The new group structure for each component.

Returns

None

Examples:

>>> f.nc_set_component_sample_dimension_groups('count', ['forecast'])