Configuration¶
Each configuration must specify the section of metadata and task. Metadata and each task can define the output section.
Metadata¶
Metadata section contains the following parameters / sections.
Parameter / Section |
Description |
|---|---|
|
Output section. For further details, please see the below section. |
Task¶
Each task is a key-value pair where the key is the name of the task, and the value is a dictionary of parameters.
Parameter |
Description |
Required / Optional |
|---|---|---|
|
Caller function or method of the specified object. The function format must be in |
Required |
|
Object if the caller is specified as an object method. |
(Optional) |
|
Function arguments. Either a list of unnamed arguments or a dictionary of named arguments |
(Optional) |
Output¶
The output section defines how the task writes and loads the task return. The section in metadata applies for all tasks globally while that in each task
overrides the global parameters.
Parameter |
Description |
|---|---|
|
Directory of the output file. Default is |
|
Name of the output file. Default is same as the task name. |
|
Output format. Supported stdlib formats are |
|
Caller to load the output formatted in |
|
Dictionary of named parameters of the load function / method, other than the first argument. |
|
Caller to dump the output formatted either in |
|
Dictionary of named parameters of the dump function / method, other than the first two arguments. |