Template plugin for BCs (BCs / template)¶
Description¶
Write here the README about the plugin. Example of relevant information: type of files treated, including format of names and shape of data, time resolution, and any specific treatment that prevents the plugin from working with another type of files.
Use rst syntax since this README will be automatically displayed in the documentation
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¶
dummy_arg: (optional): let’s say it’s not mandatory
document here the argument
accepted type: <class ‘str’>
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: BCs
4 version: template
5 type: datastream
6
7
8 # Optional arguments
9 dummy_arg: XXXXX
