EDGAR/v5 EDGAR/v5

EDGAR/v5 EDGAR/v5#

Description#

EDGAR database

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

closest_year : bool, optional, default False

If the correct year is not available, use the closest one

truncated : bool, optional, default False

If the domain is not global

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: EDGAR
 4    version: v5
 5    type: flux
 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  closest_year: XXXXX  # bool
14  truncated: XXXXX  # bool
Contents