TNO
/ 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:
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
point_sources: (optional): False
enables vertical projection
accepted type: bool
dir_profiles: (optional): False
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
accepted type: str
cat_select: (optional): False
List of TNO categories to use. By Default all categories are used
accepted values: []
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: TNO
4 version: netcdf
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 point_sources: XXXXX # bool
13 dir_profiles: XXXXX # str
14 cat_select: XXXXX #