regrid / std

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Mandatory arguments

method: (mandatory)

Method by which the original data is spatially interpolated onto the output grid:mass-conservation keeps the mass, bilinearXXX

accepted values: [‘mass-conservation’, ‘bilinear’, ‘gridcell’]

Optional arguments

dir_wgt: (optional):

Directory where pre-computed interpolation weights are available

accepted type: <class ‘str’>

min_weight: (optional): 1e-10

Minimum weight to consider when reprojecting. If sensitivity to original dataset is smaller to min_weight, then crops

accepted type: <class ‘float’>

orig_regular: (optional): True

Set to FALSE if irregular original grid when reprojecting, True by default

accepted type: <class ‘bool’>

target_lbc: (optional): False

Interpolate to the LBC of a domain

accepted type: <class ‘bool’>

Requirements

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

domain

Domain

False

True

None

None

Yaml template

Please find below a template for a Yaml configuration:

 1transform:
 2  plugin:
 3    name: regrid
 4    version: std
 5    type: transform
 6
 7  # Mandatory arguments
 8  method: XXXXX
 9
10  # Optional arguments
11  dir_wgt: XXXXX
12  min_weight: XXXXX
13  orig_regular: XXXXX
14  target_lbc: XXXXX