Dump to specific format (dump2format / std)

Description

This transform allows to dump the data at the end of the control vector transformations to a specific format.

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

component: (mandatory)

Name of the component to dump to a specific format.

accepted type: <class ‘str’>

parameter: (mandatory)

Name of the parameter to dump to a specific format.

accepted type: <class ‘str’>

Optional arguments

dump_file: (optional): dump_%Y%m%d

File format for the files

accepted type: <class ‘str’>

dump_format: (optional)

Definition of the plugin to use to dump the data

accepted structure:

name: (mandatory)

Name of the plugin

version: (mandatory)

Version of the plugin

type: (mandatory)

Type of the plugin

dump_options: (optional)

Dumping options, i.e., options for the plugin chosen in dump_format

Yaml template

Please find below a template for a Yaml configuration:

 1transform:
 2  plugin:
 3    name: dump2format
 4    version: std
 5    type: transform
 6
 7  # Mandatory arguments
 8  component: XXXXX
 9  parameter: XXXXX
10
11  # Optional arguments
12  dump_file: XXXXX
13  dump_format: XXXXX
14  dump_options: XXXXX