TM5 / 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:

Optional arguments

dir: (optional):

Path to the corresponding component. This value is used if not provided in parameters

accepted type: str

file: (optional):

File format in the given directory. This value is used if not provided in parameters

accepted type: str

varname: (optional):

Variable name to use to read data filesinstead of the parameter name if different to the parameter name

accepted type: str

file_freq: (optional):

Temporal frequency to fetch files

accepted type: str

exp_conversion: (optional): False

Apply the exponential conversion if fluxes stored as non-linear variable

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

False

dummy

std

Yaml template

Please find below a template for a Yaml configuration:

 1datastream:
 2  plugin:
 3    name: TM5
 4    version: std
 5    type: datastream
 6
 7  # Optional arguments
 8  dir: XXXXX  # str
 9  file: XXXXX  # str
10  varname: XXXXX  # str
11  file_freq: XXXXX  # str
12  exp_conversion: XXXXX  # any