scenario_file_format
Differences
This shows you the differences between two versions of the page.
Next revisionBoth sides next revision | |||
scenario_file_format [2017/09/01 09:07] – created mimbert | scenario_file_format [2017/09/01 10:35] – mimbert | ||
---|---|---|---|
Line 1: | Line 1: | ||
The scenario of a minus task is a file named '' | The scenario of a minus task is a file named '' | ||
- | The syntax of the file is [YAML](http:// | + | ====== Syntax ====== |
+ | |||
+ | The syntax of the file is [YAML](http:// | ||
Please bear in mind that YAML is indentation sensitive, just like python. YAML will follow whatever indentation system the scenario file uses, provided that it is consistent within the file. Note that in particular you should not mix spaces and tabs (beware, some text editors do that silently and need to be properly configured to avoid that). The suggested best practice is to use two spaces for indentation. | Please bear in mind that YAML is indentation sensitive, just like python. YAML will follow whatever indentation system the scenario file uses, provided that it is consistent within the file. Note that in particular you should not mix spaces and tabs (beware, some text editors do that silently and need to be properly configured to avoid that). The suggested best practice is to use two spaces for indentation. | ||
+ | |||
+ | Comments in YAML start with a ''#'' | ||
+ | |||
+ | ====== Grammar ====== | ||
+ | |||
+ | The scenario.yaml file is structured as follows: | ||
+ | * It MUST contain a // | ||
+ | * It MUST contain a // | ||
+ | * It MUST contain a //nodes// key, whose value is a mapping (aka hash, or dictionnary): | ||
+ | * Nodes key, value pairs, whose keys are the node names (in the set //node1// to //node40//, and whose values are mappings: | ||
+ | * which MUST contain a //command// key, value pair, whose value is the command line string which will be run on the corresponding node: '' | ||
+ | * which MAY contain a //passive// key, value pair, whose value is a boolean (default is '' | ||
+ | |||
+ | Thus, an example scenario could be: | ||
+ | |||
+ | < | ||
+ | description: | ||
+ | duration: 60 | ||
+ | nodes: | ||
+ | node1: | ||
+ | command: sleep 1000 | ||
+ | # a bash command | ||
+ | passive: true | ||
+ | node2: | ||
+ | command: ./myscript | ||
+ | # relative path to a script embedded in the task | ||
+ | node3: | ||
+ | command: gnuradio-config-info -v | ||
+ | # calling a gnuradio executable which is in the $PATH | ||
+ | node4: | ||
+ | command: / | ||
+ | # absolute path to a script or binary | ||
+ | </ | ||
+ |
scenario_file_format.txt · Last modified: 2023/08/29 15:29 by cmorin