Miscellaneous Documentation

DEODE environment variables

The following environment variables can be used to control various behaviour.

DEODE_LOGLEVEL sets the logger log level. Select e.g. between info and debug. For more options see the loguru documentation.
DEODE_HOST allows to override the automatic detection of host. The host is used to pick up specific configuration settings. See e.g. deode show host
DEODE_CONFIG_DATA_DIR sets additional search paths for config files. This is useful when using DEODE as a package. To see paths in use run deode show paths.

Local installations

In the following we have gathered instructions for all known platforms. If a platform is missing please add instructions.

Adding a new host

In the following we have gathered instructions for all known platforms. In the standard case a host/platform can be recognized either through the host name or by identifying a specific environment variable. This is configured in deode/data/config_files/known_hosts.yml. In the example below we see how atos_bologna and lumi are regonized via a hostname regular expression whereas freja is recognized from a specific environment variable. A hostname can also be forced by setting the DEODE_HOST environment variable which overrides all settings in the known_hosts.yml file.

atos_bologna :
  hostname : "ac\\d-\\d\\d\\d"
lumi :
  hostname : "uan\\d\\d"
freja:
  env:
   SNIC_RESOURCE: "freja"

Any new host should be added in the same way and the names for the configuration files for platform, scheduler and submission should be named using the given hostname.

Setup ecflow

The ecflow server setup is defined in deode/data/config_files/include/scheduler/ecflow_@HOST@.toml. For your local installation you might add the proper configurations, e.g. ecflow_freja.toml:

[scheduler.ecfvars]
  ecf_files = "/nobackup/smhid20/users/@USER@/deode_ecflow/ecf_files"
  ecf_files_remotely = "/nobackup/smhid20/users/@USER@/deode_ecflow/ecf_files"
  ecf_home = "/nobackup/smhid20/users/@USER@/deode_ecflow/jobout"
  ecf_host = "le1"
  ecf_jobout = "/nobackup/smhid20/users/@USER@/deode_ecflow/jobout"
  ecf_out = "/nobackup/smhid20/users/@USER@/deode_ecflow/jobout"
  ecf_port = "_set_port_from_user(10000)"
  ecf_ssl = "0"
  hpc = "freja"

Note there are two functions available for the detection of ecf_port and ecf_host that might help to detect correct values for these two variables. _set_port_from_user() sets a user-id related ecf_port while _select_host_from_list() finds the active ecf_host from a list of possible hostnames (used in ecflow_atos_bologna.toml). Both functions are defined in deode/scheduler.py

freja

Freja is the SMHI research cluster operated by NSC. For more details see https://nsc.liu.se/systems/freja

Installing under mamba

Get the code

git clone git@github.com:destination-earth-digital-twins/Deode-Workflow.git
cd Deode-Workflow

Create a conda environment and install ecflow, gdal and poetry.

$ module purge
$ module load Mambaforge/23.3.1-1-hpc1
$ mamba create -p .conda ecflow gdal=3.5.0 poetry python=3.10.4
...
$ mamba activate .conda/

Install deode and all it’s dependencies

(deode-py3.10) $ poetry install

Now we’re ready to go!

deode-py3.10) $ deode --version
2024-05-20 13:00:19 | INFO     | Start deode v0.5.0 --> "deode --version"
deode v0.5.0
mamba deactivate

To load your new environment do

$ cd Deode-Workflow
$ mamba activate .conda/

Note that for the time being ( until the mamba/poetry usage is better understood ) it’s recommended to make this procedure, with a new mamba name, for each new deode clone.

Contact

Have a chat with Ulf Andrae, FoU-Met

Available tasks

Preparation of static files

This section contains tasks that are done only once during a model run. In case the static files already exists the tasks can be deactivated in the suite setting config.suite_control.create_static_data to False. The location of the background input data used is defined in config.platform and the resulting output files are stored in a directory defined by config.system.climdir.

Surfex

deode.tasks.gmtedsoil.Gmted prepares topograhpic data from gmted input data.
deode.tasks.gmtedsoil.Soil prepares soil data input for PGD using SOILGRID.
deode.tasks.sfx.Pgd runs PGD using ECOCLIMAP SG for either a single 10 day period or the full year. Check config.pgd for PGD configuration options and use deode show namelist [--config-file your_config.toml] -t surfex -n pgd to print the used namelist.
deode.tasks.e923.PgdUpdate updates the topography in the Const.Clim.sfx file with the one filtered/truncated in E923Constant.

E923

These task handles the generation of the non-SURFEX related static data required by the model. Type deode show namelist -t master -n show to show the available namelists used in e923.

deode.tasks.e923.E923Constant generates the constant part of the e923 files.
deode.tasks.e923.E923Monthly generates the monthly part of the e923 files.
deode.tasks.e923_update.E923Update: In case of CSC=ALARO selected physiography fields are taken from the initial surfex files and written back to the e923 used. This is only performed once. Read more about the task here.

Input data

deode.tasks.marsprep.Marsprep extracts IFS data from MARS if the expected data is not found on disk. The location of the data on disk is by default outside of a specific case so the input data can easily be reused for several runs. Implemented data sources are described in config.mars
deode.tasks.sfx.Prep creates the initial state file for SURFEX using PREP. Input data can be either IFS or AROME/HARMONIE-AROME data. The namelist used for Prep can be generated by deode show namelist [--config-file your_config.toml] -t surfex -n prep
deode.tasks.c903.C903 creates an initial atmospheric state and boundary files from a global ECMWF file. Use deode show namelist [--config-file your_config.toml] -t master -n c903_[main|domain] to see the two namelists required.
deode.tasks.e927.E927 creates an initial atmospheric state and boundary files from a AROME/HARMONIE-AROME file. Use deode show namelist [--config-file your_config.toml] -t master -n e927 to see the namelist used.

Forecasting

deode.tasks.forecast.Forecast runs the forecast for any of the three CSCs. Namelists can be extracted with deode show namelist [--config-file your_config.yoml] -t master -n forecast for the upper air namelist and with -t surfex -n forecast for the surfex part.

Postprocessing

deode.tasks.creategrib.CreateGrib converts FA files to GRIB files. Configured to only work with output from SURFEX producing GRIB1 files.
deode.tasks.extractsqlite.ExtractSQLite extracts data for point verification with harp. Options defined in config.extractsqlite and in the parameter lists under deode/data/sqlite

Archiving

All non temporary files produced by the Deode-Workflow are stored in a directory defined by config.system.archive usually defined as SOME_PATH/YOUR_EXP/archive/YYYY/MM/DD/HH. Depending on your system these file may be left there for further usage or sent to a more permanent storage. Currently support is implemented or on the way to be implemented for the following

ecfs: Archiving on ECMWF ECFS tape system, either under ec or ectmp.
fdb: Archiving in FDB for further internal usage or for propagation to the data bridge (in case of operataions). This is still under development.
scp: Send files to an arbitrary remote host using scp. The location and access details are configured under config.archiving.scp.

For archiving we have the following two tasks

deode.tasks.archive.ArchiveStatic archives the output from the Pgd and E923 tasks. Configured under config.archiving.ecfs.static.
deode.tasks.archive.ArchiveHour archives output from each cycle. Configured under config.archiving.ecfs.

Cleaning

These tasks takes care of temporary files and directories or files that has been archived as described above. The rules for the cleaning tasks described below are defined in config.cleaning.TASK. Read more about the cleaning here.

deode.tasks.cleaning_tasks.PreCleaning prepares the run by removing old ecflow output and job files.
deode.tasks.cleaning_tasks.CycleCleaning runs after each cycle and removes old directories and files with some delay as defined in the configuration.
deode.tasks.cleaning_tasks.PostMortem runs at the very end of the suite and could potentially remove all obsolete ecflow output files.

Configure cases

The case setup

The Deode-workflow is designed to be highly configurable and driven from a single config file. The deode case functionality offers a way to reduce the number of lengthy config files by building the final config file from smaller sections of configuration settings. A number of pre-defined configurations are available under deode/data/config_files/configurations

Example usage would be:

deode case ?deode/data/config_files/configurations/cy48t3_alaro_gpu_lumi -o test.toml

where ? is a file includer operator where all the arguments are defined line by line. I.e. deode/data/config_files/configurations/cy48t3_alaro_gpu_lumi contains a list of arguments to be evaluated. In this case we have

--config-file
deode/data/config_files/config.toml
deode/data/config_files/modifications/CY48t3.toml
deode/data/config_files/modifications/alaro.toml
deode/data/config_files/include/accelerator_device/lumi_gpu.toml
deode/data/config_files/modifications/submission/lumi_CY48t3_gpu_large_domain.toml

When the first config file, config.toml, has been read the appropriate files for the current host is included for scheduler platformand submission.

The following configuration files will be read and added in order of appearence. If we check the various files we find that e.g. alaro.toml only contains the bare minimum changes on top of the default configuration file required to run the ALARO CSC.

The processed configuration output file, here test.toml, is self contained from a config point of view. All configuration settings (also defaults from json schema) are in the generated configuration file.

The produced config file, test.toml is now used to start a run the usual way.

deode start suite --config-file test.toml

We can also do everything in one by adding the --start-suite flag

deode case ?deode/data/config_files/configurations/cy48t3_alaro_gpu_lumi -o test.toml --start-suite

To see all commands available for the case functionality run deode case --help.

Adding a new host

The host you’re running on can be recognized either through the host name or by identifying a specific environment variable. This is configured in deode/data/config_files/known_hosts.yml. In the example below we see how atos_bologna and lumi are regonized via a hostname regular expression whereas freja is recognized from a specific environment variable.

atos_bologna:
  hostname: "ac\\d-\\d\\d\\d"
lumi:
  hostname: "uan\\d\\d"
freja:
  env:
    SNIC_RESOURCE: "freja"
linda:
  env:
    SMHI_DIST: "linda\\d+"
leonardo:
  hostname: ".*leonardo.*"

Any new host should be added in the same way and the names for the configuration files for platform, scheduler and submission should be named using the given hostname.

Time handling

A typical use case is to run the same configuration for a number of dates or a longer period. The example above could easily be modified to run for any arbitrary date by running

deode case ?deode/data/config_files/configurations/cy48t3_alaro_gpu_lumi time.toml -o test.toml

where time.toml contains

[general.times]
  end = "YYYY-MM-DD:HH:mm:ssZ"
  start = "YYYY-MM-DD:HH:mm:ssZ"

or any additional extra information.

EPS setup

Enabling EPS

To enable EPS, one has to include an EPS include file in the configuration or on the commandline. A default EPS include file is provided in the deode/data/config_files/include/eps/eps_members.toml file. Thus, to run the default EPS setup, one can do

deode case --config-file deode/data/config_files/config.toml deode/data/config_files/include/eps/eps_members.toml

or include the following in the configuration file

--config-file
deode/data/config_files/config.toml
deode/data/config_files/include/eps/eps_members.toml

and do

deode case --config-file <path_to_config_file>

The default EPS include file contains the following settings:

[eps.general]
  control_member = 0
  members = "0:3"
  run_continously = false

[eps.member_settings.boundaries.ifs]
  selection = {"1:3" = "IFSENS"}

[eps.member_settings.general]
  realization = "-1"

Translated into words, including this file in the main config file will make the deode case command produce a config file with three members, where the first member is the control member. The three members will use the lateral boundary data from corresponding IFSENS member.

Resulting config file:

[eps.general]
  control_member = 0
  members = [0, 1, 2]
  run_continously = false

[eps.member_settings.boundaries.ifs]
  selection = "IFSENS"

[eps.member_settings.general]
  realization = "-1"

[eps.members.0.general]
  realization = 0

[eps.members.1.general]
  realization = 1
  selection = "IFSENS"

[eps.members.2.general]
  realization = 2
  selection = "IFSENS"

Configuring EPS

In the general EPS settings section, one can set the control member as well as the members that should be part of the ensemble. The members setting can either be

a list of integers or
a string sequence of integers or slices separated by commas

E.g. members = [1, 3, 5] will include members 1, 3, and 5 in the ensemble, whereas members = "0, 1, 2, 4:10:2" will include members 0, 1, 2, 4, 6, and 8. The format of the string slices follows the Python slice notation, i.e. start:stop:step. The default value for step is 1, so start:stop is equivalent to start:stop:1.

The control member can be set to any integer. If the control member is not part of the (expanded) members list, it will be added to the ensemble automatically.

To adjust the default member settings to ones needs, one can set member specific settings for basically any existing settings of the Deode-Workflow config file. There are various ways to do this, but in any case the settings shall be placed under the [eps.member_settings] section in the eps include file with the full original config section string appended to “eps.member_settings”. E.g. to adjust the [general.output_settings] section member specifically, one would add the section

[eps.member_settings.general.output_settings]
fullpos = "..."

to the eps include file. The various ways of setting member specific settings are:

1. Single value -> all members get the same setting

[eps.member_settings]
parameter = "value"

Result:

[eps.members.0]
  parameter = "value"
[eps.members.1]
  parameter = "value"
...

2. List of values -> first member gets first item, second member gets second item, etc. (with “circular boundary condition”)

[eps.member_settings]
parameter = ["value1", "value2", "value3", "..."]

Result:

[eps.members.0]
  parameter = "value1"
[eps.members.1]
  parameter = "value2"
...
[eps.members.N]
  parameter = "valueN"
[eps.members.N+1]
  parameter = "value1"
...

3. Dict of mbr/value pairs -> a given member get the value of the mbr key

[eps.member_settings]
parameter = {0 = "value1", 1 = "value2", "2:5:2" = "value3", ...}

Result:

[eps.members.0]
  parameter = "value1"
[eps.members.1]
  parameter = "value2"
[eps.members.2]
  parameter = "value3"
[eps.members.4]
  parameter = "value3"

4. Python subclass of `deode.eps.custom_generators.BaseGenerator`. Generates member settings based on list of members.

E.g. to generate random boolean values for each member, one could define a generator class like

@pydantic_dataclass
class BoolGenerator(BaseGenerator[bool]):
    """Example generator class to generate random boolean values."""

    def __iter__(self):
        for _ in self.members:
            yield random.choice([True, False])

and set the parameter to a string that points to the given class object like

[eps.member_settings]
parameter = "deode.eps.custom_generators.BoolGenerator"

Result:

[eps.members.0]
  parameter = true
[eps.members.1]
  parameter = false
[eps.members.2]
  parameter = false
...

Domain configuration

Define new domains

The domain you use for your run needs to be defined in a toml file and placed in include/domains folder and few test domains are provided.

We recommend you use tools like domain_maker.py (EpyGraM) or Domain Creation Tool (follow the link) to define your domain.

The parameters you can put into your domain configuration can be found in the config/domain section.

Some of the parameters are optional and derived automatically if not provided:

ilone / ilate: If not provided will default to 11 gridpoints.
nbzonl / nbzong: If not provided will be derived automatically from resolution (xdx/xdy) but if domain very small, i.e. less than 250 gridpoints in either direction, then the parameter defaults to 8 gridpoints.

Finally you’ll need to update domain under section [include] in your main config file and point it to your new domain toml file.

Handling of binaries

Describes the handling of binaries in deode.

Compilation and external sources

Currently the system provides no support for compilation of any of the IAL code required. This is expected to be prepared and compiled separately by e.g. gmkpack, cmake or similar. For the list of IAL cycles tested check the cycle key in the config documentation.

How to specify binaries

There are several ways to specify which binary to be used. The standard way is to set bindir in the system config section. This assumes all required binaries are in the given directory and with the names used in the task. If, for whatever reason, a specific task should pick binaries from another directory, or with another name we can define location and/or name on task level by introducing a new section in the config file like:

[submission.task_exceptions.Forecast]
 bindir = "SOME_NEW_PATH"
 binary = "SOME_NEW_NAME"

If a specific task should pick more then one binary from different directories, we can define it like this:

