ORCHIDEE surface fluxes orchidee/std

ORCHIDEE surface fluxes orchidee/std#

Description#

This is the plugin to accommodate fluxes as generated by the model ORCHIDEE.

There are two options for the type of files accepted:

  • a single file covering the full period of simulation is expected. This is the data format as generated in the project VERIFY.

  • files with a given frequency (file_freq; 1MS by default).

Horizontal coordinates are expected to be given as a list of latitudes and longitudes corresponding to grid cell centers. Longitudes/latitudes variables names in the NetCDF files must be specified either as the couple lat/lon or latitude/longitude.

There are two options for the specification of dates:

  • explicitly specified in the variable time; in that case, the middle of each period is expected

  • if there is no time variables, dates are deduced by distributing them following the parameter timeresol (3H by default) and the time dimension of the data variable in the 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 “NBP”

The name of the variable to extract in the flux file

file_freq : str, optional, default “1MS”

File frequency of ORCHIDEE outputs

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.

timeresol : str, optional, default “3h”

Temporal resolution of ORCHIDEE fluxes

interpol_resolution : optional

Interpolate to a given temporal resolution. This is temporary for test.

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: orchidee
 4    version: std
 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  timeresol: XXXXX  # str
14  interpol_resolution: XXXXX  # any

See also

API reference (functions & code)