Template plugin for BCs BCs/template

Template plugin for BCs BCs/template#


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#

dir : str, optional, default “”

Path to the corresponding component. This value is used if not provided in parameters

file : str, optional, default “”

File format in the given directory. This value is used if not provided in parameters

varname : str, optional, default “”

Variable name to use to read data filesinstead of the parameter name if different to the parameter name

file_freq : str, optional, default “”

Temporal frequency to fetch files

split_freq : str, optional

Force splitting the processing at a given frequency different to file_freq

dummy_arg : str, optional, default “let’s say it’s not mandatory”

document here the argument

YAML template#

Please find below a template for a YAML configuration:

 2  plugin:
 3    name: BCs
 4    version: template
 5    type: field
 7    # Optional arguments
 8    dir: XXXXX  # str
 9    file: XXXXX  # str
10    varname: XXXXX  # str
11    file_freq: XXXXX  # str
12    split_freq: XXXXX  # str
13    dummy_arg: XXXXX  # str