Vertical interpolation and re-mapping vertical_interpolation/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 : “static-levels” or “linear” or “closest” or “match-layer” or “layer-weighted”, mandatory

Method used for the interpolation

• static-levels:

• linear: a linear interpolation. Uses the coordinate specified in coord_out

• closest: gets closest levels

• “static-levels”: determines levels from pre-determined levels as specified in the argument file_statlev

• “linear”: a linear interpolation. Uses the coordinate specified in coord_out

• “closest”: gets closest levels

• “match-layer”: finds the layer matching outputs.

• “layer-weighted”: finds the layers matching outputs, and weights according to the thickness in each input layers

Optional arguments

parameter : str, optional

Parameter name on which the transform works on

component : str, optional

Component name on which the transform works on

orig_parameter_plg : Plugin, optional

Plugin object on which the transform works on

orig_component_plg : Plugin, optional

Corresponding component object on which the transform works on

successor : str, optional

Name of the successor transform

precursor : str, optional

Name of the precursor transform

coord_in : str, optional, default “pres”

Coordinates for inputs, pres, height

file_statlev : str, optional, default “”

File with model levels in which stations are. The expected format is:

#STAT LAT     LON     LEV  alt(m)
ALT   82.45   -62.52  1        210
JFJ   46.548  7.987   10       3580
MHD   53.33   -9.9    1        8

The first line is ignored. The important informations are the first columns with the station ID (should be consistent with the station name in your monitor file, and the fourth column specifying the level in the model (in python index starting from 0)

ignore_level : bool, optional, default False

Don’t do any vertical interpolation for sparse data and just propagate levels from inputs and outputs

coord_out : str, optional, default “pres”

Coordinates for outputs

psurf : float, optional, default 1013.25

Standard surfce pressure to use in computations with alpha/beta coordinate

fill_nans : bool, optional, default False

Use in combination with method = linear. Fill values outside the convex hull of inputs by using the closest valid (above or below) value

target_top : bool, optional, default False

Interpolate to the top of a domain

sparse_in : bool, optional, default False

Whether inputs are sparse data

sparse_out : bool, optional, default False

Whether outputs are sparse data

YAML template

Please find below a template for a YAML configuration:

transform:
  plugin:
    name: vertical_interpolation
    version: std
    type: transform

  # Mandatory arguments
  method: XXXXX  # static-levels|linear|closest|match-layer|layer-weighted

  # Optional arguments
  parameter: XXXXX  # str
  component: XXXXX  # str
  orig_parameter_plg: XXXXX  # Plugin
  orig_component_plg: XXXXX  # Plugin
  successor: XXXXX  # str
  precursor: XXXXX  # str
  coord_in: XXXXX  # str
  file_statlev: XXXXX  # str
  ignore_level: XXXXX  # bool
  coord_out: XXXXX  # str
  psurf: XXXXX  # float
  fill_nans: XXXXX  # bool
  target_top: XXXXX  # bool
  sparse_in: XXXXX  # bool
  sparse_out: XXXXX  # bool