[submission.task_exceptions.TASK_NAME.binaries]
 NAME_OF_BINARY = { "binary" = "somename" , "bindir" = "somewhere" }
 NAME_OF_BINARY1= { "binary" = "somename" , "bindir" = "somewhere" }

where NAME_OF_BINARY is the argument of the function get_binary() used in the code. For e.g. the mars client it’s sometimes advisable to run with -n ( as in next version ). This then achieved by ( example from lumi )

[submission.task_exceptions.Marsprep.binaries]
 mars = { "binary" = "mars -n" , "bindir" = "/appl/local/destine/bin" }

Computational parameters in config file

The default config.toml file, parameters in the submission groups refer to a coarse-resolution run in a small domain and a short lead time.

When running at higher resolution on real-sized domains, it is suggested to take care of and adjust the following parameters:

WALLTIME: maximum wallclock time allowed by task. It can be raised in [submission.task_exceptions.{e927,Forecast,Pgd,Prep}.BATCH]. Raising it is suggested especially during climate generation, e.g., in [submission.task_exceptions.Pgd.BATCH].
NPROC: number of compute processes (can be also adjusted within [submission.task_exceptions.{e927,Forecast,Pgd,Prep}]).
NPROC_IO: number of compute processes used for the IO server (forecast runs only).
NODES: number of compute nodes.
NTASKS: number of MPI tasks. The total number of tasks defined for the forecast should be equal to NPROC + NPROC_IO.

Submission files for large domains can be found under include/submission folder and can be used directly or give guidance.

The parameter values encoding instructions in the BATCH groups are specific to the SLURM scheduler.

Namelist handling in deode

Describes the namelist handling in the Deode-Workflow.

Internal usage

The deode namelists are stored as yml files in deode/data/namelist_generation_input/CYCLE and assembled following a set of rules. The upper air and surfex namelists are stored in master_namelists.yml and surfex_namelists.yml respectively. In these config files the namelists are grouped depending on function and application. E.g. the namelist for generation of climate files (configuration E923) are separated in a base block, e923_base and one additional block for each step, e.g. e923_0. In assemble_master.yml the rules for how these blocks are combinged is defined. For the initial part, e923_part_0 is defined as

e923_part_0:
  - common_e923
  - e923_0

where common_e923 is another group in the assemble rules and e923_0 is a group in the namelist file. This will be expanded to the three namelist groups

  - empty
  - e923_base
  - e923_0

In addition the defined macros (see deode/data/config_files/include/macros.toml) are use in the namelist for config driven selections. For e.g. the forecast the settings are dependent on the CSC used as well as the forcing model and the config keys general.csc and boundaries.bdmodel are used accordingly like:

forecast:
  - master_common
  - f4_@CSC@
  - namgfl_@BDMODEL@

where e.g. @BDMODEL@ is substituted runtime to e.g. AROME or IFS which allows to pick of the corresponding section in master_namelists.yml.

Get a specific namelist from command line

For a given configuration file any namelist generated by the system can be extracted from command line using e.g. for the forecast

deode show namelist -t master -n forecast

If you are uncertain about the name of the namelist you’re searching for just type any name to get a list

deode show namelist -t master -n showme

If you’d like have the namelist without the substituted values from the config file add a -b to the command. For more information about namelist extraction use the help command.

deode show namelist -h

Add your own namelist

The simplest and recommended way to change a namelist is to extract it as described above using the -b option, make your modifications and add the namelist to the directory specified by system.namelists in the config file. The name of the namelist should be the same as when extracted above. Before the system will pick up your namelist you have to set general.accept_static_namelists = true in the config file. Note that for the main forecast namelist any existing fullpos select files following the name convention “xxt*” will be picked up as well if they exists. If not they will be generated.

Modify a namelist from config

There are several ways to modify namelists. We can either use the ${} syntax in the yaml files to substitute values. See e.g. how it’s done for nproma or lfftw defined in the submission sections. Another way is to introduce a namelist_update section like

  [namelist_update.master.all_targets]
    namdim = { nproma = -99 }
  [namelist_update.master.forecast]
    namrip =  {  ravgtime = 99.0 }

where the first section updates all used namelists and the latter updates the forecast namelist only. This allows us to introduce namelist changes for a specific configuration without having to edit the yaml files or a static namelist.

Configure selection of timings in output settings

Describes examples of timings in output settings for [general.output_settings] in the config file, see output settings.

Output timings must be specified as follows:

to configure a single output interval across the entire forecast length (e.g. outputs every hour, every 30 minutes and so on): a single string with format "PTnC", where n is a positive integer number and C can be hours, H, or minutes, M.
to configure different output intervals across the forecast length: a list of strings. Each string must be of the format "starttime:endtime:interval", where each of starttime, endtime, interval have the format PTnC as described above. More explicitly, the string starttime:endtime:interval instructs to generate forecast outputs with frequency interval (hour or minute) from the forecast step starttime to the forecast step endtime.

Example

Here we explain output intervals through an example:

  fullpos = ["PT0H:PT6H:PT15M", "PT6H:PT9H:PT30M", "PT9H:PT24H:PT1H"]
  history = "PT1H"
  nrazts = "PT1H"
  surfex = ["PT0H:PT9H:PT10M", "PT9H:PT24H:PT3H"]

With the above settings:

fullpos output will be created with a 15 minutes interval from the start until six hours, then with a 30 minutes interval until nine hours, then with a 1 hour interval onwards.
history output will be created with a 1 hour interval.
nrazts instantaneous fluxes will be reset hourly.
surfex output will be created with a 10 minutes interval from the start until nine hours, then with a 3 hour interval until 24 hours.

Configure selection of fields from fullpos

Describes how to select fields and output settings for fullpos. The scripting allows to select fields and levels without having to worry about how the namelist should be constructed, this is done by the system.

Overview

The fullpos output is controlled by the following settings

Output interval, see output settings
Field selection and settings for different output times is done in the fullpos main selection, deode/namelist_generation/CYCLE/master_selection.yml

Currently it’s only implemented support for a single domain using the native geometry of the domain used for the model run.

The fullpos config files

There are a number of fullpos config file types under deode/namelist_generation/fullpos/CYCLE/

rules.yml sets LEVEL_MAP and PARAM_MAP and tells how settings in the selection part should be translated to settings in NAMFPC. Normally this does not have to be changed.
namfpc_header.yml where we specify the non-field related settings in NAMFPC
master_selection.yml where all fields and levels are specified per output type as defined by fullpos. This config file is for hourly output
master_subhour_selection.yml defines similar as above but for subhourly output. The separation here allows a more fine grained control of the subhourly output streams.
A number of impact model selections defined for all output steps.

The settings done in the selection part will be used to fill NAMFPC and the correct level numbers will be filled in the final namelist.

NAMFPC settings

In the section we can add general fullpos settings as in the example below.

NAMFPC:
    NFPGRIB: 141
    CFPDOM: "${domain.name}"
    LFPCAPEX: True
    LFPMOIS: False
    L_READ_MODEL_DATE: True
    NFPCAPE: 5

Selection

In the selection section we specify all fields to be produced by fullpos. Following the time selection logics we define the subsection as an arbitrary number of xxtddddhhmm choices. The default setup contains a general selection and on for t=0, i.e. xxt00000000.

The logics follows the namelists used by fullpos. For 2D fields we specify the field names in the appropriate sections. For 3D fields there are two ways. We can specify the fields directly as in here:

  NAMFPDYH:
   CL3DF:
     - 'CLOUD_FRACTI'
     - 'GRAUPEL'
   RFP3H:
     - 20.0
     - 50.0

If there is a wish for different levels for different fields we can specify this as

  NAMFPDYP:
   VOR:
    CL3DF:
     - 'ABS_VORTICITY'
    RFP3P:
     - 5000.0
     - 10000.0
   DIV:
    CL3DF:
     - 'DIVERGENCE'
    RFP3P:
     - 70000.0
     - 80000.0

Where VOR and DIV in the example above are just arbitrary names used to separate the different choices. Note that it’s not possible to combine grouped and none grouped settings.

Combine selection files

A number of selection files can be combined by adding keys to fullpos.selection in the fullpos part of the config file

[fullpos.selection]
 AROME = ["master_selection" ,"aq_selection"]

The name AROME here is just a label. This allows to define different combination of output depending on other configuration choices.

Example

The fullpos namelists can be generated from command line using

deode --config-file deode/data/config_files/config.toml show namelist -t master -n forecast_bdmodel_ifs

This will produce the namelist for the forecast and as many xxt* files as has been defined in the fullpos yaml file.

e923 Update

This utility copies the roughness length fields from sfx files to FA climate file, written by Jan Mašek.

It is necessary for ALARO at high resolutions (<5 km). See Jan’s original instructions below. NB:

intially this tool was meant for ECOCLIMAPII first generation (within DEODE workflow we use ECOCLIMAPII SG).

Original instructions:

Utility e923_update serves for updating roughness fields in e923 clim files from SURFEX, i.e. using GMTED2010 topography and ECOCLIMAP physiography. As a preparatory step, climake for target domain must be run, delivering PGD file and preliminary clim files.

Update of subgrid-scale orographic characteristics (variance, anisotropy, orientation of the main axis) from PGD file is also possible, but it must be done on the level of climake, using modified e923 step and ALADIN executable with modified subroutine EINCLI1. It is not needed if you do not want to use parameterization of gravity wave drag (LGWD=F).

Adding a New Task

Follow the instructions below to add a new task to the system.

Code requirements

In order to start adding a new task to the deode workflow, a file containing your task needs to be created in the $DEODE_WORKFLOW/deode/tasks folder, where $DEODE_WORKFLOW points to the full name to the folder in which the deode workflow is installed.

In the tasks folder, the discover_task.py file looks for the task specified in the deode run command. The task name should be the name of the class of your task, as it’s in the class names that discover_task.py gets the tasks available. For ease of use, the file name containing your class can also be named the same as the class.

A created task class usually inherits the Task class from the base.py file inside the tasks folder The new tasks inherit the Task class, one can define their own execute , prep , post and run functions and possibly define new ones.

Inside that [task.taskname] directive, the wrapper and command settings could be set to their appropriate values if they are used by the task. The wrapper setting sets a wrapper for the command needed to be run, most commonly commands time or srun. The wrapper setting comes from the BatchJob class included from batch.py inside base.py.

wrapper = self.get_task_setting("wrapper")
self.batch = BatchJob(os.environ, wrapper)

cmd = self.get_task_setting("command")
self.batch.run(cmd)

The run function of the BatchJob class unites these two settings before running them as one in our task.

cmd = self.wrapper + " " + cmd

Handling output

In order to copy files, inside the task.py file, the fmanager directive from the deode/toolbox.py file needs to be used. To create the input for the task, the fmanager.input function needs to be called.

def input(
    self,
    target,
    destination,
    basetime=None,
    validtime=None, # noqa
    check_archive=False,
    provider_id="symlink",
)

The fmanager.input only has two non-optional arguments and providers for symlink, copy, move and ECFS. The paths used with fmanager should be put into macros and not hardcoded. To link for example MASTERODB, one needs to call the function the following way: self.fmanager.input("@BINDIR@/MASTERODB", "MASTERODB") To copy or move, one only needs to add a provider_id: self.fmanager.input("@BINDIR@/MASTERODB", "MASTERODB", provider_id="copy")

To handle output data, the fmanager.output function needs to be called after the running of the code in a similar way as the input. Example: self.fmanager.output("ICMSH@CNMEXP@+000?", "@OUTDIR@/ICMSH@CNMEXP@+000?"). The same providers are available for output as for input.

Submission rules for a task

In order to setup submission options, they need to be added to the config.toml file needs. One can either add to an already existing submit type, like the default serial, or create their own submission type. To add SLURM options, a name of the option along with the option itself needs to be added inside the submission.submissiontype.BATCH directive:

[submission.parallel.BATCH]
WALLTIME = "#SBATCH --time=00:11:00"
QOS = "#SBATCH --qos=np"
NTASKS = "#SBATCH --ntasks=128"
CORES = "#SBATCH --cpus-per-task=4"
MULTITHREAD = "#SBATCH --hint=nomultithread"
NODES = "#SBATCH -N 4"
NAME = "#SBATCH --job-name=fcast_task"
ACCOUNT = "#SBATCH -A msdeode"

To add environment variables, run modules or arbitrary commands, they need to be added to the submission.submissiontype.ENV directive

[submission.parallel.ENV]
MODULE = "print('My beautiful module')"
OS = "import os"

One can also specify these in a task.exceptions directive:

[submission.task_exceptions.Newtask.BATCH]
WALLTIME = "#SBATCH --time=00:11:00"
QOS = "#SBATCH --qos=np"
NTASKS = "#SBATCH --ntasks=128"
CORES = "#SBATCH --cpus-per-task=4"
MULTITHREAD = "#SBATCH --hint=nomultithread"
NODES = "#SBATCH -N 4"
NAME = "#SBATCH --job-name=fcast_task"
ACCOUNT = "#SBATCH -A msdeode"

[submission.task_exceptions.Newtask.ENV]
MODULE = "print('My beautiful module')"
OS = "import os"

After that is all done, the new task can be ran with:

deode --config-file=/your/config.toml run --task yourtask  --template $PWD/deode/templates/stand_alone.py  --job $PWD/yourtask.job  --troika-config $PWD/config.yml  -o $PWD/yourtask.log

If config_file is specified under [troika] in config.yml, one can skip the --troika-config argument.

Plug-ins

Deode has the capability to add plug-ins. Internally deode itself is also treated as a plug-in, which is always enabled.

Plugin capablilities

In Deode suites and tasks are handled as plugins. The namespaces suites and tasks are searched for possible suites and tasks.

Running your own suite

The configuration setting below allows you to use an alternative suite defintion.

[general.suite_control]
suite_definition = "MySuite"

This should pick up the suite definition MySuite if it’s implementing the SuiteDefinition class from Deode.

Enable your own plug-in

The config file has a plugin_registry key inside the general part. The loaded plug-ins are defined inside the plugins key in the registry. The loaded plugins are stored as a dictionary, which uses namespaces as keys and paths as values.

An example could be to add the plugin with namespace “example” in location /tmp would be to add:

[general.plugin_registry.plugins]
"example": "/tmp"

In this case it is expected that the namespace “example” is located in /tmp/example. Suites in /tmp/example/suites and tasks in /tmp/example/tasks will be picked up.

Impact models

Impact models can be connected to the workflow in various ways. Here we describe the current implementation and how the hydrological model EHYPE have been connected. This may differ between different models, and in development and operations. For development this method is convenient but for operations, where various components may be distributed over several hosts, AVISO will be the main triggering platform.

General design

The methods dealing with connecting an impact model is defined in deode/tasks/impact.py. To add a new model we’d first have to introduce a new section in impact.toml.

[impact.ehype]
  active =  false                       # activates the specific model
  arguments = "@ARCHIVE@/ehype.json"    # are arguments given to the impcat model start command
  config_name = "@ARCHIVE@/ehype.json"  # config_name is a (potential) config file to give to the impact model
  path = "@EHYPE_PATH@"                 # path is the path to the impact model start command
  task = "StartImpactModels"            # task is the task in the workflow where the impact model should start from. Has to be defined in impact.py.

In addition a communicate section can be used to inform the impact model about date/time, location of data (disk/fdb), file names, output frequency and simlar things. For EHYPE we have the following keys:

[impact.ehype.communicate]
  archive_1 = "@ARCHIVE@"
  archive_2 = "@ECFS_PREFIX@/archive/@ARCHIVE_TIMESTAMP@"
  basetime = "@BASETIME@"
  file_template = "GRIBPF*h00m00s"
  forecast_range = "@FORECAST_RANGE@"
  name = "@CASE@_@YMD@_@HH@"
  nwp_model = "@CSC@"
  ouput_freq = "@FULLPOS_OUTPUT_FREQ@"

