ancil_general_regrid.py

For a full description see ants.cli.ancil_general_regrid.

usage: ancil_general_regrid [-h] [--land-threshold LAND_THRESHOLD]
                            [--target-lsm TARGET_LSM | --target-grid TARGET_GRID [TARGET_GRID ...]]
                            --output OUTPUT [--ants-config ANTS_CONFIG]
                            [--netcdf-only] [--begin BEGIN] [--end END]
                            [--invert-mask] [--save-ukca]
                            [--search-method SEARCH_METHOD]
                            sources [sources ...]

Positional Arguments

sources

Source data path(s).

Additional arguments

--land-threshold

Land fraction threshold for converting land fraction (where provided) to a landsea mask.

--target-lsm

Path to the land sea mask. If provided the file is used to define both the target grid and the land sea mask. The land sea mask is used in the nearest neighbour fill of missing data for land only or ocean only fields. --target-lsm or --target-grid should be provided but not both.

--target-grid

Path to the target grid file(s). The grid files can be CAP horizontal namelists, UM vertical namelists or any file type supported by iris.load (NetCDF, pp, Ancillary). If using more than one grid file then separate the file names with a space. --target-lsm or --target-grid should be provided but not both.

--output, -o

Output filepath, which must be different from the source input file(s).

--ants-config

Configuration path. See ants.config

--netcdf-only

Only write out a netCDF file.

Default: False

--begin, -b

Year to start the processing in the format ‘YYYY’ e.g. ‘1990’.

--end, -e

Year to end the processing in the format ‘YYYY’ e.g. ‘2010’. For a single year of data, this should be the same as the argument given to the --begin argument.

--invert-mask

Invert the provided target_mask or not. Using this argument will set it to False. When set to True, treat target mask True (1) values as unmasked. When set to False, treat target mask True (1) values as masked. It is common to use this argument to denote source ocean fields as the landsea mask has True values to denote land.

Default: True

--save-ukca

Save to a UKCA-specific netCDF file

Default: False

--search-method

Select the search method used when filling. This specifies which search routine is used in making the provided source(s) consistent with the provided land sea mask. This should only be provided if a target land sea mask is provided via the --target-lsm option.

Default: 'spiral'