carboscope
/ std
¶
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: (optional):
Path to the corresponding component. This value is used if not provided in parameters
accepted type: str
file: (optional):
File format in the given directory. This value is used if not provided in parameters
accepted type: str
varname: (optional):
Variable name to use to read data filesinstead of the parameter name if different to the parameter name
accepted type: str
file_freq: (optional):
Temporal frequency to fetch files
accepted type: str
split_freq: (optional)
Force splitting the processing at a given frequency different to file_freq
accepted type: str
numscale: (optional): 1
Scaling factor to apply to the input data
accepted type: float
station_name_dict: (optional)
Information to translate station IDs from CIF to footprint file names.
- accepted structure:
dict_file: (mandatory)
Path to the file to use as dictionary
accepted type: str
separator: (optional): ;
Separator to use to parse the parse dict_file
accepted type: str
CIF_stations_id: (optional): CIF_stations_id
Column name to use as CIF station names
accepted type: str
footprint_stations_id: (optional): footprint_stations_id
Column name to use in footprint station name
accepted type: str
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: carboscope
4 version: std
5 type: datastream
6
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 numscale: XXXXX # float
14 station_name_dict:
15 dict_file: XXXXX # str
16 separator: XXXXX # str
17 CIF_stations_id: XXXXX # str
18 footprint_stations_id: XXXXX # str