Once this is defined we need to write a function in impact.py that executes the impact model start command. For ehype it’s simply

    def ehype(path, args):
        cmd = f"{path}/deploy_suite.sh {args}"
        BatchJob(os.environ, wrapper="").run(cmd)

Finally we need to declare that this particular impact model is available on the host we’re running on. This is done by specifying the path to the installation in the platform config section. I.e. for atos we currently have

[platform.impact]
  ehype = "/home/snh02/DE_Impact/EHYPE/forecast/pyflow/utils"

With this is in place the impact model is ready for execution, from the workflow perspective.

EHYPE

The configuration settings for EHYPE are described in the example below. The model itself consists of two parts: One continous run to maintain a good initial state and the on-demand part triggered by the above mentioned settings. The activation above will trigger a separate suite following the settings in the communicate section. On atos EHYPE is installed under the sn02 user and execution is available for any user. Results will be found under $SCRATCH/$USER/DE_Impact/EHYPE.

Cleaning of experiment

The forecast suite produces a lot of files in the working and output folders. To avoid increased usage of file storage, it is needed to have a cleaning feature, which allows configurable options to delete files.

Each forecast experiment has a start and end dates and cycle length. These settings define the experiment timeline and used folders:

drawing

working folder - contains the workings folder of each suite task: wrk="@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@/"
archive folder - contains the forecast result folders: archive="@ARCHIVE_ROOT@/@ARCHIVE_TIMESTAMP@"="@ARCHIVE_ROOT@/@YYYY@/@MM@/@DD@/@HH@/"

These folder paths are parameterized by settings in the config file and its include setting files. Here for working folder the time parameters are from the experiment start date. For the archive folder the time parameters are specific for each cycle. Regular usage of suite forecast for different start dates produces a series of specific folders and files in the experiment working and archive folders.

Cleaning task to clean experiment files

It is added an option in the suite_control setting section of the config file, which allows to add or not an ecflow cleaning task.

[suite_control]
  do_cleaning = true

To use the cleanig task it is created a ecFlow task which is the last task in the forecast suite. It is triggered after successfully execution of the previous suite tasks.

Cleaning settings are grouped in the cleaning include file, which is referred as a setting in the include setting section of the config file.

cleaning = "include/cleaning.toml"

Cleaning settings are separeted to general default settings and folder specific settings:

cleaning scheme

defaults
  active = true  - turn on or turn off the cleaning task
  dry_run = true  - testing mode - to see which files would be deleted without their actual deletion. This could be seen in the task log file.
  include  = "(.*)" - regular expression which specifies which files to delete. "(.*)" is regular expesion which matches all files
  cleaning_delay = "P1D"
  cleaning_max_delay = "P2D"
  step = "PT6H"

cleaning_delay and cleanig_max_delay are period settings which define the cleaning time interval according to the expiriment start date

step - defines the time moments in the cleaning interval when to clean files

All of the default settings are required. But these values could be changed in the specific folder settings.

Settings for the working folder

Required settings are active and path. path defines the working folder path - the root folder which contains all working files and folders.

Example value of the working path: /ec/res4/scratch/bgmt/deode/CY48t3_AROME/20230916_0000/

[wrk]
  active = true
  dry_run = true
  include  = "ELS*"
  path = "@WRK@"

Settings for the archive folder

Required settings are active and path. Example value of the archive folder path is /ec/res4/scratch/bgmt/deode/CY48t3_AROME/archive/2023/09/16/00/

[archive]
  active = true
  dry_run = true
  include = "GRIBDEOD*"
  path = "@ARCHIVE@"
  cleaning_delay = "P1D"
  step = "PT6H"

The cleaning settings allow to define the cleaning time interval and step and which files to delete.

Some notes about using the FDB archive

Getting an expver

on ATOS run the following commands (Requires the user to be in unix group ifs):

module load pifsenv
getNewId -g d1.on-demand-extremes-dt

Note, expver is case-sensitive, so the expver aaaa and e.g. Aaaa is not the same.

Preparing the fdb tool

This is to use the fdb command line tool, if you want to read, write or wipe the data on FDB.

On ATOS:

export FDB_HOME=/home/fdbdev/destine/
export FDB5_HOME=/usr/local/apps/mars/versions/6.33.19.9/

On LUMI:

module use /appl/local/climatedt/modules

How to list available data

To list available data in fdb, use the fdb list (Here with head -10 to only read the 4 first entries):

fdb list class=d1,expver=aaaa | head -10

[OUTPUT]

Listing for request
retrieve,
        class=d1,
        expver=aaaa


{class=d1,dataset=on-demand-extremes-dt,expver=aaaa,stream=oper,date=20230916,time=0000}{type=fc,levtype=sfc}{step=6,param=129}
{class=d1,dataset=on-demand-extremes-dt,expver=aaaa,stream=oper,date=20230916,time=0000}{type=fc,levtype=sfc}{step=6,param=130}
{class=d1,dataset=on-demand-extremes-dt,expver=aaaa,stream=oper,date=20230916,time=0000}{type=fc,levtype=sfc}{step=6,param=134}
{class=d1,dataset=on-demand-extremes-dt,expver=aaaa,stream=oper,date=20230916,time=0000}{type=fc,levtype=sfc}{step=6,param=146}

How to retrieve archived data from FDB:

fdb read request.mars out.grib

Where the request.mars file looks something like this (Constructed from last line of output of the fdb list above):

retrieve,
    class = d1,
    dataset = on-demand-extremes-dt,
    expver = aaaa,
    stream = oper,
    date = 20230916,
    time = 0000,
    type = fc,
    levtype=sfc,
    step = 6,
    param = 146

How to set expver in DEODE Workflow

expver is set in the [fdb.grib_set] section of the archiving.toml file like this:

[fdb.grib_set]
  [...]
  tablesVersion = "32"
  expver = "aaaa"

Note

The combination of class, dataset, expver, stream, date and time must be unique for each user (user A can only archive to fdb folders owned by user A). This is fixed by using the expver generator explained above.

You also need to enable fdb archiving by setting the active variable for the relevant archiving tasks to true. Example for [archiving.hour.fdb.grib2_files]:

[archiving.hour.fdb.grib2_files]
  active = true
  inpath = "@ARCHIVE@"
  pattern = "GRIBPF*"

How to exclude variables from being archived

This is done by adding values to the archiving.toml configuration file under the [fdb.negative_rules] section:

[fdb]

[fdb.negative_rules]
  typeOfLevel = ["unknown", "not_found"]

This will exclude all grib-messages where typeOfLevel is unknown OR not_found. The values to filter can either be a single value or list.

Note

Currently on ATOS there is a bug where ECCODES will give an error: ECCODES ERROR : Unable to get typeOfLevel as string (Key/value not found), but still run as intended.

How to remove data

Use fdb wipe

To list out what data will be deleted:

fdb wipe class=d1,dataset=on-demand-extremes-dt,expver=JoLa,stream=oper,date=20230916,time=0600

And to actually delete it (add the –doit flag):

fdb wipe class=d1,dataset=on-demand-extremes-dt,expver=JoLa,stream=oper,date=20230916,time=0600 --doit

Note

This is a bit buggy on LUMI as the as the archive.lock file created while clearing the fdb-directory is not removed and as such you can not archive again into the same folder (defined by the combination class,dataset,expver,stream,date,time) without removing this archive.lock file.

Notes about georef

We are using a geohashing algorithm with Base64 string-representation of the hash, and a Hilbert space-filling curves instead of Z-order space-filling curves

The following section was automatically generated running deode doc config on 2025-02-17T10:27:31.

Config

Title: Config


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Model for validation of deode’s main config file.

Property	Type	Required	Default	Title/Description
general	object	Yes	-	General Section
suite_control	object	No	-	Suite control
clean_old_data	object	No	-	Cleaning old data
system	object	No	-	System
boundaries	object	No	-	Boundary Section
pgd	object	No	-	Pgd Section
fullpos	object	No	-	Fullpos Section
troika	object	No	-	Troika
include	object	No	-	Include Section
gribmodify	object	No	-	Section for modify grib
archiving	object	No	-	Archiving Section, defined in include/archiving.toml
cleaning	object	No	-	CleaningSection
domain	object	No	-	Domain Section, defined in files under include/domains
extractsqlite	object	No	-	Extract sqlite Section, defined in include/sqlite.toml
file_templates	object	No	-	File Templates, defined in include/file_templates.toml
impact	object	No	-	Impact model settings
macros	object	No	-	Macros Section, defined in include/macros.toml
mars	object	No	-	MARS settings, defined in include/mars_settings.toml
platform	object	No	-	Platform Section, defined in files under include/platform_paths
scheduler	object	No	-	Scheduler Section, defined in files under include/scheduler
submission	object	No	-	Submission Section, defined in files under include/submission
vertical_levels	object	No	-	Vertical Levels, defined in files under include/vertica_levels

Property `Config > general`

Title: General Section


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

Description: Model for the ‘general’ section.

Property	Type	Required	Default	Title/Description
times	Combination	Yes	-	Time-Related Entries
accept_static_namelists	boolean	No	-	Allow usage of static namelists as input for the tasks. The namelist should be located in the directory specified by platform.namelists and named with the convention namelist_{kind}_{task} where kind could be surfex or master and task forecast/pgd or similar. For the extraction of namelist see namelists.md.
case	string	No	“deode_case”	Experiment name
realization	Combination	No	“”	Placeholder for future ensemble or similar need
cnmexp	string	No	“DEOD”	Experiment short name
loglevel	enum (of string)	No	-	Logger output level
surfex	boolean	No	-	SURFEX switch
keep_workdirs	boolean	No	-	Do not remove working directories
csc	enum (of string)	No	“AROME”	CSC
cycle	enum (of string)	No	-	IAL cycle
event_type	enum (of string)	No	“nwp”	Type of extreme event
initfile	string	No	-	Initial file for the forecast object. Normally no need to provide unless there are special requirements or the forecast object is used in stand alone mode.
initfile_sfx	string	No	-	Initial surfex file for the forecast object. Normally no need to provide unless there are special requirements or the forecast object is used in stand alone mode.
namelist	object	No	-	Namelist
output_settings	object	No	-	Output Settings
remove_sections	array	No	[]	Sections to remove prior to config merge
windfarm	boolean	No	false	Switch on wind farm parameterisation

Property `Config > general > times`

Title: Time-Related Entries


Type	`combining`
Required	Yes
Additional properties	[Any type: allowed]

Description: Model for the ‘general.times’ section.

Property	Type	Required	Default	Title/Description
forecast_range	string	No	-	Forecast range
start	string	No	-	Start
end	string	No	-	End
list	array of string	No	-	List
cycle_length	string	No	“PT3H”	Cycle length defined as duration
basetime	string	No	-	Initial date and time for the current task.
validtime	string	No	-	Final date and time for the current task.

One of(Option)
item 0
item 1

Property `Config > general > times > oneOf > item 0`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1

Property `Config > general > times > oneOf > item 0 > anyOf > item 0`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Must not be


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

list

The following properties are required

start

Property `Config > general > times > oneOf > item 0 > anyOf > item 1`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Must not be


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1
item 2

Property `Config > general > times > oneOf > item 0 > anyOf > item 1 > not > anyOf > item 0`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

end

Property `Config > general > times > oneOf > item 0 > anyOf > item 1 > not > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

list

Property `Config > general > times > oneOf > item 0 > anyOf > item 1 > not > anyOf > item 2`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

start

The following properties are required

basetime

Property `Config > general > times > oneOf > item 1`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Must not be


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1

Property `Config > general > times > oneOf > item 1 > not > anyOf > item 0`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

start

Property `Config > general > times > oneOf > item 1 > not > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

end

The following properties are required

list

Property `Config > general > times > forecast_range`


Type	`string`
Required	No
Format	`duration`

Description: Forecast range

Property `Config > general > times > start`


Type	`string`
Required	No
Format	`date-time`

Description: Start

Property `Config > general > times > end`


Type	`string`
Required	No
Format	`date-time`

Description: End

Property `Config > general > times > list`


Type	`array of string`
Required	No

Description: List

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
list items	-

Config > general > times > list > list items


Type	`string`
Required	No
Format	`date-time`

Property `Config > general > times > cycle_length`


Type	`string`
Required	No
Format	`duration`
Default	`"PT3H"`

Description: Cycle length defined as duration

Property `Config > general > times > basetime`


Type	`string`
Required	No
Format	`date-time`

Description: Initial date and time for the current task.

Property `Config > general > times > validtime`


Type	`string`
Required	No
Format	`date-time`

Description: Final date and time for the current task.

Property `Config > general > accept_static_namelists`


Type	`boolean`
Required	No

Description: Allow usage of static namelists as input for the tasks. The namelist should be located in the directory specified by platform.namelists and named with the convention namelist_{kind}_{task} where kind could be surfex or master and task forecast/pgd or similar. For the extraction of namelist see namelists.md.

Property `Config > general > case`


Type	`string`
Required	No
Default	`"deode_case"`

Description: Experiment name

Property `Config > general > realization`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]
Default	`""`

Description: Placeholder for future ensemble or similar need

One of(Option)
item 0
item 1

Property `Config > general > realization > oneOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > general > realization > oneOf > item 1`


Type	`number`
Required	No

Restrictions
Minimum	≥ 0

Property `Config > general > cnmexp`


Type	`string`
Required	No
Default	`"DEOD"`

Description: Experiment short name

Restrictions
Min length	4
Max length	4

Property `Config > general > loglevel`


Type	`enum (of string)`
Required	No

Description: Logger output level

Must be one of:

“CRITICAL”
“ERROR”
“DEBUG”
“INFO”
“WARNING”

Property `Config > general > surfex`


Type	`boolean`
Required	No

Description: SURFEX switch

Property `Config > general > keep_workdirs`


Type	`boolean`
Required	No

Description: Do not remove working directories

Property `Config > general > csc`


Type	`enum (of string)`
Required	No
Default	`"AROME"`

Description: CSC

Must be one of:

“AROME”
“ALARO”
“HARMONIE_AROME”

Property `Config > general > cycle`


Type	`enum (of string)`
Required	No

Description: IAL cycle

Must be one of:

“CY49t2”
“CY48t3”
“CY46h1”

Property `Config > general > event_type`


Type	`enum (of string)`
Required	No
Default	`"nwp"`

Description: Type of extreme event

Must be one of:

“airquality”
“convection”
“flooding”
“heatwave”
“nwp”
“storm”

Property `Config > general > initfile`


Type	`string`
Required	No

Description: Initial file for the forecast object. Normally no need to provide unless there are special requirements or the forecast object is used in stand alone mode.

Property `Config > general > initfile_sfx`


Type	`string`
Required	No

Description: Initial surfex file for the forecast object. Normally no need to provide unless there are special requirements or the forecast object is used in stand alone mode.

Property `Config > general > namelist`

Title: Namelist


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Namelist settings. Various settings for the forecast namelist that have no other place to go.

Property	Type	Required	Default	Title/Description
nrazts	string	No	-	Reset times for instantaneous fluxes ( e.g. min/max temperature )
radiation_frequency	string	No	-	Time interval for radiation compitations in the model.

Property `Config > general > namelist > nrazts`


Type	`string`
Required	No

Description: Reset times for instantaneous fluxes ( e.g. min/max temperature )

Property `Config > general > namelist > radiation_frequency`


Type	`string`
Required	No

Description: Time interval for radiation compitations in the model.

Property `Config > general > output_settings`

Title: Output Settings


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Output settings. Specified as duration for any of interval, endtime:interval, starttime:endtime:interval or a list of these options

Property	Type	Required	Default	Title/Description
history	Combination	No	-	-
surfex	Combination	No	-	-
fullpos	Combination	No	-	-

Property `Config > general > output_settings > history`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1
item 2

