carboscope/std carboscope/std

carboscope/std carboscope/std#

Description#

Reads background/boundary-condition concentration data from the CARBOSCOPE (Jena CO2 inversion) footprint product.

Each station is stored in its own whitespace-delimited ASCII file (one file per station, matched by fetching ref_dir/ref_file for the requested years), with columns holding the date components and the simulated concentration. Station codes are read from the file name and can optionally be translated from the CIF station-naming convention to the footprint’s own convention via a CSV lookup table (station_name_dict).

write produces prescribed-species background fields for LMDZ, either as a raw binary file or as a NETCDF3_CLASSIC file.

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

Re-bucket this tracer’s fetched dates/files onto a fixed pandas-frequency grid (e.g. '1D', '1MS', '1YS'), independently of the native frequency the files were found at (file_freq). This fixes the sub-simulation boundaries that fromcontrol inherits for this tracer. For minimal memory usage, match it to the consuming model’s own periodicity: a finer value costs an extra time_interpolation bridge for no memory benefit, while a coarser value keeps the tracer’s data resident in memory across every one of the model’s sub-simulations it spans. See the ‘Splitting the temporal grid’ section on the observation operator page for the full mechanism and worked examples.

numscale : float, optional, default 1

Scaling factor to apply to the input data

station_name_dict : optional

Information to translate station IDs from CIF to footprint file names.

Argument structure:
dict_file : str, mandatory

Path to the file to use as dictionary

separator : str, optional, default “;”

Separator to use to parse the parse dict_file

CIF_stations_id : str, optional, default “CIF_stations_id”

Column name to use as CIF station names

footprint_stations_id : str, optional, default “footprint_stations_id”

Column name to use in footprint station name

YAML template#

Please find below a template for a YAML configuration:

 1background:
 2  plugin:
 3    name: carboscope
 4    version: std
 5    type: background
 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

See also

API reference (functions & code)