def setUp(self):
"""Set up input cube"""
self.cube = set_up_variable_cube(
282 * np.ones((5, 5), dtype=np.float32),
spatial_grid="latlon",
standard_grid_metadata="gl_det",
time=datetime(2019, 10, 11),
time_bounds=[datetime(2019, 10, 10, 23), datetime(2019, 10, 11)],
frt=datetime(2019, 10, 10, 18),
)
self.plugin = StandardiseMetadata()
def process(
cube: cli.inputcube,
*,
attributes_config: cli.inputjson = None,
coords_to_remove: cli.comma_separated_list = None,
new_name: str = None,
new_units: str = None,
):
"""
Standardise a source cube. Available options are renaming, converting units,
updating attributes and removing named scalar coordinates. Remaining scalar
coordinates are collapsed, and data are cast to IMPROVER standard datatypes
and units.
Deprecated behaviour:
Translates metadata relating to the grid_id attribute from StaGE
version 1.1.0 to StaGE version 1.2.0. Cubes that have no "grid_id"
attribute are not recognised as v1.1.0 and are not changed.
Args:
cube (iris.cube.Cube):
Source cube to be standardised
attributes_config (dict):
Dictionary containing required changes that will be applied to
the attributes.
coords_to_remove (list):
List of names of scalar coordinates to remove.
new_name (str):
Name of output cube.
new_units (str):
Units to convert to.
Returns:
iris.cube.Cube
"""
from improver.metadata.amend import update_stage_v110_metadata
from improver.standardise import StandardiseMetadata
# update_stage_v110_metadata is deprecated. Please ensure metadata is
# StaGE version 1.2.0 compatible.
update_stage_v110_metadata(cube)
return StandardiseMetadata()(
cube,
new_name=new_name,
new_units=new_units,
coords_to_remove=coords_to_remove,
attributes_dict=attributes_config,
)