Dummy model - text (dummy / txt)

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

main_flx_arg: (optional): totototo

document here the argument

accepted type: <class ‘str’>

file: (optional): dummy_flx.txt

File format for the fluxes

accepted type: <class ‘str’>

period: (optional): 1D

Frequency of the original fluxes

accepted type: <class ‘str’>

freq: (optional): 1D

Frequency of the original fluxes

accepted type: <class ‘str’>

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: dummy
 4    version: txt
 5    type: datastream
 6
 7
 8  # Optional arguments
 9  main_flx_arg: XXXXX
10  file: XXXXX
11  period: XXXXX
12  freq: XXXXX