LMDz photorates (LMDZ
/ photochem
)¶
Description¶
This plugin reads LMDz ‘kinetic’ input files
Example of use
datavect:
plugin:
name: standard
version: std
components:
kinetic:
plugin:
type: field
name: LMDZ
version: photochem
dir: /path/to/kinetic/directory
file: kinetic.lmdz9696.%Y.%m.nc
file_freq: 1MS
The following structure is excepted for the NetCDF files (the photolisys rates
'jXX'
are optional):
dimensions:
time_counter = 31 ;
lat = 96 ;
lon = 96 ;
presnivs = 39 ;
variables:
int64 time_counter(time_counter) ;
time_counter:units = "days since 1985-01-01" ;
time_counter:calendar = "proleptic_gregorian" ;
float lat(lat) ;
lat:axis = "Y" ;
lat:standard_name = "latitude" ;
lat:units = "degrees_north" ;
lat:valid_min = -90.f ;
lat:valid_max = 90.f ;
lat:long_name = "Latitude" ;
lat:nav_model = "Default grid" ;
float lon(lon) ;
lon:axis = "X" ;
lon:standard_name = "longitude" ;
lon:units = "degrees_east" ;
lon:valid_min = -180.f ;
lon:valid_max = 176.25f ;
lon:long_name = "Longitude" ;
lon:nav_model = "Default grid" ;
float presnivs(presnivs) ;
presnivs:axis = "Z" ;
presnivs:standard_name = "model_level_number" ;
presnivs:units = "sigma_level" ;
presnivs:valid_min = 1.f ;
presnivs:valid_max = 39.f ;
presnivs:title = "sig_s" ;
presnivs:long_name = "Niveaux sigma" ;
float temp(time_counter, presnivs, lat, lon) ;
temp:long_name = "temperature" ;
double pmid(time_counter, presnivs, lat, lon) ;
pmid:long_name = "pressure" ;
float j01(time_counter, presnivs, lat, lon) ;
j01:long_name = "photolisys rates" ;
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
Requirements¶
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
---|---|---|---|---|---|
domain |
False |
False |
LMDZ |
std |
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: LMDZ
4 version: photochem
5 type: datastream
6
7 # Optional arguments
8 dir: XXXXX # str
9 file: XXXXX # str
10 varname: XXXXX # str
11 file_freq: XXXXX # str