Property `Config > general > output_settings > history > anyOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > general > output_settings > history > anyOf > item 1`


Type	`string`
Required	No
Format	`duration`

Property `Config > general > output_settings > history > anyOf > item 2`


Type	`array`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 2 items	-

Config > general > output_settings > history > anyOf > item 2 > item 2 items


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0

Property `Config > general > output_settings > history > anyOf > item 2 > item 2 items > anyOf > item 0`


Type	`string`
Required	No
Format	`duration_slice`

Property `Config > general > output_settings > surfex`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1
item 2

Property `Config > general > output_settings > surfex > anyOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > general > output_settings > surfex > anyOf > item 1`


Type	`string`
Required	No
Format	`duration`

Property `Config > general > output_settings > surfex > anyOf > item 2`


Type	`array`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 2 items	-

Config > general > output_settings > surfex > anyOf > item 2 > item 2 items


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0

Property `Config > general > output_settings > surfex > anyOf > item 2 > item 2 items > anyOf > item 0`


Type	`string`
Required	No
Format	`duration_slice`

Property `Config > general > output_settings > fullpos`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1
item 2

Property `Config > general > output_settings > fullpos > anyOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > general > output_settings > fullpos > anyOf > item 1`


Type	`string`
Required	No
Format	`duration`

Property `Config > general > output_settings > fullpos > anyOf > item 2`


Type	`array`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 2 items	-

Config > general > output_settings > fullpos > anyOf > item 2 > item 2 items


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0

Property `Config > general > output_settings > fullpos > anyOf > item 2 > item 2 items > anyOf > item 0`


Type	`string`
Required	No
Format	`duration_slice`

Property `Config > general > remove_sections`


Type	`array`
Required	No
Default	`[]`

Description: Sections to remove prior to config merge

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	N/A

Property `Config > general > windfarm`


Type	`boolean`
Required	No
Default	`false`

Description: Switch on wind farm parameterisation

Property `Config > suite_control`

Title: Suite control


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Suite control options

Property	Type	Required	Default	Title/Description
suite_definition	string	No	“DeodeSuiteDefinition”	Suite definition to play in EcFlow
do_soil	boolean	No	-	Activate preparation of SOILGRID data as input for PGD
do_pgd	boolean	No	-	Activate generation of a PGD file
mode	enum (of string)	No	-	Choose a strategy to achieve initial/initial_sfx files (start: start from interpolated files and then propagate the FG between cycles, restart: start from a previous run and then propagate the FG between cycles, cold_start: always start from interpolated files).
interpolate_boundaries	boolean	No	-	Activates the boundary interpolation
do_marsprep	boolean	No	-	Run marsprep or skip extraction
do_extractsqlite	boolean	No	-	Activates extraction of selected points to SQLite files for verification.
create_static_data	boolean	No	-	Activate the generation of PGD and monthly climate files in the suite
create_time_dependent_suite	boolean	No	-	Activate the time dependent part of the suite
split_mars	boolean	No	false	Do marsprep only for one step before c903
do_cleaning	boolean	No	false	Do file cleaning
n_io_merge	integer	No	1	Number of IOmerge tasks
DeodeCleaningSuiteDefinition	object	No	-	-

Property `Config > suite_control > suite_definition`


Type	`string`
Required	No
Default	`"DeodeSuiteDefinition"`

Description: Suite definition to play in EcFlow

Property `Config > suite_control > do_soil`


Type	`boolean`
Required	No

Description: Activate preparation of SOILGRID data as input for PGD

Property `Config > suite_control > do_pgd`


Type	`boolean`
Required	No

Description: Activate generation of a PGD file

Property `Config > suite_control > mode`


Type	`enum (of string)`
Required	No

Description: Choose a strategy to achieve initial/initial_sfx files (start: start from interpolated files and then propagate the FG between cycles, restart: start from a previous run and then propagate the FG between cycles, cold_start: always start from interpolated files).

Must be one of:

“start”
“restart”
“cold_start”

Property `Config > suite_control > interpolate_boundaries`


Type	`boolean`
Required	No

Description: Activates the boundary interpolation

Property `Config > suite_control > do_marsprep`


Type	`boolean`
Required	No

Description: Run marsprep or skip extraction

Property `Config > suite_control > do_extractsqlite`


Type	`boolean`
Required	No

Description: Activates extraction of selected points to SQLite files for verification.

Property `Config > suite_control > create_static_data`


Type	`boolean`
Required	No

Description: Activate the generation of PGD and monthly climate files in the suite

Property `Config > suite_control > create_time_dependent_suite`


Type	`boolean`
Required	No

Description: Activate the time dependent part of the suite

Property `Config > suite_control > split_mars`


Type	`boolean`
Required	No
Default	`false`

Description: Do marsprep only for one step before c903

Property `Config > suite_control > do_cleaning`


Type	`boolean`
Required	No
Default	`false`

Description: Do file cleaning

Property `Config > suite_control > n_io_merge`


Type	`integer`
Required	No
Default	`1`

Description: Number of IOmerge tasks

Property `Config > suite_control > DeodeCleaningSuiteDefinition`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property	Type	Required	Default	Title/Description
do_clean_scratch_data	boolean	No	true	Activate cleaning the scratch data
do_clean_suites	boolean	No	true	Activate cleaning the suites
do_clean_IFS	boolean	No	true	Activate cleaning IFS data
days_in_week	array of integer	No	-	List of days when cleaning suite will run, 0-6 Sunday-Saturday
time_to_run	string	No	-	Time to run

Property `Config > suite_control > DeodeCleaningSuiteDefinition > do_clean_scratch_data`


Type	`boolean`
Required	No
Default	`true`

Description: Activate cleaning the scratch data

Property `Config > suite_control > DeodeCleaningSuiteDefinition > do_clean_suites`


Type	`boolean`
Required	No
Default	`true`

Description: Activate cleaning the suites

Property `Config > suite_control > DeodeCleaningSuiteDefinition > do_clean_IFS`


Type	`boolean`
Required	No
Default	`true`

Description: Activate cleaning IFS data

Property `Config > suite_control > DeodeCleaningSuiteDefinition > days_in_week`


Type	`array of integer`
Required	No

Description: List of days when cleaning suite will run, 0-6 Sunday-Saturday

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
days_in_week items	-

Config > suite_control > DeodeCleaningSuiteDefinition > days_in_week > days_in_week items


Type	`integer`
Required	No

Property `Config > suite_control > DeodeCleaningSuiteDefinition > time_to_run`


Type	`string`
Required	No

Description: Time to run

Restrictions
Must match regular expression	`^([01]\d\|2[0-3]):[0-5]\d:[0-5]\dZ$` Test

Property `Config > clean_old_data`

