CAMSREG/netcdf CAMSREG/netcdf#
Description#
Reads TNO yearly fluxes and applies time profile. Time profile is considered in UTC. Time zone is not taken into account. All the profile files are mandatory even the vertical one. If point_sources: True, vertical profile is applied.
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:
Mandatory arguments#
- dir_profiles : str, mandatory
Directory where the time and vertical profiles are.Files should be: TNO_height-distribution_GNFR.csv, timeprofiles-month-in-year_GNFR.csv, timeprofiles-day-in-week_GNFR.csv, timeprofiles-hour-in-day_GNFR.csv
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
- point_sources : bool, optional, default False
enables vertical projection
- cat_select : , optional, default False
List of TNO categories to use. By Default all categories are used
YAML template#
Please find below a template for a YAML configuration:
1flux:
2 plugin:
3 name: CAMSREG
4 version: netcdf
5 type: flux
6
7 # Mandatory arguments
8 dir_profiles: XXXXX # str
9
10 # Optional arguments
11 dir: XXXXX # str
12 file: XXXXX # str
13 varname: XXXXX # str
14 file_freq: XXXXX # str
15 split_freq: XXXXX # str
16 point_sources: XXXXX # bool
17 cat_select: XXXXX #