LMDZ
/ std
¶
Description¶
This is the plugin to run the model LMDZ. Please see further details on LMDZ itself here
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:
Mandatory arguments¶
fileexec: (mandatory)
path to DISPERSION executable
accepted type: <class ‘str’>
file_controle: (mandatory)
path to a restart file. It is used to update the controle variables in the initial condition files. It is especially important when directly interpolating initial conditions from another dataset. It is also used to update the initial date if different from the restart provided in the data vector
accepted type: <class ‘str’>
Optional arguments¶
autoflush: (optional): True
Clean sub-directories of temporary files (mod.bin, etc.)
accepted type: <class ‘bool’>
periods: (optional): 1MS
Frequency for sub-simulations
accepted type: <class ‘str’>
flx_tresol: (optional): 1D
Expected time step between flux values in the executable
accepted type: <class ‘str’>
physic: (optional): True
Use physics in LMDZ
accepted type: <class ‘bool’>
thermals: (optional): False
Use thermals
accepted type: <class ‘bool’>
conv_scheme: (optional): TK
Convection scheme to use for the deep-convection
accepted values:
TK: Tiedke parametrization; corresponds to convection scheme #2 in LMDZ
KE: Kerry-Emmanuel parametrization; corresponds to convection scheme #3 in LMDZ
KT-Them: Kerry-Emmanuel parametrization + thermics; corresponds to convection scheme #30 in LMDZ
dump: (optional): False
Dump trajq as netCDF
accepted type: <class ‘bool’>
do_chemistry: (optional): True
Use the chemistry
accepted type: <class ‘bool’>
auto-recompile: (optional): False
Auto-compile executables before running if executables not available
accepted type: <class ‘bool’>
force-recompile: (optional): False
Force compilation even if executables available
accepted type: <class ‘bool’>
force-compile-stderr: (optional): False
Force printing what happened during compiling
accepted type: <class ‘bool’>
compile-clean: (optional): False
Cleaning repositories before compiling; slows the compilation but prevent side-effects from re-compiling.Can be switched of for minor modifications in the code
accepted type: <class ‘bool’>
compile-mode: (optional): PROD
Compilation mode
accepted values:
PROD: production mode; all optimizations are activated
DEBUG: check-all and traceback are activated, hence slowing down the execution
compiler: (optional): ifort
Compiler to use
accepted values: [‘ifort’, ‘gfortran’]
mpirun: (optional): mpirun
path to mpirun
accepted type: <class ‘str’>
run_options: (optional): []
MPI options
nfilun: (optional): 16
Parameter used in LMDZ sources in
libf/firtrez/parafilt.h
accepted type: <class ‘int’>
nfilus: (optional): 15
Parameter used in LMDZ sources in
libf/firtrez/parafilt.h
accepted type: <class ‘int’>
nproc: (optional)
Force using a given number of processors. By default, LMDZ uses all available processors
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 |
|
flux |
True |
False |
LMDZ |
sflx |
|
chemistry |
False |
False |
CHIMERE |
gasJtab |
|
emis_species |
True |
False |
LMDZ |
bin |
|
meteo |
True |
False |
LMDZ |
mass-fluxes |
|
inicond |
True |
False |
LMDZ |
ic |
|
prescrconcs |
True |
False |
LMDZ |
prescrconcs |
|
kinetic |
True |
False |
LMDZ |
photochem |
|
prodloss3d |
True |
False |
LMDZ |
prodloss3d |
Yaml template¶
Please find below a template for a Yaml configuration:
1model:
2 plugin:
3 name: LMDZ
4 version: std
5 type: model
6
7 # Mandatory arguments
8 fileexec: XXXXX
9 file_controle: XXXXX
10
11 # Optional arguments
12 autoflush: XXXXX
13 periods: XXXXX
14 flx_tresol: XXXXX
15 physic: XXXXX
16 thermals: XXXXX
17 conv_scheme: XXXXX
18 dump: XXXXX
19 do_chemistry: XXXXX
20 auto-recompile: XXXXX
21 force-recompile: XXXXX
22 force-compile-stderr: XXXXX
23 compile-clean: XXXXX
24 compile-mode: XXXXX
25 compiler: XXXXX
26 mpirun: XXXXX
27 run_options: XXXXX
28 nfilun: XXXXX
29 nfilus: XXXXX
30 nproc: XXXXX