Title: Cleaning old data


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property	Type	Required	Default	Title/Description
scratch_data_period	string	No	“P14D”	Age for old data in days
suites_period	string	No	“P14D”	Age for old data in days
IFS_period	string	No	“P7D”	Age for old data in days
ignore	array	No	[]	-
suite_format	string	No	“/”	-
scratch_format	string	No	“/”	-
ifs_format	string	No	“/IFS/(\d{4})/(0[1-9]	1[0-2])/(0[1-9]
scratch_ext	string	No	“deode”	-

Property `Config > clean_old_data > scratch_data_period`


Type	`string`
Required	No
Default	`"P14D"`

Description: Age for old data in days

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?$` Test

Property `Config > clean_old_data > suites_period`


Type	`string`
Required	No
Default	`"P14D"`

Description: Age for old data in days

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?$` Test

Property `Config > clean_old_data > IFS_period`


Type	`string`
Required	No
Default	`"P7D"`

Description: Age for old data in days

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?$` Test

Property `Config > clean_old_data > ignore`


Type	`array`
Required	No
Default	`[]`

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	N/A

Property `Config > clean_old_data > suite_format`


Type	`string`
Required	No
Default	`"/"`

Property `Config > clean_old_data > scratch_format`


Type	`string`
Required	No
Default	`"/"`

Property `Config > clean_old_data > ifs_format`


Type	`string`
Required	No
Default	`”/IFS/(\d{4})/(0[1-9]

Property `Config > clean_old_data > scratch_ext`


Type	`string`
Required	No
Default	`"deode"`

Property `Config > system`

Title: System


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: DEODE system specific path settings

Property	Type	Required	Default	Title/Description
bdfile_sfx_template	string	No	-	Name template for input initial surfex file for prep
bdfile_template	string	No	-	Name template for input boundary files
bddir_sfx	string	No	-	Location of input intial file for surfex
bddir	string	No	-	Location of input boundaries
intp_bddir	string	No	“@WRK@”	Location of boundaries on the current domain, i.e. the output directory of e927
climdir	string	No	-	Location of generated/used climate files (PGD/monthly files)
bindir	string	No	-	Location of binaries
bdclimdir	string	No	-	Location of host model climate files used for e927/c903
wrk	string	No	“@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@/”	Location of date specific working directory
fullpos_config_file	string	No	-	Path to the fullpos yml config file
archive_timestamp	string	No	“@YYYY@/@MM@/@DD@/@HH@/”	Relative path of date specific archive
archive	string	No	“@ARCHIVE_ROOT@/@ARCHIVE_TIMESTAMP@”	Absolute path of date specific archive
logs	string	No	-	Location of collected logfiles
namelists	string	No	“@DEODE_HOME@/data/namelists/@CYCLE@”	Path to static namelists
marsdir	string	No	-	Location input files extracted from MARS by Marsprep
global_sfcdir	string	No	-	Path to SFC files needed for c903, which are not in MARS
prev_case	string	No	“@CASE@”	Name of the previous experiment
sfx_input_definition	string	No	“@CYCLE@/sfx.json”	Path to the surfex json config file
forecast_input_definition	string	No	“@CYCLE@/forecast.json”	Path to the forecast json config file
c903_input_definition	string	No	“@CYCLE@/c903.json”	Path to the c903 json config file

Property `Config > system > bdfile_sfx_template`


Type	`string`
Required	No

Description: Name template for input initial surfex file for prep

Property `Config > system > bdfile_template`


Type	`string`
Required	No

Description: Name template for input boundary files

Property `Config > system > bddir_sfx`


Type	`string`
Required	No

Description: Location of input intial file for surfex

Property `Config > system > bddir`


Type	`string`
Required	No

Description: Location of input boundaries

Property `Config > system > intp_bddir`


Type	`string`
Required	No
Default	`"@WRK@"`

Description: Location of boundaries on the current domain, i.e. the output directory of e927

Property `Config > system > climdir`


Type	`string`
Required	No

Description: Location of generated/used climate files (PGD/monthly files)

Property `Config > system > bindir`


Type	`string`
Required	No

Description: Location of binaries

Property `Config > system > bdclimdir`


Type	`string`
Required	No

Description: Location of host model climate files used for e927/c903

Property `Config > system > wrk`


Type	`string`
Required	No
Default	`"@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@/"`

Description: Location of date specific working directory

Property `Config > system > fullpos_config_file`


Type	`string`
Required	No

Description: Path to the fullpos yml config file

Property `Config > system > archive_timestamp`


Type	`string`
Required	No
Default	`"@YYYY@/@MM@/@DD@/@HH@/"`

Description: Relative path of date specific archive

Property `Config > system > archive`


Type	`string`
Required	No
Default	`"@ARCHIVE_ROOT@/@ARCHIVE_TIMESTAMP@"`

Description: Absolute path of date specific archive

Property `Config > system > logs`


Type	`string`
Required	No

Description: Location of collected logfiles

Property `Config > system > namelists`


Type	`string`
Required	No
Default	`"@DEODE_HOME@/data/namelists/@CYCLE@"`

Description: Path to static namelists

Property `Config > system > marsdir`


Type	`string`
Required	No

Description: Location input files extracted from MARS by Marsprep

Property `Config > system > global_sfcdir`


Type	`string`
Required	No

Description: Path to SFC files needed for c903, which are not in MARS

Property `Config > system > prev_case`


Type	`string`
Required	No
Default	`"@CASE@"`

Description: Name of the previous experiment

Property `Config > system > sfx_input_definition`


Type	`string`
Required	No
Default	`"@CYCLE@/sfx.json"`

Description: Path to the surfex json config file

Property `Config > system > forecast_input_definition`


Type	`string`
Required	No
Default	`"@CYCLE@/forecast.json"`

Description: Path to the forecast json config file

Property `Config > system > c903_input_definition`


Type	`string`
Required	No
Default	`"@CYCLE@/c903.json"`

Description: Path to the c903 json config file

Property `Config > boundaries`

Title: Boundary Section


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Settings for control of boundary treatment.

Property	Type	Required	Default	Title/Description
bdint	string	No	-	Boundary interval
bdshift	string	No	-	Shift of boundary initial time. E.g. ‘PT3H’ would mean use 3H old boundaries
max_interpolation_tasks	number	No	-	Number of interpolate tasks run in parallel
bdmodel	enum (of string)	No	-	Coupling model
humi_gp	boolean	No	-	Value of TFP_Q%LLGP in domain namelist for c903. True for gridpoint humidity.
ifs.selection	enum (of string)	No	-	Selection
ifs.bdmember	string	No	-	The number of members in ensemble if selection is IFSENS, else empty string.
bd_has_surfex	boolean	No	-	Set to true if the host model runs with surfex

Property `Config > boundaries > bdint`


Type	`string`
Required	No
Format	`duration`

Description: Boundary interval

Property `Config > boundaries > bdshift`


Type	`string`
Required	No
Format	`duration`

Description: Shift of boundary initial time. E.g. ‘PT3H’ would mean use 3H old boundaries

Property `Config > boundaries > max_interpolation_tasks`


Type	`number`
Required	No

Description: Number of interpolate tasks run in parallel

Property `Config > boundaries > bdmodel`


Type	`enum (of string)`
Required	No

Description: Coupling model

Must be one of:

“ALARO”
“AROME”
“IFS”

Property `Config > boundaries > humi_gp`


Type	`boolean`
Required	No

Description: Value of TFP_Q%LLGP in domain namelist for c903. True for gridpoint humidity.

Property `Config > boundaries > ifs.selection`


Type	`enum (of string)`
Required	No

Description: Selection

Must be one of:

“HRES”
“ATOS_DT”
“DT12”
“i5qp”
“i7u4”
“i7ye”
“i8hy”
“IFSENS”

Property `Config > boundaries > ifs.bdmember`


Type	`string`
Required	No

Description: The number of members in ensemble if selection is IFSENS, else empty string.

Property `Config > boundaries > bd_has_surfex`


Type	`boolean`
Required	No

Description: Set to true if the host model runs with surfex

Property `Config > pgd`

Title: Pgd Section


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Settings for control of Pgd selection.

Property	Type	Required	Default	Title/Description
npatch	integer	No	3	Number of patches for surfex variables
one_decade	boolean	No	true	Option for using one decade
use_osm	boolean	No	false	Option to use Open Street map input data

Property `Config > pgd > npatch`

Title: Number of patches for surfex variables


Type	`integer`
Required	No
Default	`3`

Property `Config > pgd > one_decade`

Title: Option for using one decade


Type	`boolean`
Required	No
Default	`true`

Property `Config > pgd > use_osm`

Title: Option to use Open Street map input data


Type	`boolean`
Required	No
Default	`false`

Property `Config > fullpos`

Title: Fullpos Section


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Settings for control of fullpos selection.

Property	Type	Required	Default	Title/Description
config_path	string	No	“@DEODE_HOME@/data/namelist_generation_input/@CYCLE@/fullpos”	Path to fullpos config files
main	array of string	No	[“rules”, “namfpc_header”]	List of mandatory rules
selection	object	No	-	List of selections to include
domain_name	string	No	“DOMAIN”	Name of your domain as used by fullpos

Property `Config > fullpos > config_path`

Title: Path to fullpos config files


Type	`string`
Required	No
Default	`"@DEODE_HOME@/data/namelist_generation_input/@CYCLE@/fullpos"`

Property `Config > fullpos > main`


Type	`array of string`
Required	No
Default	`["rules", "namfpc_header"]`

Description: List of mandatory rules

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
main items	-

Config > fullpos > main > main items


Type	`string`
Required	No

Property `Config > fullpos > selection`


Type	`object`
Required	No
Additional properties	[Should-conform]

Description: List of selections to include

Property `Config > fullpos > selection > additionalProperties`


Type	`array of string`
Required	No

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
additionalProperties items	-

Config > fullpos > selection > additionalProperties > additionalProperties items


Type	`string`
Required	No

Property `Config > fullpos > domain_name`


Type	`string`
Required	No
Default	`"DOMAIN"`

Description: Name of your domain as used by fullpos

Restrictions
Max length	20

Property `Config > troika`

Title: Troika


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: DEODE system specific path settings

Property	Type	Required	Default	Title/Description
config_file	string	No	“@DEODE_HOME@/data/config_files/troika.yml”	Troika config file
troika	string	No	“troika”	Troika command, allows to specify troika with full path

Property `Config > troika > config_file`


Type	`string`
Required	No
Default	`"@DEODE_HOME@/data/config_files/troika.yml"`

Description: Troika config file

Property `Config > troika > troika`


Type	`string`
Required	No
Default	`"troika"`

Description: Troika command, allows to specify troika with full path

Property `Config > include`

Title: Include Section


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sections to be included from other config files. Specified as ‘key = val’ pairs, where the keys are the section names and the vals are the paths to the files containing them.

Property `Config > gribmodify`

Title: Section for modify grib


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Rules for modify grib to get total prcipitation

Property	Type	Required	Default	Title/Description
3	object	No	-	Total precpipation
2	object	No	-	Total snow
1	object	No	-	Total rain

Property `Config > gribmodify > 3`

Title: Total precpipation


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: shortName for the total precipitation.

Property	Type	Required	Default	Title/Description
input	array of string	No	-	Input parameters
operator	string	No	-	Operator
output	string	No	-	Output parameter

Property `Config > gribmodify > 3 > input`

Title: Input parameters


Type	`array of string`
Required	No

Description: List of parameters

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
input items	-

Config > gribmodify > 3 > input > input items


Type	`string`
Required	No

Property `Config > gribmodify > 3 > operator`

Title: Operator


Type	`string`
Required	No

Description: Operator for compute the new field from input parameters

Property `Config > gribmodify > 3 > output`

Title: Output parameter


Type	`string`
Required	No

Description: shortName of output parameter.

Property `Config > gribmodify > 2`

Title: Total snow


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: shortName for the total precipitation.

Property	Type	Required	Default	Title/Description
input	array of string	No	-	Input parameters
operator	string	No	-	Operator
output	string	No	-	Output parameter

Property `Config > gribmodify > 2 > input`

Title: Input parameters


Type	`array of string`
Required	No

Description: List of parameters

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
input items	-

Config > gribmodify > 2 > input > input items


Type	`string`
Required	No

Property `Config > gribmodify > 2 > operator`

Title: Operator


Type	`string`
Required	No

Description: Operator for compute the new field from input parameters

Property `Config > gribmodify > 2 > output`

Title: Output parameter


Type	`string`
Required	No

Description: shortName of output parameter.

Property `Config > gribmodify > 1`

Title: Total rain


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: shortName for the total precipitation.

Property	Type	Required	Default	Title/Description
input	array of string	No	-	Input parameters
operator	string	No	-	Operator
output	string	No	-	Output parameter

Property `Config > gribmodify > 1 > input`

Title: Input parameters


Type	`array of string`
Required	No

Description: List of parameters

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
input items	-

Config > gribmodify > 1 > input > input items


Type	`string`
Required	No

Property `Config > gribmodify > 1 > operator`

Title: Operator


Type	`string`
Required	No

Description: Operator for compute the new field from input parameters

Property `Config > gribmodify > 1 > output`

Title: Output parameter


Type	`string`
Required	No

Description: shortName of output parameter.

Property `Config > archiving`

Title: Archiving Section, defined in include/archiving.toml


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Archiving settings for ATOS to ECFS. Locations, and time intervals to archive for each file type

Property	Type	Required	Default	Title/Description
prefix	object	No	-	Path prefixes

Property `Config > archiving > prefix`

Title: Path prefixes


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Prefix to prepend paths. Like ‘ec:/user/ for ecfs on atos or ‘user@host:’ for scp

Property	Type	Required	Default	Title/Description
archive_type	string	No	-	Prefix to use for available archive types. Define one per type where applicable.

Property `Config > archiving > prefix > archive_type`


Type	`string`
Required	No

Description: Prefix to use for available archive types. Define one per type where applicable.

Property `Config > cleaning`

Title: CleaningSection


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Model for validation of the cleaning configuration.

Property	Type	Required	Default	Title/Description
defaults	Combination	Yes	-	-
Cleaning_example	object	No	-	-

Property `Config > cleaning > defaults`


Type	`combining`
Required	Yes
Additional properties	[Any type: allowed]

Property	Type	Required	Default	Title/Description
include	string	No	-	regular experssion according to it which files to clean
ncycles_delay	number	No	-	number of cycle_length periods with which the cleaning is shifted to the experiment start day to the past.
cleaning_delay	string	No	-	time period with which the cleaning is shifted to the experiment start day to the past. Should be a multiple of general.times.cycle_length.
cleaning_max_delay	string	No	-	time period which defines the cleaning according to the cleaning_delay to the past. Should be a multiple of general.times.cycle_length.
step	string	No	-	time step which determines moments when to make a cleaning, should be a multiple of general.times.cycle_length.
active	boolean	No	-	Activate cleaning files
dry_run	boolean	No	-	test cleaning without to delete files

One of(Option)
item 0
item 1

Property `Config > cleaning > defaults > oneOf > item 0`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

include
ncycles_delay
active

Property `Config > cleaning > defaults > oneOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

The following properties are required

include
cleaning_delay
cleaning_max_delay
active

Property `Config > cleaning > defaults > include`


Type	`string`
Required	No

Description: regular experssion according to it which files to clean

Property `Config > cleaning > defaults > ncycles_delay`


Type	`number`
Required	No

Description: number of cycle_length periods with which the cleaning is shifted to the experiment start day to the past.

Property `Config > cleaning > defaults > cleaning_delay`


Type	`string`
Required	No
Format	`duration`

Description: time period with which the cleaning is shifted to the experiment start day to the past. Should be a multiple of general.times.cycle_length.

Property `Config > cleaning > defaults > cleaning_max_delay`


Type	`string`
Required	No
Format	`duration`

Description: time period which defines the cleaning according to the cleaning_delay to the past. Should be a multiple of general.times.cycle_length.

Property `Config > cleaning > defaults > step`


Type	`string`
Required	No
Format	`duration`

Description: time step which determines moments when to make a cleaning, should be a multiple of general.times.cycle_length.

Property `Config > cleaning > defaults > active`


Type	`boolean`
Required	No

Description: Activate cleaning files

Property `Config > cleaning > defaults > dry_run`


Type	`boolean`
Required	No

Description: test cleaning without to delete files

Property `Config > cleaning > Cleaning_example`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property	Type	Required	Default	Title/Description
path	string	Yes	-	path to the folder where files will be cleaned
include	string	No	“(.*)”	regular expression for files to select for cleaning
exclude	string	No	-	regular expression for files to explicitly exclude from cleaning
ncycles_delay	number	No	-	number of cycle_length periods with which the cleaning is shifted to the experiment start day to the past.
cleaning_delay	string	No	-	time period with which the cleaning is shifted to the experiment start day to the past. Should be a multiple of general.times.cycle_length.
cleaning_max_delay	string	No	-	time period which defines the cleaning according to the cleaning_delay to the past. Should be a multiple of general.times.cycle_length.
step	string	No	-	time step which determines moments when to make a cleaning, should be a multiple of general.times.cycle_length.
active	boolean	No	-	Activate cleaning files
dry_run	boolean	No	-	test cleaning without to delete files

Property `Config > cleaning > Cleaning_example > path`


Type	`string`
Required	Yes

Description: path to the folder where files will be cleaned

Property `Config > cleaning > Cleaning_example > include`


Type	`string`
Required	No
Default	`"(.*)"`

Description: regular expression for files to select for cleaning

Property `Config > cleaning > Cleaning_example > exclude`


Type	`string`
Required	No

Description: regular expression for files to explicitly exclude from cleaning

Property `Config > cleaning > Cleaning_example > ncycles_delay`


Type	`number`
Required	No

Description: number of cycle_length periods with which the cleaning is shifted to the experiment start day to the past.

Property `Config > cleaning > Cleaning_example > cleaning_delay`


Type	`string`
Required	No
Format	`duration`

Description: time period with which the cleaning is shifted to the experiment start day to the past. Should be a multiple of general.times.cycle_length.

Property `Config > cleaning > Cleaning_example > cleaning_max_delay`


Type	`string`
Required	No
Format	`duration`

Description: time period which defines the cleaning according to the cleaning_delay to the past. Should be a multiple of general.times.cycle_length.

Property `Config > cleaning > Cleaning_example > step`


Type	`string`
Required	No
Format	`duration`

Description: time step which determines moments when to make a cleaning, should be a multiple of general.times.cycle_length.

Property `Config > cleaning > Cleaning_example > active`


Type	`boolean`
Required	No

Description: Activate cleaning files

Property `Config > cleaning > Cleaning_example > dry_run`


Type	`boolean`
Required	No

Description: test cleaning without to delete files

Property `Config > domain`

Title: Domain Section, defined in files under include/domains


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Model for validation of the data in the ‘domain’ section of the config file.

Property	Type	Required	Default	Title/Description
gridtype	enum (of string)	No	-	Select truncation type
gridtype_oro	enum (of string)	No	“”	Select truncation type for orographic_smoothing
orographic_smoothing_method	enum (of string)	No	“truncation”	Orographic smoothing method
name	string	No	-	Name of your domain
number	Combination	No	“”	Sequence number for domain
nimax	number	No	-	Number of grid points zonally
njmax	number	No	-	Number of grid points meridionally
xdx	number	No	-	Zonal grid size in meters
xdy	number	No	-	Meridional grid size in meters
ilone	number	No	11	Zonal extension zone
ilate	number	No	11	Meridional extension zone
nbzong	number	No	-1	Meridional coupling zone width
nbzonl	number	No	-1	Zonal coupling zone width
tstep	number	No	-	Model time step in seconds
xloncen	number	No	-	Domain center longitude
xlatcen	number	No	-	Domain center latitude
xlon0	Combination	No	“”	Longitude of center of projection
xlat0	Combination	No	“”	Latitude of center of projection
xbeta	number	No	0.0	Rotation parameter for the conformal projection
spectral_smoothing_by_gridtype	object	No	{“linear”: true, “quadratic”: false, “cubic”: false, “custom”: true}	Defines for which gridypes spectral smoothing is applied when activated
truncation_by_gridtype	object	No	{“linear”: “quadratic”, “quadratic”: “quadratic”, “cubic”: “cubic”, “custom”: “custom”}	Defines default gridtype_oro mapping when truncation smoothing is applied.

Property `Config > domain > gridtype`


Type	`enum (of string)`
Required	No

Description: Select truncation type

Must be one of:

“linear”
“quadratic”
“cubic”
“custom”

Property `Config > domain > gridtype_oro`


Type	`enum (of string)`
Required	No
Default	`""`

Description: Select truncation type for orographic_smoothing

Must be one of:

“linear”
“quadratic”
“cubic”
“custom”
“”

Property `Config > domain > orographic_smoothing_method`


Type	`enum (of string)`
Required	No
Default	`"truncation"`

Description: Orographic smoothing method

Must be one of:

“spectral”
“truncation”

Property `Config > domain > name`


Type	`string`
Required	No

Description: Name of your domain

Property `Config > domain > number`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]
Default	`""`

Description: Sequence number for domain

One of(Option)
item 0
item 1

Property `Config > domain > number > oneOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > domain > number > oneOf > item 1`


Type	`number`
Required	No

Restrictions
Minimum	≥ 0

Property `Config > domain > nimax`


Type	`number`
Required	No

Description: Number of grid points zonally

Restrictions
Minimum	≥ 0

Property `Config > domain > njmax`


Type	`number`
Required	No

Description: Number of grid points meridionally

Restrictions
Minimum	≥ 0

Property `Config > domain > xdx`


Type	`number`
Required	No

Description: Zonal grid size in meters

Restrictions
Minimum	≥ 0

Property `Config > domain > xdy`


Type	`number`
Required	No

Description: Meridional grid size in meters

Restrictions
Minimum	≥ 0

Property `Config > domain > ilone`


Type	`number`
Required	No
Default	`11`

Description: Zonal extension zone

Restrictions
Minimum	≥ 0

Property `Config > domain > ilate`


Type	`number`
Required	No
Default	`11`

Description: Meridional extension zone

Restrictions
Minimum	≥ 0

Property `Config > domain > nbzong`


Type	`number`
Required	No
Default	`-1`

Description: Meridional coupling zone width

Restrictions
Minimum	≥ -1

Property `Config > domain > nbzonl`


Type	`number`
Required	No
Default	`-1`

Description: Zonal coupling zone width

Restrictions
Minimum	≥ -1

Property `Config > domain > tstep`


Type	`number`
Required	No

Description: Model time step in seconds

Property `Config > domain > xloncen`


Type	`number`
Required	No

Description: Domain center longitude

Restrictions
Minimum	≥ -180
Maximum	≤ 180

Property `Config > domain > xlatcen`


Type	`number`
Required	No

Description: Domain center latitude

Restrictions
Minimum	≥ -90
Maximum	≤ 90

Property `Config > domain > xlon0`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]
Default	`""`

Description: Longitude of center of projection

One of(Option)
item 0
item 1

Property `Config > domain > xlon0 > oneOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > domain > xlon0 > oneOf > item 1`


Type	`number`
Required	No

Restrictions
Minimum	≥ -180
Maximum	≤ 180

Property `Config > domain > xlat0`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]
Default	`""`

Description: Latitude of center of projection

One of(Option)
item 0
item 1

Property `Config > domain > xlat0 > oneOf > item 0`


Type	`string`
Required	No

Restrictions
Max length	0

Property `Config > domain > xlat0 > oneOf > item 1`


Type	`number`
Required	No

Restrictions
Minimum	≥ -90
Maximum	≤ 90

Property `Config > domain > xbeta`


Type	`number`
Required	No
Default	`0.0`

Description: Rotation parameter for the conformal projection

Property `Config > domain > spectral_smoothing_by_gridtype`


Type	`object`
Required	No
Additional properties	[Any type: allowed]
Default	`{"linear": true, "quadratic": false, "cubic": false, "custom": true}`

Description: Defines for which gridypes spectral smoothing is applied when activated

Property `Config > domain > truncation_by_gridtype`


Type	`object`
Required	No
Additional properties	[Any type: allowed]
Default	`{"linear": "quadratic", "quadratic": "quadratic", "cubic": "cubic", "custom": "custom"}`

Description: Defines default gridtype_oro mapping when truncation smoothing is applied.

Property `Config > extractsqlite`

Title: Extract sqlite Section, defined in include/sqlite.toml


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Model for validation of the data in the ‘sqlite’ section of the config file.

Property	Type	Required	Default	Title/Description
parameter_list	string	No	“@DEODE_HOME@/data/sqlite/param_list_@CSC@.json”	List of parameters to extract
sqlite_model_name	string	No	“@CASE@”	Model name used in the sqlite tables
sqlite_path	string	No	“@ARCHIVE_ROOT@/sqlite/”	Path to generated sqlite files
sqlite_template	string	No	“FCTABLE/{MODEL}/{YYYY}/{MM}/FCTABLE_{PP}{YYYY}{MM}{HH}.sqlite”	File name template for generated sqlite files
station_list	string	No	“@DEODE_HOME@/data/sqlite/station_list_default.csv”	Station list used for extraction
selection	string	No	“PT1H”	Temporal selection. Same syntax as for output_settings. Leave empty to inherit the fullpos settings.

Property `Config > extractsqlite > parameter_list`


Type	`string`
Required	No
Default	`"@DEODE_HOME@/data/sqlite/param_list_@CSC@.json"`

Description: List of parameters to extract

Property `Config > extractsqlite > sqlite_model_name`


Type	`string`
Required	No
Default	`"@CASE@"`

Description: Model name used in the sqlite tables

Property `Config > extractsqlite > sqlite_path`


Type	`string`
Required	No
Default	`"@ARCHIVE_ROOT@/sqlite/"`

Description: Path to generated sqlite files

Property `Config > extractsqlite > sqlite_template`


Type	`string`
Required	No
Default	`"FCTABLE/{MODEL}/{YYYY}/{MM}/FCTABLE_{PP}_{YYYY}{MM}_{HH}.sqlite"`

Description: File name template for generated sqlite files

Property `Config > extractsqlite > station_list`


Type	`string`
Required	No
Default	`"@DEODE_HOME@/data/sqlite/station_list_default.csv"`

Description: Station list used for extraction

Property `Config > extractsqlite > selection`


Type	`string`
Required	No
Default	`"PT1H"`

Description: Temporal selection. Same syntax as for output_settings. Leave empty to inherit the fullpos settings.

Property `Config > file_templates`

Title: File Templates, defined in include/file_templates.toml


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Templates for file names. Each item contains of an archive and a model key where archive is the name template for files in the archive and model the name expected as input/output of the IAL code.

Property	Type	Required	Default	Title/Description
duration	object	No	-	Duration
fullpos	object	No	-	Fullpos
history	object	No	-	History
pgd	object	No	-	PGD
pgd_prel	object	No	-	Preliminary PGD
pgd_host	object	No	-	Host PGD
surfex	object	No	-	Surfex

Property `Config > file_templates > duration`

Title: Duration


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Time stamp templates for output files

Property	Type	Required	Default	Title/Description
archive	string	No	“@LLLH@h@LM@m@LS@s”	File template as stored in the archive
model	string	No	“@LLLH@:@LM@:@LS@”	File template as used by the model

Property `Config > file_templates > duration > archive`


Type	`string`
Required	No
Default	`"@LLLH@h@LM@m@LS@s"`

Description: File template as stored in the archive

Property `Config > file_templates > duration > model`


Type	`string`
Required	No
Default	`"@LLLH@:@LM@:@LS@"`

Description: File template as used by the model

Property `Config > file_templates > fullpos`

Title: Fullpos


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: File name templates for fullpos files

Property	Type	Required	Default	Title/Description
archive	string	No	“GRIBPF@CNMEXP@@DOMAIN@+@DURATION_ARCHIVE@”	File template as stored in the archive
model	string	No	“GRIBPF@CNMEXP@@DOMAIN@+@DURATION_MODEL@”	File template as used by the model

Property `Config > file_templates > fullpos > archive`


Type	`string`
Required	No
Default	`"GRIBPF@CNMEXP@@DOMAIN@+@DURATION_ARCHIVE@"`

Description: File template as stored in the archive

Property `Config > file_templates > fullpos > model`


Type	`string`
Required	No
Default	`"GRIBPF@CNMEXP@@DOMAIN@+@DURATION_MODEL@"`

Description: File template as used by the model

Property `Config > file_templates > history`

Title: History


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: File name templates for history files

Property	Type	Required	Default	Title/Description
archive	string	No	“ICMSH@CNMEXP@+@DURATION_ARCHIVE@”	File template as stored in the archive
model	string	No	“ICMSH@CNMEXP@+@DURATION_MODEL@”	File template as used by the model

Property `Config > file_templates > history > archive`


Type	`string`
Required	No
Default	`"ICMSH@CNMEXP@+@DURATION_ARCHIVE@"`

Description: File template as stored in the archive

Property `Config > file_templates > history > model`


Type	`string`
Required	No
Default	`"ICMSH@CNMEXP@+@DURATION_MODEL@"`

Description: File template as used by the model

Property `Config > file_templates > pgd`

Title: PGD


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: File name templates for final PGD files

Property	Type	Required	Default	Title/Description
archive	string	No	“Const.Clim@ONE_DECADE@.sfx”	File template as stored in the archive
model	string	No	“Const.Clim.sfx”	File template as used by the model

Property `Config > file_templates > pgd > archive`


Type	`string`
Required	No
Default	`"Const.Clim@ONE_DECADE@.sfx"`

Description: File template as stored in the archive

Property `Config > file_templates > pgd > model`


Type	`string`
Required	No
Default	`"Const.Clim.sfx"`

Description: File template as used by the model

Property `Config > file_templates > pgd_prel`

Title: Preliminary PGD


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: File name templates for the preliminary PGD files

Property	Type	Required	Default	Title/Description
archive	string	No	“PGD_prel@ONE_DECADE@.fa”	File template as stored in the archive
model	string	No	“PGD_prel.fa”	File template as used by the model

Property `Config > file_templates > pgd_prel > archive`


Type	`string`
Required	No
Default	`"PGD_prel@ONE_DECADE@.fa"`

Description: File template as stored in the archive

Property `Config > file_templates > pgd_prel > model`


Type	`string`
Required	No
Default	`"PGD_prel.fa"`

Description: File template as used by the model

Property `Config > file_templates > pgd_host`

Title: Host PGD


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: File name templates for potential PGD files from the host model. Used if host_surfex=true

Property	Type	Required	Default	Title/Description
archive	string	No	“Const.Clim@ONE_DECADE@.sfx”	File template as stored in the archive
model	string	No	“Const.Clim.sfx”	File template as used by the model

Property `Config > file_templates > pgd_host > archive`


Type	`string`
Required	No
Default	`"Const.Clim@ONE_DECADE@.sfx"`

Description: File template as stored in the archive

Property `Config > file_templates > pgd_host > model`


Type	`string`
Required	No
Default	`"Const.Clim.sfx"`

Description: File template as used by the model

Property `Config > file_templates > surfex`

Title: Surfex


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: File name templates for surfex output files

Property	Type	Required	Default	Title/Description
archive	string	No	“ICMSH@CNMEXP@+@DURATION_ARCHIVE@.sfx”	File template as stored in the archive
model	string	No	“ICMSH@CNMEXP@+@DURATION_MODEL@.sfx”	File template as used by the model

Property `Config > file_templates > surfex > archive`


Type	`string`
Required	No
Default	`"ICMSH@CNMEXP@+@DURATION_ARCHIVE@.sfx"`

Description: File template as stored in the archive

Property `Config > file_templates > surfex > model`


Type	`string`
Required	No
Default	`"ICMSH@CNMEXP@+@DURATION_MODEL@.sfx"`

Description: File template as used by the model

Property `Config > impact`

Title: Impact model settings


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines settings for arbitrary impact models

Property	Type	Required	Default	Title/Description
ehype	object	No	-	Settings for EHYPE

Property `Config > impact > ehype`

Title: Settings for EHYPE


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property	Type	Required	Default	Title/Description
active	boolean	No	“false”	Activates this impact model
arguments	string	No	-	Arguments to send to the impact model start command
config_name	string	No	-	Name of the output config file aimed for the particular impact model
path	string	No	-	Path to the impact model start command. Preferably defined in the platform section and used as a macro here
task	string	No	-	Which of the dedicated tasks the impact model should be started from. Has to be defined in impact.py
communicate	object	No	-	Impact model specific config settings

Property `Config > impact > ehype > active`


Type	`boolean`
Required	No
Default	`"false"`

Description: Activates this impact model

Property `Config > impact > ehype > arguments`


Type	`string`
Required	No

Description: Arguments to send to the impact model start command

Property `Config > impact > ehype > config_name`


Type	`string`
Required	No

Description: Name of the output config file aimed for the particular impact model

Property `Config > impact > ehype > path`


Type	`string`
Required	No

Description: Path to the impact model start command. Preferably defined in the platform section and used as a macro here

Property `Config > impact > ehype > task`


Type	`string`
Required	No

Description: Which of the dedicated tasks the impact model should be started from. Has to be defined in impact.py

Property `Config > impact > ehype > communicate`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Impact model specific config settings

Property	Type	Required	Default	Title/Description
archive	string	No	-	Location of data
archive_1	string	No	-	Primary location of data (future implementation)
archive_2	string	No	-	Secondary location of data (future implementation)
basetime	Combination	No	-	Initial time
file_pattern	string	No	-	Pattern for input files to search for
output_frequency	Combination	No	-	data availability frequncy in duration syntax
forecast_range	Combination	No	-	Leadtime in duration syntax
name	string	No	-	Name of the generated EHYPE suite
nwp_model	Combination	No	-	CSC name
additionalProperties	object	No	-	-

Property `Config > impact > ehype > communicate > archive`


Type	`string`
Required	No

Description: Location of data

Property `Config > impact > ehype > communicate > archive_1`


Type	`string`
Required	No

Description: Primary location of data (future implementation)

Property `Config > impact > ehype > communicate > archive_2`


Type	`string`
Required	No

Description: Secondary location of data (future implementation)

Property `Config > impact > ehype > communicate > basetime`


Type	`combining`
Required	No

Description: Initial time

One of(Option)
item 0
item 1

Property `Config > impact > ehype > communicate > basetime > oneOf > item 0`


Type	`object`
Required	No
Format	`date-time`
Additional properties	[Any type: allowed]

Property `Config > impact > ehype > communicate > basetime > oneOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Restrictions
Must match regular expression	`^@(.*)@$` Test

Property `Config > impact > ehype > communicate > file_pattern`


Type	`string`
Required	No

Description: Pattern for input files to search for

Property `Config > impact > ehype > communicate > output_frequency`


Type	`combining`
Required	No

Description: data availability frequncy in duration syntax

One of(Option)
item 0
item 1

Property `Config > impact > ehype > communicate > output_frequency > oneOf > item 0`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > impact > ehype > communicate > output_frequency > oneOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Restrictions
Must match regular expression	`^@(.*)@$` Test

Property `Config > impact > ehype > communicate > forecast_range`


Type	`combining`
Required	No

Description: Leadtime in duration syntax

One of(Option)
item 0
item 1

Property `Config > impact > ehype > communicate > forecast_range > oneOf > item 0`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > impact > ehype > communicate > forecast_range > oneOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Restrictions
Must match regular expression	`^@(.*)@$` Test

Property `Config > impact > ehype > communicate > name`


Type	`string`
Required	No

Description: Name of the generated EHYPE suite

Property `Config > impact > ehype > communicate > nwp_model`


Type	`combining`
Required	No

Description: CSC name

One of(Option)
item 0
item 1

Property `Config > impact > ehype > communicate > nwp_model > oneOf > item 0`


Type	`enum (of string)`
Required	No

Must be one of:

“AROME”
“ALARO”
“HARMONIE_AROME”

Property `Config > impact > ehype > communicate > nwp_model > oneOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Restrictions
Must match regular expression	`^@(.*)@$` Test

Property `Config > impact > ehype > communicate > additionalProperties`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > macros`

Title: Macros Section, defined in include/macros.toml


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Model for the ‘macros’ section.

Property	Type	Required	Default	Title/Description
gen_macros	array	No	-	Turns any string config to a macro, use a dict to rename an attribute.
group_macros	array of string	No	-	Turns a full config section to a macro
os_macros	array of string	No	-	Environment variables used as macros
user_macros	object	No	-	User defined macros, intended to use when using the Deode-Workflow as a package

Property `Config > macros > gen_macros`


Type	`array`
Required	No

Description: Turns any string config to a macro, use a dict to rename an attribute.

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
gen_macros items	-

Config > macros > gen_macros > gen_macros items


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1

Property `Config > macros > gen_macros > gen_macros items > anyOf > item 0`


Type	`string`
Required	No

Property `Config > macros > gen_macros > gen_macros items > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > macros > group_macros`


Type	`array of string`
Required	No

Description: Turns a full config section to a macro

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
group_macros items	-

Config > macros > group_macros > group_macros items


Type	`string`
Required	No

Property `Config > macros > os_macros`


Type	`array of string`
Required	No

Description: Environment variables used as macros

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
os_macros items	-

Config > macros > os_macros > os_macros items


Type	`string`
Required	No

Property `Config > macros > user_macros`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: User defined macros, intended to use when using the Deode-Workflow as a package

Property	Type	Required	Default	Title/Description
gen_macros	array	No	-	Turns any string config to a macro, use a dict to rename an attribute.
group_macros	array of string	No	-	Turns a full config section to a macro
ignore	array of string	No	-	Turns a full config section to a macro
os_macros	array of string	No	-	Environment variables used as macros

Property `Config > macros > user_macros > gen_macros`


Type	`array`
Required	No

Description: Turns any string config to a macro, use a dict to rename an attribute.

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
gen_macros items	-

Config > macros > user_macros > gen_macros > gen_macros items


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Any of(Option)
item 0
item 1

Property `Config > macros > user_macros > gen_macros > gen_macros items > anyOf > item 0`


Type	`string`
Required	No

Property `Config > macros > user_macros > gen_macros > gen_macros items > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > macros > user_macros > group_macros`


Type	`array of string`
Required	No

Description: Turns a full config section to a macro

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
group_macros items	-

Config > macros > user_macros > group_macros > group_macros items


Type	`string`
Required	No

Property `Config > macros > user_macros > ignore`


Type	`array of string`
Required	No

Description: Turns a full config section to a macro

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
ignore items	-

Config > macros > user_macros > ignore > ignore items


Type	`string`
Required	No

Property `Config > macros > user_macros > os_macros`


Type	`array of string`
Required	No

Description: Environment variables used as macros

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
os_macros items	-

Config > macros > user_macros > os_macros > os_macros items


Type	`string`
Required	No

Property `Config > mars`

Title: MARS settings, defined in include/mars_settings.toml


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Options for MARS extraction, for RD DT data check here for more details.

Property	Type	Required	Default	Title/Description
HRES	object	No	-	Operational HRES
IFSENS	object	No	-	Operational ensemble forecasts
ATOS_DT	object	No	-	Global DT near real-time runs on ATOS based on CY48r1
atos_bologna_DT	object	No	-	Global DT near real-time runs on ATOS based on CY49r1
DT12	object	No	-	Global DT runs on ATOS but starting at 12Z
i5qp	object	No	-	Paris RDP case Tco2559
i7u4	object	No	-	Paris RDP case Tco3999 with Urban scheme
i7ye	object	No	-	Paris RDP case Tco3999 without Urban scheme
i8hy	object	No	-	AQ winter case over central Europe
lumi_DT	object	No	-	Global DT near real-time runs on LUMI

Property `Config > mars > HRES`

Title: Operational HRES


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for oper data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
class	string	No	-	Class of expver
levelist	object	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	object	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG1	string	No	-	List of constant field parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
GG_soil	string	No	-	Parameters for grid point soil data, for detailed information about the parameters check here
grid_GG1	object	No	-	Grid parameter for mars request of GG1 fields
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	object	No	-	Dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > HRES > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > HRES > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > HRES > levelist`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > HRES > grid`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > HRES > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > HRES > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > HRES > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > HRES > GG1`


Type	`string`
Required	No

Description: List of constant field parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > HRES > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > HRES > GG_soil`


Type	`string`
Required	No

Description: Parameters for grid point soil data, for detailed information about the parameters check here

Property `Config > mars > HRES > grid_GG1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Grid parameter for mars request of GG1 fields

Property `Config > mars > HRES > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > HRES > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > HRES > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > HRES > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > HRES > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > HRES > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > HRES > stream`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > IFSENS`

Title: Operational ensemble forecasts


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for oper data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	object	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars. Note that IFSENS is only stored for a limited amount of time.
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG1	string	No	-	List of constant field parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
GG_soil	string	No	-	Parameters for grid point soil data, for detailed information about the parameters check here
grid_GG1	object	No	-	Grid parameter for mars request of GG1 fields
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
stream	string	No	-	MARS stream

Property `Config > mars > IFSENS > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > IFSENS > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > IFSENS > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > IFSENS > grid`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > IFSENS > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > IFSENS > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars. Note that IFSENS is only stored for a limited amount of time.

Property `Config > mars > IFSENS > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > IFSENS > GG1`


Type	`string`
Required	No

Description: List of constant field parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > IFSENS > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > IFSENS > GG_soil`


Type	`string`
Required	No

Description: Parameters for grid point soil data, for detailed information about the parameters check here

Property `Config > mars > IFSENS > grid_GG1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Grid parameter for mars request of GG1 fields

Property `Config > mars > IFSENS > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > IFSENS > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > IFSENS > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > IFSENS > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > IFSENS > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > IFSENS > stream`


Type	`string`
Required	No

Description: MARS stream

Property `Config > mars > ATOS_DT`

Title: Global DT near real-time runs on ATOS based on CY48r1


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > ATOS_DT > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > ATOS_DT > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > ATOS_DT > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > ATOS_DT > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > ATOS_DT > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > ATOS_DT > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > ATOS_DT > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > ATOS_DT > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > ATOS_DT > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > ATOS_DT > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > ATOS_DT > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > ATOS_DT > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > ATOS_DT > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > ATOS_DT > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > ATOS_DT > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > ATOS_DT > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > ATOS_DT > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > ATOS_DT > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > ATOS_DT > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > atos_bologna_DT`

Title: Global DT near real-time runs on ATOS based on CY49r1


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > atos_bologna_DT > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > atos_bologna_DT > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > atos_bologna_DT > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > atos_bologna_DT > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > atos_bologna_DT > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > atos_bologna_DT > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > atos_bologna_DT > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > atos_bologna_DT > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > atos_bologna_DT > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > atos_bologna_DT > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > atos_bologna_DT > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > atos_bologna_DT > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > atos_bologna_DT > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > atos_bologna_DT > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > atos_bologna_DT > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > atos_bologna_DT > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > atos_bologna_DT > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > atos_bologna_DT > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > atos_bologna_DT > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > DT12`

Title: Global DT runs on ATOS but starting at 12Z


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > DT12 > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > DT12 > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > DT12 > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > DT12 > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > DT12 > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > DT12 > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > DT12 > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > DT12 > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > DT12 > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > DT12 > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > DT12 > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > DT12 > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > DT12 > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > DT12 > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > DT12 > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > DT12 > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > DT12 > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > DT12 > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > DT12 > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > i5qp`

Title: Paris RDP case Tco2559


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > i5qp > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i5qp > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > i5qp > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > i5qp > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > i5qp > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > i5qp > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i5qp > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > i5qp > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > i5qp > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > i5qp > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > i5qp > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > i5qp > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > i5qp > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > i5qp > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > i5qp > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > i5qp > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > i5qp > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > i5qp > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > i5qp > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > i7u4`

Title: Paris RDP case Tco3999 with Urban scheme


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > i7u4 > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i7u4 > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > i7u4 > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > i7u4 > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > i7u4 > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > i7u4 > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i7u4 > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > i7u4 > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > i7u4 > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > i7u4 > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > i7u4 > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > i7u4 > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > i7u4 > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > i7u4 > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > i7u4 > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > i7u4 > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > i7u4 > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > i7u4 > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > i7u4 > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > i7ye`

Title: Paris RDP case Tco3999 without Urban scheme


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > i7ye > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i7ye > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > i7ye > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > i7ye > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > i7ye > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > i7ye > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i7ye > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > i7ye > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > i7ye > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > i7ye > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > i7ye > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > i7ye > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > i7ye > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > i7ye > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > i7ye > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > i7ye > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > i7ye > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > i7ye > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > i7ye > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > i8hy`

Title: AQ winter case over central Europe


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > i8hy > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i8hy > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > i8hy > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > i8hy > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > i8hy > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > i8hy > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > i8hy > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > i8hy > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > i8hy > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > i8hy > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > i8hy > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > i8hy > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > i8hy > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > i8hy > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > i8hy > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > i8hy > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > i8hy > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > i8hy > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > i8hy > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > mars > lumi_DT`

Title: Global DT near real-time runs on LUMI


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Parameters for global DT data

Property	Type	Required	Default	Title/Description
ifs_cycle_start	string	No	“PT0H”	Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0
default	string	No	-	Other section to copy settings from if not given here
class	string	No	-	Class of expver
levelist	string	No	-	Dictionary (date:levels), with dates of change in the number of levels.
grid	string	No	-	Dictionary (date:resolution), with dates of change in the resolution.
ifs_cycle_length	string	No	-	Boundary model cycle interval
start_date	string	No	-	Date from when are data available in Mars
GG	string	No	-	List of parameters for grid point data, for detailed information about the parameters check here
GG_sea	string	No	-	Parameters for grid point sea data, for detailed information about the parameters check here
tco	enum (of string)	No	-	Truncation for static RD data
grid_ML	string	No	-	Grid parameter for mars request of model level fields
SH	string	No	-	Parameters for spectral harmonic data, for detailed information about the parameters check here
SHZ	string	No	-	Geopotential on ground, for detailed information about the parameters check here
UA	string	No	-	Upper air grid point parameters, for detailed information about the parameters check here
SHZ_type	string	No	-	Type for geopotential
GGZ_type	string	No	-	Type for geopotential in gridpoint
stream	Combination	No	-	MARS stream or dictionary (run:stream) to use the right stream for a given run.

Property `Config > mars > lumi_DT > ifs_cycle_start`


Type	`string`
Required	No
Default	`"PT0H"`

Description: Boundary model cycle start hour. Required to be set if bdcycle_start % bdcycle != 0

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > lumi_DT > default`


Type	`string`
Required	No

Description: Other section to copy settings from if not given here

Property `Config > mars > lumi_DT > class`


Type	`string`
Required	No

Description: Class of expver

Property `Config > mars > lumi_DT > levelist`


Type	`string`
Required	No

Description: Dictionary (date:levels), with dates of change in the number of levels.

Property `Config > mars > lumi_DT > grid`


Type	`string`
Required	No

Description: Dictionary (date:resolution), with dates of change in the resolution.

Property `Config > mars > lumi_DT > ifs_cycle_length`


Type	`string`
Required	No

Description: Boundary model cycle interval

Restrictions
Must match regular expression	`^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$` Test

Property `Config > mars > lumi_DT > start_date`


Type	`string`
Required	No
Format	`date-time`

Description: Date from when are data available in Mars

Property `Config > mars > lumi_DT > GG`


Type	`string`
Required	No

Description: List of parameters for grid point data, for detailed information about the parameters check here

Property `Config > mars > lumi_DT > GG_sea`


Type	`string`
Required	No

Description: Parameters for grid point sea data, for detailed information about the parameters check here

Property `Config > mars > lumi_DT > tco`


Type	`enum (of string)`
Required	No

Description: Truncation for static RD data

Must be one of:

“255”
“399”

Property `Config > mars > lumi_DT > grid_ML`


Type	`string`
Required	No

Description: Grid parameter for mars request of model level fields

Property `Config > mars > lumi_DT > SH`


Type	`string`
Required	No

Description: Parameters for spectral harmonic data, for detailed information about the parameters check here

Property `Config > mars > lumi_DT > SHZ`


Type	`string`
Required	No

Description: Geopotential on ground, for detailed information about the parameters check here

Property `Config > mars > lumi_DT > UA`


Type	`string`
Required	No

Description: Upper air grid point parameters, for detailed information about the parameters check here

Property `Config > mars > lumi_DT > SHZ_type`


Type	`string`
Required	No

Description: Type for geopotential

Property `Config > mars > lumi_DT > GGZ_type`


Type	`string`
Required	No

Description: Type for geopotential in gridpoint

Property `Config > mars > lumi_DT > stream`


Type	`combining`
Required	No
Additional properties	[Any type: allowed]

Description: MARS stream or dictionary (run:stream) to use the right stream for a given run.

Any of(Option)
item 0
item 1

Property `Config > mars > lumi_DT > stream > anyOf > item 0`


Type	`string`
Required	No

Property `Config > mars > lumi_DT > stream > anyOf > item 1`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Property `Config > platform`

Title: Platform Section, defined in files under include/platform_paths


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: DEODE platform specific path settings

Property	Type	Required	Default	Title/Description
archive_types	array of enum (of string)	No	[“copy”, “move”, “scp”]	Methods available for archiving
ecoclim_data_path	string	No	-	Path to the ECOCLIMAP-II data
deode_home	string	No	“set-by-the-system”	Path to the deode code, normally no need to change
pgd_data_path	string	No	-	Path to PGD input data
soilgrid_data_path	string	No	-	Path to solgrid input data
gmted2010_data_path	string	No	-	Path to gmted2010 input
ecosg_data_path	string	No	-	Path to ECOCLIMAP SG data
climdata	string	No	-	Macro used in other platform paths
static_data	string	No	-	Macro used in other platform paths
e923_data	string	No	-	Path to e923 input data
ncdir	string	No	-	Path to ECrad NetCDF data
rrtm_dir	string	No	-	Path to RRTM input data
rttov_coefdir	string	No	-	Path to RTTOV_COEF input data
scratch	string	No	-	Path used as macro for e.g. wrk and other directories.
task_name	string	No	-	Placeholder macro.
flake_dir	string	No	-	Path to climate PGD dir.
albnir_soil_dir	string	No	-	Path to near-infrared spectrum soil data.
albnir_veg_dir	string	No	-	Path to near-infrared spectrum vegetation data.
albvis_soil_dir	string	No	-	Path to visible soil spectrum data.
albvis_veg_dir	string	No	-	Path to visible spectrum vegetation data.
lai_dir	string	No	-	TBA
tree_height_dir	string	No	-	Path to tree_height data.
windfarm_path	string	No	-	Path to wind farm parameterisation input data.
archive_root	string	No	-	Path to the main archive directory
unix_group	string	No	“”	Default unix group for directories created by deode, leave empty to use default group of user.

Property `Config > platform > archive_types`


Type	`array of enum (of string)`
Required	No
Default	`["copy", "move", "scp"]`

Description: Methods available for archiving

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
archive_types items	-

Config > platform > archive_types > archive_types items


Type	`enum (of string)`
Required	No

Must be one of:

“ecfs”
“fdb”
“scp”
“copy”
“move”

Property `Config > platform > ecoclim_data_path`


Type	`string`
Required	No

Description: Path to the ECOCLIMAP-II data

Property `Config > platform > deode_home`


Type	`string`
Required	No
Default	`"set-by-the-system"`

Description: Path to the deode code, normally no need to change

Property `Config > platform > pgd_data_path`


Type	`string`
Required	No

Description: Path to PGD input data

Property `Config > platform > soilgrid_data_path`


Type	`string`
Required	No

Description: Path to solgrid input data

Property `Config > platform > gmted2010_data_path`


Type	`string`
Required	No

Description: Path to gmted2010 input

Property `Config > platform > ecosg_data_path`


Type	`string`
Required	No

Description: Path to ECOCLIMAP SG data

Property `Config > platform > climdata`


Type	`string`
Required	No

Description: Macro used in other platform paths

Property `Config > platform > static_data`


Type	`string`
Required	No

Description: Macro used in other platform paths

Property `Config > platform > e923_data`


Type	`string`
Required	No

Description: Path to e923 input data

Property `Config > platform > ncdir`


Type	`string`
Required	No

Description: Path to ECrad NetCDF data

Property `Config > platform > rrtm_dir`


Type	`string`
Required	No

Description: Path to RRTM input data

Property `Config > platform > rttov_coefdir`


Type	`string`
Required	No

Description: Path to RTTOV_COEF input data

Property `Config > platform > scratch`


Type	`string`
Required	No

Description: Path used as macro for e.g. wrk and other directories.

Property `Config > platform > task_name`


Type	`string`
Required	No

Description: Placeholder macro.

Property `Config > platform > flake_dir`


Type	`string`
Required	No

Description: Path to climate PGD dir.

Property `Config > platform > albnir_soil_dir`


Type	`string`
Required	No

Description: Path to near-infrared spectrum soil data.

Property `Config > platform > albnir_veg_dir`


Type	`string`
Required	No

Description: Path to near-infrared spectrum vegetation data.

Property `Config > platform > albvis_soil_dir`


Type	`string`
Required	No

Description: Path to visible soil spectrum data.

Property `Config > platform > albvis_veg_dir`


Type	`string`
Required	No

Description: Path to visible spectrum vegetation data.

Property `Config > platform > lai_dir`


Type	`string`
Required	No

Description: TBA

Property `Config > platform > tree_height_dir`


Type	`string`
Required	No

Description: Path to tree_height data.

Property `Config > platform > windfarm_path`


Type	`string`
Required	No

Description: Path to wind farm parameterisation input data.

Property `Config > platform > archive_root`


Type	`string`
Required	No

Description: Path to the main archive directory

Property `Config > platform > unix_group`


Type	`string`
Required	No
Default	`""`

Description: Default unix group for directories created by deode, leave empty to use default group of user.

Property `Config > scheduler`

Title: Scheduler Section, defined in files under include/scheduler


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Settings for implemented schedulers

Property	Type	Required	Default	Title/Description
ecfvars	object	No	-	Ecflow HPC scheduler Section, defined in files under include/scheduler

Property `Config > scheduler > ecfvars`

Title: Ecflow HPC scheduler Section, defined in files under include/scheduler


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: DEODE HPC specific ecflow settings

Property	Type	Required	Default	Title/Description
ecf_tries	integer	No	1	Ecflow tries.
ecf_host	string	No	-	Ecflow host. HPC dependent.
ecf_port	Combination	No	-	Ecflow port, HPC or user dependet. To set depending on userid use `_set_port_from_user(offset)` where offset is an interger to be added to the userid
ecf_jobout	string	No	-	Path to Ecflow job output.
ecf_files	string	No	-	Path to Ecflow operating files.
ecf_files_remotely	string	No	-	Path to Ecflow operating files if in remote location, different to ecf_files.
ecf_home	string	No	-	Path to Ecflow home.
ecf_user	string	No	“”	Ecflow user, only set when required
ecf_remoteuser	string	No	“”	Ecflow remote user, only set when required
ecf_deode_home	string	No	-	Deode home directory stripped for parts specific to where a node is mounted on a cluster

Property `Config > scheduler > ecfvars > ecf_tries`


Type	`integer`
Required	No
Default	`1`

Description: Ecflow tries.

Property `Config > scheduler > ecfvars > ecf_host`


Type	`string`
Required	No

Description: Ecflow host. HPC dependent.

Property `Config > scheduler > ecfvars > ecf_port`


Type	`combining`
Required	No

Description: Ecflow port, HPC or user dependet. To set depending on userid use _set_port_from_user(offset) where offset is an interger to be added to the userid

Any of(Option)
item 0
item 1

Property `Config > scheduler > ecfvars > ecf_port > anyOf > item 0`


Type	`integer`
Required	No

Property `Config > scheduler > ecfvars > ecf_port > anyOf > item 1`


Type	`string`
Required	No

Restrictions
Must match regular expression	`_set_port_by_user$(\d+)$` Test

Property `Config > scheduler > ecfvars > ecf_jobout`


Type	`string`
Required	No

Description: Path to Ecflow job output.

Property `Config > scheduler > ecfvars > ecf_files`


Type	`string`
Required	No

Description: Path to Ecflow operating files.

Property `Config > scheduler > ecfvars > ecf_files_remotely`


Type	`string`
Required	No

Description: Path to Ecflow operating files if in remote location, different to ecf_files.

Property `Config > scheduler > ecfvars > ecf_home`


Type	`string`
Required	No

Description: Path to Ecflow home.

Property `Config > scheduler > ecfvars > ecf_user`


Type	`string`
Required	No
Default	`""`

Description: Ecflow user, only set when required

Property `Config > scheduler > ecfvars > ecf_remoteuser`


Type	`string`
Required	No
Default	`""`

Description: Ecflow remote user, only set when required

Property `Config > scheduler > ecfvars > ecf_deode_home`


Type	`string`
Required	No

Description: Deode home directory stripped for parts specific to where a node is mounted on a cluster

Property `Config > submission`

Title: Submission Section, defined in files under include/submission


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines host dependent runtime settings such as binaries, batch job rules, modules and similar

Property	Type	Required	Default	Title/Description
account	string	No	-	Global setting of account to be used. E.g. `#SBATCH -A some_account` for slurm. Setting of account on group or task level overrides the global setting
bindir	string	No	-	Location of binaries
nproma	number	No	-32	NPROMA size in the forecast model. See the namelists for where it is used
lfftw	boolean	No	true	Use of the FFTW library. See the namelists for where it is used
module_initfile	string	No	-	File to use for module initialization, overrides module_initpath
module_initpath	string	No	-	Path to the version of env_modules_python.py to be used in the module initialization
default_submit_type	string	No	-	Defines the default submit type for tasks not listed in any defined type
task_exceptions	object	No	-	Allows to define task specific settings like BATCH, MODULES, NPROC. Use as task_exceptions.taskname.property
types	object	No	-	Submission types
iomerge	object	No	-	IO-merge group

Property `Config > submission > account`


Type	`string`
Required	No

Description: Global setting of account to be used. E.g. #SBATCH -A some_account for slurm. Setting of account on group or task level overrides the global setting

Property `Config > submission > bindir`


Type	`string`
Required	No

Description: Location of binaries

Property `Config > submission > nproma`


Type	`number`
Required	No
Default	`-32`

Description: NPROMA size in the forecast model. See the namelists for where it is used

Property `Config > submission > lfftw`


Type	`boolean`
Required	No
Default	`true`

Description: Use of the FFTW library. See the namelists for where it is used

Property `Config > submission > module_initfile`


Type	`string`
Required	No

Description: File to use for module initialization, overrides module_initpath

Property `Config > submission > module_initpath`


Type	`string`
Required	No

Description: Path to the version of env_modules_python.py to be used in the module initialization

Property `Config > submission > default_submit_type`


Type	`string`
Required	No

Description: Defines the default submit type for tasks not listed in any defined type

Property `Config > submission > task_exceptions`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Allows to define task specific settings like BATCH, MODULES, NPROC. Use as task_exceptions.taskname.property

Property `Config > submission > types`

Title: Submission types


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines settings related to various groups

Property	Type	Required	Default	Title/Description
serial	object	No	-	Submission group
parallel	object	No	-	Submission group
background_vm	object	No	-	Submission group
background_hpc	object	No	-	Submission group
gnu	object	No	-	Submission group
sqlite	object	No	-	Submission group
Forecast_cpu	object	No	-	Submission group
Forecast_gpu	object	No	-	Submission group

Property `Config > submission > types > serial`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > serial > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > serial > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > serial > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > serial > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > serial > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > serial > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > serial > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > serial > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > serial > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > serial > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > serial > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > parallel`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > parallel > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > parallel > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > parallel > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > parallel > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > parallel > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > parallel > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > parallel > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > parallel > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > parallel > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > parallel > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > parallel > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > background_vm`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > background_vm > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > background_vm > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > background_vm > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > background_vm > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > background_vm > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > background_vm > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > background_vm > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > background_vm > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > background_vm > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > background_vm > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > background_vm > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > background_hpc`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > background_hpc > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > background_hpc > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > background_hpc > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > background_hpc > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > background_hpc > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > background_hpc > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > background_hpc > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > background_hpc > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > background_hpc > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > background_hpc > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > background_hpc > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > gnu`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > gnu > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > gnu > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > gnu > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > gnu > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > gnu > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > gnu > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > gnu > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > gnu > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > gnu > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > gnu > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > gnu > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > sqlite`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > sqlite > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > sqlite > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > sqlite > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > sqlite > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > sqlite > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > sqlite > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > sqlite > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > sqlite > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > sqlite > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > sqlite > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > sqlite > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > Forecast_cpu`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > Forecast_cpu > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > Forecast_cpu > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > Forecast_cpu > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > Forecast_cpu > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > Forecast_cpu > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > Forecast_cpu > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > Forecast_cpu > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > Forecast_cpu > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > Forecast_cpu > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > Forecast_cpu > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > Forecast_cpu > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > types > Forecast_gpu`

Title: Submission group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines the properties avilable for a submit group. See the existing submission files for examples

Property	Type	Required	Default	Title/Description
tasks	array of string	No	-	List of tasks belonging to this group
SCHOST	string	Yes	-	Name of the host where the job runs
NPROC	number	No	-	Number of processors for this task
NPROC_IO	number	No	0	Number of io processors for this task, only applicable for tasks involving the forecast model
WRAPPER	string	No	“”	Prefix for binaries to be executed, e.g. srun
BATCH	object	No	-	Sets batch job arguments like walltime
ENV	object	No	-	Sets environment variables
MODULES	object	No	-	Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property `Config > submission > types > Forecast_gpu > tasks`


Type	`array of string`
Required	No

Description: List of tasks belonging to this group

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
tasks items	-

Config > submission > types > Forecast_gpu > tasks > tasks items


Type	`string`
Required	No

Property `Config > submission > types > Forecast_gpu > SCHOST`


Type	`string`
Required	Yes

Description: Name of the host where the job runs

Restrictions
Min length	1

Property `Config > submission > types > Forecast_gpu > NPROC`


Type	`number`
Required	No

Description: Number of processors for this task

Property `Config > submission > types > Forecast_gpu > NPROC_IO`


Type	`number`
Required	No
Default	`0`

Description: Number of io processors for this task, only applicable for tasks involving the forecast model

Property `Config > submission > types > Forecast_gpu > WRAPPER`


Type	`string`
Required	No
Default	`""`

Description: Prefix for binaries to be executed, e.g. srun

Property `Config > submission > types > Forecast_gpu > BATCH`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets batch job arguments like walltime

Property `Config > submission > types > Forecast_gpu > ENV`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets environment variables

Property `Config > submission > types > Forecast_gpu > MODULES`


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Sets modules to purge/use/unload/load or switch. To maintain the order decorate with comments to override the automatic sorting

Property	Type	Required	Default	Title/Description
^(.*)$	array of string	No	-	-

Pattern Property `Config > submission > types > Forecast_gpu > MODULES > ^(.*)$`


Type	`array of string`
Required	No

	Array restrictions
Min items	1
Max items	3
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
^(.*)$ items	-

Config > submission > types > Forecast_gpu > MODULES > ^(.)$ > ^(.)$ items


Type	`string`
Required	No

Property `Config > submission > iomerge`

Title: IO-merge group


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Defines settings related to the iomerge task

Property	Type	Required	Default	Title/Description
age_limit	object	No	-	IO-merge processing wait limits
files_expected	object	No	-	IO-merge file expectations

Property `Config > submission > iomerge > age_limit`

Title: IO-merge processing wait limits


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Time in seconds to wait before processing files.

Property	Type	Required	Default	Title/Description
history	number	No	20	History files
surfex	number	No	15	Surfex files
fullpos	number	No	15	Fullpos files

Property `Config > submission > iomerge > age_limit > history`


Type	`number`
Required	No
Default	`20`

Description: History files

Property `Config > submission > iomerge > age_limit > surfex`


Type	`number`
Required	No
Default	`15`

Description: Surfex files

Property `Config > submission > iomerge > age_limit > fullpos`


Type	`number`
Required	No
Default	`15`

Description: Fullpos files

Property `Config > submission > iomerge > files_expected`

Title: IO-merge file expectations


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Number of files expected for merge. Set to 0 to let the code decide and -1 for no checking.

Property	Type	Required	Default	Title/Description
history	number	No	-1	History files, 0 implies -1 as the number of files is highly output dependent.
surfex	number	No	0	Surfex files, 0 implies nproc_io files
fullpos	number	No	0	Fullpos files, 0 implies 1+nproc_io files

Property `Config > submission > iomerge > files_expected > history`


Type	`number`
Required	No
Default	`-1`

Description: History files, 0 implies -1 as the number of files is highly output dependent.

Property `Config > submission > iomerge > files_expected > surfex`


Type	`number`
Required	No
Default	`0`

Description: Surfex files, 0 implies nproc_io files

Property `Config > submission > iomerge > files_expected > fullpos`


Type	`number`
Required	No
Default	`0`

Description: Fullpos files, 0 implies 1+nproc_io files

Property `Config > vertical_levels`

Title: Vertical Levels, defined in files under include/vertica_levels


Type	`object`
Required	No
Additional properties	[Any type: allowed]

Description: Options for vertical levels

Property	Type	Required	Default	Title/Description
nlev	integer	No	-	Number of vertical full levels
ahalf	array	No	-	Level definition for the a coefficient of half levels
bhalf	array	No	-	Level definition for the b coefficient of half levels

Property `Config > vertical_levels > nlev`


Type	`integer`
Required	No

Description: Number of vertical full levels

Property `Config > vertical_levels > ahalf`


Type	`array`
Required	No

Description: Level definition for the a coefficient of half levels

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

At least one of the items must be


Type	`number`
Required	No

Property `Config > vertical_levels > bhalf`


Type	`array`
Required	No

Description: Level definition for the b coefficient of half levels

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

At least one of the items must be


Type	`number`
Required	No

Troubleshooting

Welcome to our troubleshooting tips. Before proceeding, please make sure you have carefully read the README file and, if applicable, the development guide.

Cannot run poetry

Make sure your system fulfills all system requirements. If you cannot execute poetry even so, you may need to reinstall and reconfigure it as instructed in the README file.

ImportError or ModuleNotFoundError when running the package’s executable

Try running poetry update

poetry update or poetry update fail

Try removing the package’s .venv directory and run the command again. If it still doesn’t work, see Cannot run poetry and try once more.

Failing linting checks

You can run poetry devtools lint --fix locally to fix some of the linting issues. You will need to solve the remaining issues manually, but the output of the linting tools usually tell you what is wrong and which place in the code you should look.

Note: devtools lint does not currently work for Python >=3.12 (as it depends on flakeheaven)

Failing tests

It is always recommended to run the test suite locally address any encountered issue before pushing to you pull request.

Failing CI checks on github

Please run poetry devtools pre-push-checks and fix any eventually encountered error before you push your commits to update the pull request.

Failing coverage checks on CI

You ned to add unit tests covering reasonably well the changes you are making to the code.

Miscellaneous Documentation

DEODE environment variables

Local installations

Adding a new host

Setup ecflow

freja

Installing under mamba

Contact

Available tasks

Preparation of static files

Surfex

E923

Input data

Forecasting

Postprocessing

Archiving

Cleaning

Configure cases

The case setup

Adding a new host

Time handling

EPS setup

Enabling EPS

Configuring EPS

1. Single value -> all members get the same setting

2. List of values -> first member gets first item, second member gets second item, etc. (with “circular boundary condition”)

3. Dict of mbr/value pairs -> a given member get the value of the mbr key

4. Python subclass of deode.eps.custom_generators.BaseGenerator. Generates member settings based on list of members.

Domain configuration

Define new domains

Handling of binaries

Compilation and external sources

How to specify binaries

Computational parameters in config file

Namelist handling in deode

Internal usage

Get a specific namelist from command line

Add your own namelist

Modify a namelist from config

Configure selection of timings in output settings

Example

Configure selection of fields from fullpos

Overview

The fullpos config files

NAMFPC settings

Selection

Combine selection files

Example

e923 Update

Original instructions:

Adding a New Task

Code requirements

Handling output

Submission rules for a task

Plug-ins

Plugin capablilities

Running your own suite

Enable your own plug-in

Impact models

General design

EHYPE

Cleaning of experiment

Cleaning task to clean experiment files

Cleaning settings are separeted to general default settings and folder specific settings:

Settings for the working folder

Settings for the archive folder

Some notes about using the FDB archive

Getting an expver

Preparing the fdb tool

How to list available data

How to retrieve archived data from FDB:

How to set expver in DEODE Workflow

How to exclude variables from being archived

How to remove data

Notes about georef

Config

Property Config > general

Property Config > general > times

Property Config > general > times > oneOf > item 0

Property Config > general > times > oneOf > item 0 > anyOf > item 0

4. Python subclass of `deode.eps.custom_generators.BaseGenerator`. Generates member settings based on list of members.

Property `Config > general`

Property `Config > general > times`

Property `Config > general > times > oneOf > item 0`

Property `Config > general > times > oneOf > item 0 > anyOf > item 0`

Property `Config > general > times > oneOf > item 0 > anyOf > item 1`

Property `Config > general > times > oneOf > item 0 > anyOf > item 1 > not > anyOf > item 0`

Property `Config > general > times > oneOf > item 0 > anyOf > item 1 > not > anyOf > item 1`

Property `Config > general > times > oneOf > item 0 > anyOf > item 1 > not > anyOf > item 2`

Property `Config > general > times > oneOf > item 1`

Property `Config > general > times > oneOf > item 1 > not > anyOf > item 0`

Property `Config > general > times > oneOf > item 1 > not > anyOf > item 1`

Property `Config > general > times > forecast_range`

Property `Config > general > times > start`

Property `Config > general > times > end`

Property `Config > general > times > list`

Property `Config > general > times > cycle_length`

Property `Config > general > times > basetime`

Property `Config > general > times > validtime`

Property `Config > general > accept_static_namelists`

Property `Config > general > case`

Property `Config > general > realization`

Property `Config > general > realization > oneOf > item 0`

Property `Config > general > realization > oneOf > item 1`

Property `Config > general > cnmexp`

Property `Config > general > loglevel`

Property `Config > general > surfex`

Property `Config > general > keep_workdirs`

Property `Config > general > csc`

Property `Config > general > cycle`

Property `Config > general > event_type`

Property `Config > general > initfile`

Property `Config > general > initfile_sfx`

Property `Config > general > namelist`

Property `Config > general > namelist > nrazts`

Property `Config > general > namelist > radiation_frequency`

Property `Config > general > output_settings`

Property `Config > general > output_settings > history`

Property `Config > general > output_settings > history > anyOf > item 0`

Property `Config > general > output_settings > history > anyOf > item 1`

Property `Config > general > output_settings > history > anyOf > item 2`

Property `Config > general > output_settings > history > anyOf > item 2 > item 2 items > anyOf > item 0`

Property `Config > general > output_settings > surfex`

Property `Config > general > output_settings > surfex > anyOf > item 0`

Property `Config > general > output_settings > surfex > anyOf > item 1`

Property `Config > general > output_settings > surfex > anyOf > item 2`

Property `Config > general > output_settings > surfex > anyOf > item 2 > item 2 items > anyOf > item 0`

Property `Config > general > output_settings > fullpos`

Property `Config > general > output_settings > fullpos > anyOf > item 0`

Property `Config > general > output_settings > fullpos > anyOf > item 1`

Property `Config > general > output_settings > fullpos > anyOf > item 2`

Property `Config > general > output_settings > fullpos > anyOf > item 2 > item 2 items > anyOf > item 0`

Property `Config > general > remove_sections`

Property `Config > general > windfarm`

Property `Config > suite_control`

Property `Config > suite_control > suite_definition`

Property `Config > suite_control > do_soil`

Property `Config > suite_control > do_pgd`

Property `Config > suite_control > mode`