ORCHIDEE surface fluxes (orchidee / std)


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

main_flx_arg: (optional): totototo

document here the argument

accepted type: <class ‘str’>

varname: (optional): NBP

The name of the variable to extract in the flux file

accepted type: <class ‘str’>

file_freq: (optional): 1MS

File frequency of ORCHIDEE outputs

accepted type: <class ‘str’>

timeresol: (optional): 3H

Temporal resolution of ORCHIDEE fluxes

accepted type: <class ‘str’>

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:

 2  plugin:
 3    name: orchidee
 4    version: std
 5    type: datastream
 8  # Optional arguments
 9  main_flx_arg: XXXXX
10  varname: XXXXX
11  file_freq: XXXXX
12  timeresol: XXXXX
13  interpol_resolution: XXXXX