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: 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: str

Optional arguments

autoflush: (optional): True

Clean sub-directories of temporary files (mod.bin, etc.)

accepted type: bool

dir_sources: (optional):

Path to DISPERSION sources. Overwrites fileexec if specified.

accepted type: str

periods: (optional): 1MS

Frequency for sub-simulations

accepted type: str

flx_tresol: (optional): 1D

Expected time step between flux values in the executable

accepted type: str

physic: (optional): True

Use physics in LMDZ

accepted type: bool

thermals: (optional): False

Use thermals

accepted type: bool

compressed_phystoke: (optional): False

Use compressed phystoke files

accepted type: 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: bool

do_chemistry: (optional): True

Use the chemistry

accepted type: bool

auto-recompile: (optional): False

Auto-compile executables before running if executables not available

accepted type: bool

force-recompile: (optional): False

Force compilation even if executables available

accepted type: bool

force-compile-stderr: (optional): False

Force printing what happened during compiling

accepted type: 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: 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: str

run_options: (optional): []

MPI options

nfilun: (optional): 16

Parameter used in LMDZ sources in libf/firtrez/parafilt.h

accepted type: int

nfilus: (optional): 15

Parameter used in LMDZ sources in libf/firtrez/parafilt.h

accepted type: 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

Domain

False

False

LMDZ

std

flux

DataStream

True

False

LMDZ

sflx

chemistry

Chemistry

False

False

CHIMERE

gasJtab

emis_species

DataStream

True

False

LMDZ

bin

meteo

DataStream

True

False

LMDZ

mass-fluxes

inicond

DataStream

True

False

LMDZ

ic

prescrconcs

DataStream

True

False

LMDZ

prescrconcs

kinetic

DataStream

True

False

LMDZ

photochem

prodloss3d

DataStream

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  # str
 9  file_controle: XXXXX  # str
10
11  # Optional arguments
12  autoflush: XXXXX  # bool
13  dir_sources: XXXXX  # str
14  periods: XXXXX  # str
15  flx_tresol: XXXXX  # str
16  physic: XXXXX  # bool
17  thermals: XXXXX  # bool
18  compressed_phystoke: XXXXX  # bool
19  conv_scheme: XXXXX  # TK|KE|KT-Them
20  dump: XXXXX  # bool
21  do_chemistry: XXXXX  # bool
22  auto-recompile: XXXXX  # bool
23  force-recompile: XXXXX  # bool
24  force-compile-stderr: XXXXX  # bool
25  compile-clean: XXXXX  # bool
26  compile-mode: XXXXX  # PROD|DEBUG
27  compiler: XXXXX  # ifort|gfortran
28  mpirun: XXXXX  # str
29  run_options: XXXXX  # any
30  nfilun: XXXXX  # int
31  nfilus: XXXXX  # int
32  nproc: XXXXX  # any