Miscellaneous Documentation

GitHub Github Pages

Linting Tests codecov

Tactus environment variables

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

  • TACTUS_LOGLEVEL sets the logger log level. Select e.g. between info and debug. For more options see the loguru documentation.

  • TACTUS_HOST allows to override the automatic detection of host. The host is used to pick up specific configuration settings. See e.g. tactus show host

  • TACTUS_CONFIG_DATA_DIR sets additional search paths for config files. This is useful when using tactus as a package. To see paths in use run tactus 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 tactus/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 TACTUS_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 tactus/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@/tactus_ecflow/ecf_files"
  ecf_files_remotely = "/nobackup/smhid20/users/@USER@/tactus_ecflow/ecf_files"
  ecf_home = "/nobackup/smhid20/users/@USER@/tactus_ecflow/jobout"
  ecf_host = "le1"
  ecf_jobout = "/nobackup/smhid20/users/@USER@/tactus_ecflow/jobout"
  ecf_out = "/nobackup/smhid20/users/@USER@/tactus_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 tactus/scheduler.py

linda

Linda is the SMHI RedHat linux environment. In the following it’s described how to install tactus to run the simple test suite with ecflow.

Fetch and install the micromamba environment, and tactus

"${SHELL}" <(curl -L micro.mamba.pm/install.sh)
micromamba self-update
micromamba create -n tactus_3.10 python=3.10 ecflow poetry
micromamba activate tactus_3.10
git clone git@github.com:ACCORD-NWP/tactus.git
cd tactus
poetry install

Platform dependent config files

  • Rules for archiving: tactus/data/config_files/include/archiving/linda.toml

  • Platform dependent paths: tactus/data/config_files/include/platform_paths/linda.toml

  • Ecflow settings: tactus/data/config_files/include/scheduler/ecflow_linda.toml

  • Job submission rules: tactus/data/config_files/include/submission/linda.toml. Here all jobs are running in the background.

We also have to make sure the host is recognized by adding a rule in tactus/config/known_host.yaml

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:ACCORD-NWP/tactus.git
cd tactus

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 tactus and all it’s dependencies

(tactus-py3.10) $ poetry install

Now we’re ready to go!

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

To load your new environment do

$ cd tactus
$ 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 tactus clone.

Belenos

Belenos is the Météo-France computing cluster for research. On this platform, the tactus can be installed using Micromamba.

Installing under micromamba

Get the code

git clone git@github.com:ACCORD-NWP/tactus.git
cd tactus

Create a micromamba environment and install python, ecflow and gdal.

"${SHELL}" <(curl -L micro.mamba.pm/install.sh)
source ~/.bashrc
micromamba self-update
micromamba create -y -p ${HOME}/micromamba-wf conda python=3.10.* gdal=3.6.2 ecflow

Install tactus and all its dependencies.

cd tactus/tactus/
source $HOME/micromamba-wf/bin/activate
pip install -e . --no-cache --prefer-binary

Then we have a setup:

(base) [coutandn@belenoslogin1 ~]$ tactus --version
2026-03-03 14:15:47 | INFO     | Start tactus v0.24.0 --> "tactus --version"
tactus v0.24.0

Ecflow server

The ecflow server can run on any login node belenosloginN, where N ranges from 0 to 3. The port number is computed by _set_port_from_user, which adds the user’s UID to an offset (default=0). Edit the configuration file : tactus/data/config_files/include/scheduler/ecflow_belenos.toml and set ecf_host to the name of your server.

[scheduler]

[scheduler.ecfvars]
  case_prefix = ""
  ecf_tactus_home = "@TACTUS_HOME@"
  ecf_files = "@HOME@/tactus_ecflow/ecf_files"
  ecf_files_remotely = "@HOME@/tactus_ecflow/ecf_files"
  ecf_home = "@HOME@/tactus_ecflow/jobout"
  ecf_host = "belenoslogin0.belenoshpc.meteo.fr"
  ecf_jobout = "@HOME@/tactus_ecflow/jobout"
  ecf_out = "@HOME@/tactus_ecflow/jobout"
  ecf_port = "_set_port_from_user('0',)"
  ecf_ssl = "0"

[scheduler.ecfvars.troika]
  config_file = "@ECF_TACTUS_HOME@/data/config_files/troika.yml"

Available tasks

Preparations

  • tactus.tasks.cleaning_tasks.PrepRun prepares the run by storing the used (and expanded) config file and by removing old ecflow output and job files.

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

E923

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

Input data

  • tactus.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

  • tactus.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 tactus show namelist [--config-file your_config.toml] -t surfex -n prep

  • tactus.tasks.c903.C903 creates an initial atmospheric state and boundary files from a global ECMWF file. Use tactus show namelist [--config-file your_config.toml] -t master -n c903_[main|domain] to see the two namelists required.

  • tactus.tasks.e927.E927 creates an initial atmospheric state and boundary files from a AROME/HARMONIE-AROME file. Use tactus show namelist [--config-file your_config.toml] -t master -n e927 to see the namelist used.

  • tactus.tasks.interpolsstsic.InterpolSstSic interpolate SST/SIC from the host model to the model geometry with gl.

Forecasting

  • tactus.tasks.forecast.Forecast runs the forecast for any of the three CSCs. Namelists can be extracted with tactus 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

Archiving

All non temporary files produced by the tactus 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

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.

Configure cases

The case setup

Tactus is designed to be highly configurable and driven from a single config file. The tactus 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 tactus/data/config_files/configurations

Example usage would be:

tactus case ?tactus/data/config_files/configurations/cy49t2_alaro -o test.toml

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

--config-file
tactus/data/config_files/config.toml
tactus/data/config_files/modifications/csc/alaro.toml
tactus/data/config_files/include/vertical_levels/MF_87.toml
tactus/data/config_files/modifications/cycle/CY49t2.toml
tactus/data/config_files/modifications/@HOST@.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.

tactus start suite --config-file test.toml

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

tactus case ?tactus/data/config_files/configurations/cy49t2_alaro -o test.toml --start-suite

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

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

tactus case ?tactus/data/config_files/configurations/cy49t2_alaro 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 Configuration by design

Tactus treats every run as an ensemble run. A deterministic run is thus just a special case of an ensemble with only one member. Furthermore, an ensemble in tactus is not limited to consist of a control member and a number of perturbed members. Instead, think of it as an ensemble of configurations, where each member “perturb” the default configuration. One can e.g. think of running an ensemble of

  • a set of different model configurations (e.g. different physics options, different initial conditions, different boundary conditions, etc.)

  • a set of different CSCs

  • a set of different domains

  • a set of different domain resolutions and extends

  • a set of different time settings

  • etc.

Basically any configuration setting can be “perturbed”, i.e. configured differently for each member, so it’s up to your imagination how to use the ensemble design to your needs.

Running a minimal ensemble

To get hands-on running an ensemble, tactus ships with a bunch of example eps include files. To enable one of them, one has to include the file in the configuration or on the commandline. The example eps include files are available in the tactus/data/config_files/include/eps/ directory. E.g. to run a 1 control + 2 perturbed members (using IFSENS boundary data) ensemble, one can use the tactus/data/config_files/include/eps/eps_3members_IFSENS_common_mars_prep and do

tactus case --config-file tactus/data/config_files/config.toml tactus/data/config_files/include/eps/eps_3members_IFSENS_common_mars_prep.toml --start-suite

or include the following in the configuration file

--config-file
tactus/data/config_files/config.toml
tactus/data/config_files/include/eps/eps_3members_IFSENS_common_mars_prep.toml

and do

tactus case --config-file <path_to_config_file> --start-suite

The eps_3members_IFSENS_common_mars_prep.toml file contains the following settings:

[general.times]
  start = "-P1D"

[boundaries.ifs]
  selection = "IFSENS"

[eps.general]
  members = "0:3"

[eps.member_settings.boundaries.ifs]
  bdmember = [0, 1, 2]

Translated into words, including this file in the main config file will make the tactus case command produce a config file with three members:

[general.times]
  start = "-P1D"

[eps.general]
  members = [0, 1, 2]

[eps.member_settings.system]
  # This section comes from the default eps include file tactus/data/config_files/include/eps/eps_default.toml
  wrk = "@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@/@MEMBER_STR@"

[eps.member_settings.boundaries.ifs]
  bdmember = [0, 1, 2]

[eps.members]

[eps.members.0.boundaries.ifs]
  bdmember = 0

[eps.members.1.boundaries.ifs]
  bdmember = 1

[eps.members.2.boundaries.ifs]
  bdmember = 2

NOTE:: The general.times.start setting is set to “-P1D” by default, to make the example able to run out-of-the-box, since IFSENS data is only available in mars for the past two weeks.

The three members (0, 1, and 2) will use the lateral boundary data from corresponding IFSENS member. Note, that member 0 of the IFSENS is the control member, so the EPS member 0 will use the control member data. This is a quite bare bones example, since they only differs in what boundary data they use.

Adjusting which member uses which IFSENS member data

Let’s instead say, that you wanted the member 2 to use the IFSENS member 0 boundary data, i.e. the control member data, and member 0 and 1 to use the IFSENS member 1 and 2 boundary cata, respectively. You can do this by setting eps.member_settings.boundaries.ifs = [1, 2, 0], e.g.

[general.times]
  start = "-P1D"

[boundaries.ifs]
  selection = "IFSENS"

[eps.general]
  members = "0:3"

[eps.member_settings.boundaries.ifs]
  bdmember = [1, 2, 0]

Running the tactus case command will result in a config file with the following [eps] section:

[general.times]
  start = "-P1D"

[eps.general]
  members = [0, 1, 2]

[eps.member_settings.system]
  # This section comes from the default eps include file tactus/data/config_files/include/eps/eps_default.toml
  wrk = "@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@/@MEMBER_STR@"

[eps.member_settings.boundaries.ifs]
  bdmember = [1, 2, 0]

[eps.members]

[eps.members.0]
  bdmember = 1

[eps.members.1]
  bdmember = 2

[eps.members.2]
  bdmember = 0

NOTE:: The general.times.start setting is set to “-P1D” by default, to make the example able to run out-of-the-box, since IFSENS data is only available in mars for the past two weeks.

Common or member specific mars data retrieval

By default, mars data is retrieved for all members simultaneously to optimize the mars requests. This is controlled by the suite_control.member_specific_mars_prep = false setting. As shown in above example, all what one has to do, to retrieve the correct members, is to set the bdmember settings:

[general.times]
  start = "-P1D"

[boundaries.ifs]
  selection = "IFSENS"

[eps.general]
  members = "0:3"

[eps.member_settings.boundaries.ifs]
  bdmember = [0, 1, 2]

NOTE:: The general.times.start setting is set to “-P1D” by default, to make the example able to run out-of-the-box, since IFSENS data is only available in mars for the past two weeks.

To instead retrieve mars data individually for each member, one just has to set the member_specific_mars_prep setting to true in the [suite_control] section.

i.e.

[suite_control]
  member_specific_mars_prep = true

[boundaries.ifs]
  bdmember = "@MEMBER@"
  selection = "IFSENS"

[eps.general]
  members = "0:3"

or

[suite_control]
  member_specific_mars_prep = true

[boundaries.ifs]
  selection = "IFSENS"

[eps.general]
  members = "0:3"

[eps.member_settings.boundaries.ifs]
  bdmember = [0, 1, 2]   # or bdmember = "@MEMBER@"

Member specific static data

By default, the static data is generated one time for all members. To generate static data for each member individually, one has to set the member_specific_static_data setting to true in the [suite_control] section, and adjust the climdir to have a “@MEMBER_STR@” directory.

i.e.

[suite_control]
  member_specific_static_data = true
[system]
  climdir = "@CASEDIR@/climate/@DOMAIN@/@MEMBER_STR@"

Construct ensemble from modification files

Sometimes, one wants to create an ensemble with a lot of specific settings for each member. As an example, one could think of an ensemble of CSCs. Every CSC comes with its own specific configurations, and to type them all into e.g. a eps_3csc_members.toml file is tedious. Instead, one can use predefined toml modification files and reference them in a [eps.member_settings.modifications] section. Let’s take a simple example first.

Let’s imagine we have tree different modification toml files:

  • modifications/mod1.toml:

[general.output_settings]
  fullpos = "PT1H"
  • modifications/mod2.toml

[general.output_settings]
  fullpos = "PT2H"
  • modifications/mod3.toml

[general.output_settings]
  fullpos = "PT3H"

If we add a section [eps.member_settings.modifications] to e.g. the eps_3members_IFSENS.toml file from Running a minimal ensemble, and at the same time imagine that we have defined a general member setting for the fullpos setting:

[general.times]
  start = "-P1D"

[boundaries.ifs]
  selection = "IFSENS"

[eps.general]
  members = "0:3"

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

[eps.member_settings.boundaries.ifs]
  bdmember = [0, 1, 2]

[eps.member_settings.modifications]
  example_mod = ["modifications/mod1.toml", "modifications/mod2.toml", "modifications/mod3.toml"]

then the three modification files will be merged into the resulting config file for the respective members and overwrite any existing setting. E.g. the resulting eps section for member 0 will include settings from "modifications/mod1.toml", for member 1 from "modifications/mod2.toml" and for member 2 from "modifications/mod3.toml". The resulting config file will look like this:

[general.times]
  start = "-P1D"

[eps.general]
  members = [0, 1, 2]

[eps.member_settings.system]
  # This section comes from the default eps include file tactus/data/config_files/include/eps/eps_default.toml
  wrk = "@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@/@MEMBER_STR@"

[eps.member_settings.boundaries.ifs]
  bdmember = [0, 1, 2]

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

[eps.member_settings.modifications]
  example_mod = ["modifications/mod1.toml", "modifications/mod2.toml", "modifications/mod3.toml"]

[eps.members]

[eps.members.0.general.output_settings]
  fullpos = "PT1H"

[eps.members.0.boundaries.ifs]
  bdmember = 0

[eps.members.1.general.output_settings]
  fullpos = "PT2H"

[eps.members.1.boundaries.ifs]
  bdmember = 1

[eps.members.2.general.output_settings]
  fullpos = "PT3H"

[eps.members.2.boundaries.ifs]
  bdmember = 2

NOTE::

  • It’s not important what the keys in the modification section are called. They are just used to label the different modification files.

  • The settings in the modification files will overwrite any existing value for that setting.

  • The general.times.start setting is set to “-P1D” by default, to make the example able to run out-of-the-box, since IFSENS data is only available in mars for the past two weeks.

Now to the 3 CSC ensemble example. To set this up, one needs to have the following in the eps config file (NOTE: the exact modification file paths may change with the tactus version):

[suite_control]
  member_specific_static_data = true

[eps.general]
  members = "0:3"

[eps.member_settings.modifications]
  csc_modification = ["modifications/arome.toml", "modifications/harmonie_arome.toml", "modifications/alaro.toml"]
  cycle_modification = ["modifications/CY48t3.toml", "modifications/CY46h1.toml", "modifications/CY48t3.toml"]
  submission_modification = ["modifications/submission/@HOST@_CY48t3.toml", "modifications/submission/@HOST@_CY46h1.toml", "modifications/submission/@HOST@_CY48t3_alaro.toml"]
  vertical_levels_modification = {2 = "include/vertical_levels/MF_87.toml"}

The member_specific_static_data = true setting is needed since the static data is generated differently for each CSC. Running the tactus case command with this eps config file will result in a config file with all the modifications merged into the member specific sections.

Configuring EPS in general terms

This section describes how to configure an ensemble in tactus in general terms. All configuration described below should be applied to a .toml file, that is included when running the tactus case command, as described in Running a minimal ensemble.

In the [eps.general] section, one can set the members that should be part of the ensemble. The members setting can either be

  1. an integer,

  2. a list of integers or

  3. 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. Setting members = 1 will include only member 1. 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 above rules also apply for the bdmember setting.

To adjust the default member settings to ones needs, one can set member specific settings for basically any existing settings of the tactus 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.

NOTE::

  • Only deviating settings relative to the [eps.member_settings] section are saved to the resulting config file.

  • No validation of the [eps.member_settings.*] sections is done at this point.

  • The original [eps.member_settings] section is included in the resulting config file for reference.

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"

NOTE:

  • “m:n:s” keys are interpreted as slices like for the general members setting, that is {"2:10:2" = "value3"} assigns "value3" to members 2, 4, 6, and 8.

  • The [eps.general.members] setting limits parameter slices. E.g. if [eps.general.members] = "0:10",

      [eps.member_settings]
      parameter = {"6:16" = "value1"}
    

    will set parameter = "value1" only for members 6, 7, 8, and 9.

  • For members with no mbr/value pair, the default is used. I.e. in the above example, members 0-5 will get the default value.

  • In cases, where a mbr key is duplicated in the dictionary (including string slices), the last value is used. E.g. in

  [eps.member_settings]
  parameter = {"2:4" = "value1", 3 = "value2"}

parameter will be set to "value2" for member 3.

4. Python subclass of tactus.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 = "tactus.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 tactus.

Compilation and external sources

Binaries can be compiled in tactus using CMake.

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 tactus

Describes the namelist handling in the tactus.

Internal usage

The tactus namelists are stored as yml files in tactus/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 tactus/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

tactus 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

tactus show namelist -t master -n showme

By default none of the namelist values are substituted with config settings, like e.g. output frequency. If you’d like have the namelist with the substituted values from the config file add a -s to the command. For more information about namelist extraction use the help command.

tactus 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 switch off output for a certain type remove the key fullpos/history/surfex or set it to an empty string ""

  • to configure output at t=0 only set e.g. “PT0H”

  • 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"
  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.

  • 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, tactus/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 tactus/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

tactus --config-file tactus/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.

Master Selection Overview as of version 1.2.0

Cycle: CY49t2, CSC: AROME

Single levels

paramId

shortName

longName

unit

faField

134

sp

Surface pressure

Pa

SURFPRESSION

151

msl

Mean sea level pressure

Pa

MSLPRESSURE

231070

h1thg

Geometric height of 1 degree C theta level above ground

m

SURFISOTPW1.MALT

228235

mucape

Most-unstable CAPE

J kg**-1

SURFCAPE.POS.F00

228236

mucin

Most-unstable CIN

J kg**-1

SURFCIEN.POS.F00

231046

hacg

Geometric height of adiabatic condensation level above ground

m

SURFLIFTCONDLEV

231047

hfcg

Geometric height of free convection level above ground

m

SURFFREECONVLEV

231048

hnbg

Geometric height of neutral buoyancy level above ground

m

SURFEQUILIBRLEV

0

unknown

unknown

unknown

SURFREFLECT.MAX

0

unknown

unknown

unknown

REFLECT_DBZ.MAX

231067

pcdc

Pressure at cloud ceiling

Pa

ATMOCLD.CEIL.P

260109

ceil

Ceiling

m

ATMOCLD.CEIL.H

231045

pcdb

Pressure at cloud base

Pa

ATMOCLD.BASE.P

228023

cbh

Cloud base height

m

ATMOCLD.BASE.H

228024

deg0l

Geometric height of 0 degrees C atmospheric isothermal level above ground

m

ISOT_ALTIT

231049

deg3l

Geometric height of 3 degrees C atmospheric isothermal level above ground

m

ISOT_ALTIT

178

tsr

Top net short-wave (solar) radiation

J m**-2

SOMMFLU.RAY.SOLA

176

ssr

Surface net short-wave (solar) radiation

J m**-2

SURFFLU.RAY.SOLA

179

ttr

Top net long-wave (thermal) radiation

J m**-2

SOMMFLU.RAY.THER

177

str

Surface net long-wave (thermal) radiation

J m**-2

SURFFLU.RAY.THER

235019

tislhef

Time integral of surface latent heat evaporation flux

J m**-2

SURFFLU.LAT.MEVA

260259

eva

Evaporation

kg m**-2

SURFFLU.MEVAP.EA

146

sshf

Time-integrated surface sensible heat net flux

J m**-2

SURFFLU.CHA.SENS

169

ssrd

Surface short-wave (solar) radiation downwards

J m**-2

SURFRAYT_SOLA_DE

175

strd

Surface long-wave (thermal) radiation downwards

J m**-2

SURFRAYT_THER_DE

235015

tirf

Time integral of rain flux

kg m**-2

SURFACCPLUIE

260046

tsnowp

Total snow precipitation

kg m**-2

SURFACCNEIGE

231040

tgrp

Graupel (snow pellets) precipitation

kg m**-2

SURFACCGRAUPEL

231041

litotint

Time-integrated total lightning flash density

km**-2

SURFDIAG.FLASH

228228

tp

Total Precipitation

kg m**-2

TOTAL.PRECIP.

130

t

Temperature

K

SURFTEMPERATURE

228141

sd

Snow depth water equivalent

kg m**-2

SURFRESERV.NEIGE

237120

max_tcolg

Time-maximum total column vertically-integrated graupel (snow pellets)

kg m**-2

SURFDIAGHAIL

260058

rprate

Rain precipitation rate

kg m**-2 s**-1

SURFINSPLUIE

167

2t

2 metre temperature

K

CLSTEMPERATURE

260242

2r

2 metre relative humidity

%

CLSHUMI.RELATIVE

174096

2sh

2 metre specific humidity

kg kg**-1

CLSHUMI.SPECIFIQ

165

10u

10 metre U wind component

m s**-1

CLSVENT.ZONAL

166

10v

10 metre V wind component

m s**-1

CLSVENT.MERIDIEN

260646

10efg

10 metre eastward wind gust since previous post-processing

m s**-1

CLSU.RAF60M.XFU

260647

10nfg

10 metre northward wind gust since previous post-processing

m s**-1

CLSV.RAF60M.XFU

201

mx2t

Maximum temperature at 2 metres since previous post-processing

K

CLSMAXI.TEMPERAT

202

mn2t

Minimum temperature at 2 metres since previous post-processing

K

CLSMINI.TEMPERAT

3075

hcc

High cloud cover

%

SURFNEBUL.HAUTE

3074

mcc

Medium cloud cover

%

SURFNEBUL.MOYENN

3073

lcc

Low cloud cover

%

SURFNEBUL.BASSE

228164

tcc

Total Cloud Cover

%

SURFNEBUL.TOTALE

159

blh

Boundary layer height

m

CLPMHAUT.MOD.XFU

238105

min_vis

Time-minimum visibility

m

CLSVISIN_60

238382

min_visp

Time-minimum visibility through precipitation

m

CLSVISIHYDN60

260320

ptype_freq1h

Precipitation type (most frequent) in the last 1 hour

(Code table 4.201)

CLSPTYPE_60M

260318

ptype_sev1h

Precipitation type (most severe) in the last 1 hour

(Code table 4.201)

CLSPTYPESEV_60M

261002

mrt

Mean radiant temperature

K

CLSMEAN.RAD.TEMP

Height levels

paramId

shortName

longName

unit

faField

260238

wz

Geometric vertical velocity

m s**-1

VERT.VELOCIT

248

cc

Fraction of cloud cover

(0 - 1)

CLOUD_FRACTI

157

r

Relative humidity

%

HUMI_RELATI

133

q

Specific humidity

kg kg**-1

HUMI.SPECIFI

130

t

Temperature

K

TEMPERATURE

131

u

U component of wind

m s**-1

WIND.U.PHYS

132

v

V component of wind

m s**-1

WIND.V.PHYS

247

ciwc

Specific cloud ice water content

kg kg**-1

ICE_CRYSTAL

246

clwc

Specific cloud liquid water content

kg kg**-1

CLOUD_WATER

260028

grle

Graupel (snow pellets)

kg kg**-1

GRAUPEL

75

crwc

Specific rain water content

kg kg**-1

RAIN

76

cswc

Specific snow water content

kg kg**-1

SNOW

260155

tke

Turbulent kinetic energy

J kg**-1

TKE

Pressure levels

paramId

shortName

longName

unit

faField

248

cc

Fraction of cloud cover

(0 - 1)

CLOUD_FRACTI

260028

grle

Graupel (snow pellets)

kg kg**-1

GRAUPEL

157

r

Relative humidity

%

HUMI_RELATI

134

sp

Surface pressure

Pa

PRESSURE

75

crwc

Specific rain water content

kg kg**-1

RAIN

76

cswc

Specific snow water content

kg kg**-1

SNOW

130

t

Temperature

K

TEMPERATURE

129

z

Geopotential

m2 s-2

GEOPOTENTIEL

133

q

Specific humidity

kg kg**-1

HUMI.SPECIFI

131

u

U component of wind

m s**-1

WIND.U.PHYS

132

v

V component of wind

m s**-1

WIND.V.PHYS

260238

wz

Geometric vertical velocity

m s**-1

VERT.VELOCIT

130

t

Temperature

K

VITESSE_VERT

247

ciwc

Specific cloud ice water content

kg kg**-1

ICE_CRYSTAL

246

clwc

Specific cloud liquid water content

kg kg**-1

CLOUD_WATER

260155

tke

Turbulent kinetic energy

J kg**-1

TKE

Cycle: CY49t2, CSC: ALARO

Single levels

paramId

shortName

longName

unit

faField

134

sp

Surface pressure

Pa

SURFPRESSION

151

msl

Mean sea level pressure

Pa

MSLPRESSURE

231070

h1thg

Geometric height of 1 degree C theta level above ground

m

SURFISOTPW1.MALT

228235

mucape

Most-unstable CAPE

J kg**-1

SURFCAPE.POS.F00

228236

mucin

Most-unstable CIN

J kg**-1

SURFCIEN.POS.F00

231046

hacg

Geometric height of adiabatic condensation level above ground

m

SURFLIFTCONDLEV

231047

hfcg

Geometric height of free convection level above ground

m

SURFFREECONVLEV

231048

hnbg

Geometric height of neutral buoyancy level above ground

m

SURFEQUILIBRLEV

0

unknown

unknown

unknown

SURFREFLECT.MAX

0

unknown

unknown

unknown

REFLECT_DBZ.MAX

231067

pcdc

Pressure at cloud ceiling

Pa

ATMOCLD.CEIL.P

260109

ceil

Ceiling

m

ATMOCLD.CEIL.H

231045

pcdb

Pressure at cloud base

Pa

ATMOCLD.BASE.P

228023

cbh

Cloud base height

m

ATMOCLD.BASE.H

228024

deg0l

Geometric height of 0 degrees C atmospheric isothermal level above ground

m

ISOT_ALTIT

231049

deg3l

Geometric height of 3 degrees C atmospheric isothermal level above ground

m

ISOT_ALTIT

178

tsr

Top net short-wave (solar) radiation

J m**-2

SOMMFLU.RAY.SOLA

176

ssr

Surface net short-wave (solar) radiation

J m**-2

SURFFLU.RAY.SOLA

179

ttr

Top net long-wave (thermal) radiation

J m**-2

SOMMFLU.RAY.THER

177

str

Surface net long-wave (thermal) radiation

J m**-2

SURFFLU.RAY.THER

235019

tislhef

Time integral of surface latent heat evaporation flux

J m**-2

SURFFLU.LAT.MEVA

260259

eva

Evaporation

kg m**-2

SURFFLU.MEVAP.EA

146

sshf

Time-integrated surface sensible heat net flux

J m**-2

SURFFLU.CHA.SENS

169

ssrd

Surface short-wave (solar) radiation downwards

J m**-2

SURFRAYT_SOLA_DE

175

strd

Surface long-wave (thermal) radiation downwards

J m**-2

SURFRAYT_THER_DE

231041

litotint

Time-integrated total lightning flash density

km**-2

SURFDIAG.FLASH

228219

lsrr

Large scale rain rate

kg m**-2 s**-1

SURFPREC.EAU.GEC

228218

crr

Convective rain rate

kg m**-2 s**-1

SURFPREC.EAU.CON

231058

lsfwe

Large-scale snowfall water equivalent

kg m**-2

SURFPREC.NEI.GEC

231057

csfwe

Convective snowfall water equivalent

kg m**-2

SURFPREC.NEI.CON

231040

tgrp

Graupel (snow pellets) precipitation

kg m**-2

SURFPREC.GRA.GEC

228228

tp

Total Precipitation

kg m**-2

TOTAL.PRECIP.

130

t

Temperature

K

SURFTEMPERATURE

228141

sd

Snow depth water equivalent

kg m**-2

SURFRESERV.NEIGE

237120

max_tcolg

Time-maximum total column vertically-integrated graupel (snow pellets)

kg m**-2

SURFDIAGHAIL

167

2t

2 metre temperature

K

CLSTEMPERATURE

260242

2r

2 metre relative humidity

%

CLSHUMI.RELATIVE

174096

2sh

2 metre specific humidity

kg kg**-1

CLSHUMI.SPECIFIQ

165

10u

10 metre U wind component

m s**-1

CLSVENT.ZONAL

166

10v

10 metre V wind component

m s**-1

CLSVENT.MERIDIEN

260646

10efg

10 metre eastward wind gust since previous post-processing

m s**-1

CLSU.RAF60M.XFU

260647

10nfg

10 metre northward wind gust since previous post-processing

m s**-1

CLSV.RAF60M.XFU

201

mx2t

Maximum temperature at 2 metres since previous post-processing

K

CLSMAXI.TEMPERAT

202

mn2t

Minimum temperature at 2 metres since previous post-processing

K

CLSMINI.TEMPERAT

3075

hcc

High cloud cover

%

SURFNEBUL.HAUTE

3074

mcc

Medium cloud cover

%

SURFNEBUL.MOYENN

3073

lcc

Low cloud cover

%

SURFNEBUL.BASSE

228164

tcc

Total Cloud Cover

%

SURFNEBUL.TOTALE

159

blh

Boundary layer height

m

CLPMHAUT.MOD.XFU

238105

min_vis

Time-minimum visibility

m

CLSVISIN_60

238382

min_visp

Time-minimum visibility through precipitation

m

CLSVISIHYDN60

260320

ptype_freq1h

Precipitation type (most frequent) in the last 1 hour

(Code table 4.201)

CLSPTYPE_60M

260318

ptype_sev1h

Precipitation type (most severe) in the last 1 hour

(Code table 4.201)

CLSPTYPESEV_60M

261002

mrt

Mean radiant temperature

K

CLSMEAN.RAD.TEMP

Height levels

paramId

shortName

longName

unit

faField

260238

wz

Geometric vertical velocity

m s**-1

VERT.VELOCIT

248

cc

Fraction of cloud cover

(0 - 1)

CLOUD_FRACTI

157

r

Relative humidity

%

HUMI_RELATI

133

q

Specific humidity

kg kg**-1

HUMI.SPECIFI

130

t

Temperature

K

TEMPERATURE

131

u

U component of wind

m s**-1

WIND.U.PHYS

132

v

V component of wind

m s**-1

WIND.V.PHYS

247

ciwc

Specific cloud ice water content

kg kg**-1

ICE_CRYSTAL

246

clwc

Specific cloud liquid water content

kg kg**-1

CLOUD_WATER

260028

grle

Graupel (snow pellets)

kg kg**-1

GRAUPEL

75

crwc

Specific rain water content

kg kg**-1

RAIN

76

cswc

Specific snow water content

kg kg**-1

SNOW

260155

tke

Turbulent kinetic energy

J kg**-1

TKE

Pressure levels

paramId

shortName

longName

unit

faField

248

cc

Fraction of cloud cover

(0 - 1)

CLOUD_FRACTI

260028

grle

Graupel (snow pellets)

kg kg**-1

GRAUPEL

157

r

Relative humidity

%

HUMI_RELATI

134

sp

Surface pressure

Pa

PRESSURE

75

crwc

Specific rain water content

kg kg**-1

RAIN

76

cswc

Specific snow water content

kg kg**-1

SNOW

130

t

Temperature

K

TEMPERATURE

129

z

Geopotential

m2 s-2

GEOPOTENTIEL

133

q

Specific humidity

kg kg**-1

HUMI.SPECIFI

131

u

U component of wind

m s**-1

WIND.U.PHYS

132

v

V component of wind

m s**-1

WIND.V.PHYS

260238

wz

Geometric vertical velocity

m s**-1

VERT.VELOCIT

130

t

Temperature

K

VITESSE_VERT

247

ciwc

Specific cloud ice water content

kg kg**-1

ICE_CRYSTAL

246

clwc

Specific cloud liquid water content

kg kg**-1

CLOUD_WATER

260155

tke

Turbulent kinetic energy

J kg**-1

TKE

Cycle: CY49t2, CSC: HARMONIE_AROME

Single levels

paramId

shortName

longName

unit

faField

134

sp

Surface pressure

Pa

SURFPRESSION

151

msl

Mean sea level pressure

Pa

MSLPRESSURE

231070

h1thg

Geometric height of 1 degree C theta level above ground

m

SURFISOTPW1.MALT

228235

mucape

Most-unstable CAPE

J kg**-1

SURFCAPE.POS.F00

228236

mucin

Most-unstable CIN

J kg**-1

SURFCIEN.POS.F00

231046

hacg

Geometric height of adiabatic condensation level above ground

m

SURFLIFTCONDLEV

231047

hfcg

Geometric height of free convection level above ground

m

SURFFREECONVLEV

231048

hnbg

Geometric height of neutral buoyancy level above ground

m

SURFEQUILIBRLEV

0

unknown

unknown

unknown

SURFREFLECT.MAX

0

unknown

unknown

unknown

REFLECT_DBZ.MAX

231067

pcdc

Pressure at cloud ceiling

Pa

ATMOCLD.CEIL.P

260109

ceil

Ceiling

m

ATMOCLD.CEIL.H

231045

pcdb

Pressure at cloud base

Pa

ATMOCLD.BASE.P

228023

cbh

Cloud base height

m

ATMOCLD.BASE.H

228024

deg0l

Geometric height of 0 degrees C atmospheric isothermal level above ground

m

ISOT_ALTIT

231049

deg3l

Geometric height of 3 degrees C atmospheric isothermal level above ground

m

ISOT_ALTIT

178

tsr

Top net short-wave (solar) radiation

J m**-2

SOMMFLU.RAY.SOLA

176

ssr

Surface net short-wave (solar) radiation

J m**-2

SURFFLU.RAY.SOLA

179

ttr

Top net long-wave (thermal) radiation

J m**-2

SOMMFLU.RAY.THER

177

str

Surface net long-wave (thermal) radiation

J m**-2

SURFFLU.RAY.THER

235019

tislhef

Time integral of surface latent heat evaporation flux

J m**-2

SURFFLU.LAT.MEVA

260259

eva

Evaporation

kg m**-2

SURFFLU.MEVAP.EA

146

sshf

Time-integrated surface sensible heat net flux

J m**-2

SURFFLU.CHA.SENS

169

ssrd

Surface short-wave (solar) radiation downwards

J m**-2

SURFRAYT_SOLA_DE

175

strd

Surface long-wave (thermal) radiation downwards

J m**-2

SURFRAYT_THER_DE

235015

tirf

Time integral of rain flux

kg m**-2

SURFACCPLUIE

260046

tsnowp

Total snow precipitation

kg m**-2

SURFACCNEIGE

231040

tgrp

Graupel (snow pellets) precipitation

kg m**-2

SURFACCGRAUPEL

231041

litotint

Time-integrated total lightning flash density

km**-2

SURFDIAG.FLASH

228228

tp

Total Precipitation

kg m**-2

TOTAL.PRECIP.

130

t

Temperature

K

SURFTEMPERATURE

228141

sd

Snow depth water equivalent

kg m**-2

SURFRESERV.NEIGE

237120

max_tcolg

Time-maximum total column vertically-integrated graupel (snow pellets)

kg m**-2

SURFDIAGHAIL

260058

rprate

Rain precipitation rate

kg m**-2 s**-1

SURFINSPLUIE

167

2t

2 metre temperature

K

CLSTEMPERATURE

260242

2r

2 metre relative humidity

%

CLSHUMI.RELATIVE

174096

2sh

2 metre specific humidity

kg kg**-1

CLSHUMI.SPECIFIQ

165

10u

10 metre U wind component

m s**-1

CLSVENT.ZONAL

166

10v

10 metre V wind component

m s**-1

CLSVENT.MERIDIEN

260646

10efg

10 metre eastward wind gust since previous post-processing

m s**-1

CLSU.RAF60M.XFU

260647

10nfg

10 metre northward wind gust since previous post-processing

m s**-1

CLSV.RAF60M.XFU

201

mx2t

Maximum temperature at 2 metres since previous post-processing

K

CLSMAXI.TEMPERAT

202

mn2t

Minimum temperature at 2 metres since previous post-processing

K

CLSMINI.TEMPERAT

3075

hcc

High cloud cover

%

SURFNEBUL.HAUTE

3074

mcc

Medium cloud cover

%

SURFNEBUL.MOYENN

3073

lcc

Low cloud cover

%

SURFNEBUL.BASSE

228164

tcc

Total Cloud Cover

%

SURFNEBUL.TOTALE

159

blh

Boundary layer height

m

CLPMHAUT.MOD.XFU

238105

min_vis

Time-minimum visibility

m

CLSVISIN_60

238382

min_visp

Time-minimum visibility through precipitation

m

CLSVISIHYDN60

260320

ptype_freq1h

Precipitation type (most frequent) in the last 1 hour

(Code table 4.201)

CLSPTYPE_60M

260318

ptype_sev1h

Precipitation type (most severe) in the last 1 hour

(Code table 4.201)

CLSPTYPESEV_60M

261002

mrt

Mean radiant temperature

K

CLSMEAN.RAD.TEMP

Height levels

paramId

shortName

longName

unit

faField

260238

wz

Geometric vertical velocity

m s**-1

VERT.VELOCIT

248

cc

Fraction of cloud cover

(0 - 1)

CLOUD_FRACTI

157

r

Relative humidity

%

HUMI_RELATI

133

q

Specific humidity

kg kg**-1

HUMI.SPECIFI

130

t

Temperature

K

TEMPERATURE

131

u

U component of wind

m s**-1

WIND.U.PHYS

132

v

V component of wind

m s**-1

WIND.V.PHYS

247

ciwc

Specific cloud ice water content

kg kg**-1

ICE_CRYSTAL

246

clwc

Specific cloud liquid water content

kg kg**-1

CLOUD_WATER

260028

grle

Graupel (snow pellets)

kg kg**-1

GRAUPEL

75

crwc

Specific rain water content

kg kg**-1

RAIN

76

cswc

Specific snow water content

kg kg**-1

SNOW

260155

tke

Turbulent kinetic energy

J kg**-1

TKE

Pressure levels

paramId

shortName

longName

unit

faField

248

cc

Fraction of cloud cover

(0 - 1)

CLOUD_FRACTI

260028

grle

Graupel (snow pellets)

kg kg**-1

GRAUPEL

157

r

Relative humidity

%

HUMI_RELATI

134

sp

Surface pressure

Pa

PRESSURE

75

crwc

Specific rain water content

kg kg**-1

RAIN

76

cswc

Specific snow water content

kg kg**-1

SNOW

130

t

Temperature

K

TEMPERATURE

129

z

Geopotential

m2 s-2

GEOPOTENTIEL

133

q

Specific humidity

kg kg**-1

HUMI.SPECIFI

131

u

U component of wind

m s**-1

WIND.U.PHYS

132

v

V component of wind

m s**-1

WIND.V.PHYS

260238

wz

Geometric vertical velocity

m s**-1

VERT.VELOCIT

130

t

Temperature

K

VITESSE_VERT

247

ciwc

Specific cloud ice water content

kg kg**-1

ICE_CRYSTAL

246

clwc

Specific cloud liquid water content

kg kg**-1

CLOUD_WATER

260155

tke

Turbulent kinetic energy

J kg**-1

TKE

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 but can be used for ECOCLIMAPII SG as well.

Original instructions:

Utility e923_update serves for updating roughness fields in e923 clim files from SURFEX, i.e. using GMTED2010 or other 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 tactus, a file containing your task needs to be created in the $TACTUS_HOME/tactus/tasks folder, where $TACTUS_HOME points to the full name to the folder in which tactus is installed.

In the tasks folder, the discover_task.py file looks for the task specified in the tactus 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 tactus/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"

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"

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

tactus --config-file=/your/config.toml run --task yourtask  --template $PWD/tactus/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

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

Plugin capablilities

In tactus 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 tactus.

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.

Tactus test-runner

The tactus test-runner runs a number of configurations as defined in the config file atos_bologna.toml

We currently have the following cycle specific config files under the directory tactus/data/test

  • atos_bologna_[CY49t2,CY50t2].toml : Complete set of tests for atos_bologna

  • case_definitions_[CY49t2,CY50t2].toml : Definition of all test cases

  • test_macros.toml : Some macro definitions

  • modifs_atos_bologna_[CY49t2,CY50t2].toml : Platform dependent config modifications

The main difference between CY49t2 and CY50t2 tests is that the latter includes a compilation step whereas the former uses DEODE binaries on ATOS.

Check

tactus test -c tactus/data/tests/atos_bologna_CY50t2.toml -l

Create config files

tactus test -c tactus/data/tests/atos_bologna_CY50t2.toml -m

This will create a directory according to the tag and create all config files in this directory.

Launch the suites

tactus test -c tactus/data/tests/atos_bologna_CY50t2.toml -r

Failures in suites can be treated like any failure. I.e. by changing the relevant code or config and replace/relaunch the suite in full or parts as appropriate. The config files can be regenerated while suites are running if required.

Remove the tests from disk and ecflow

After successful runs and assessment the tested cases can be cleaned from disks and ecflow with the standard tactus remove functionality

tactus remove /scratch/$USER/tactus/your_test_tag_\*/archive/config.toml --execute-removal -f

Read more about the remove command in the cleaning documentation section.

About the config files

The config file has a four main sections: general, case, modifs and ial. Here we explain the usage of each

General

The general section defines the selection of cases and possible compiler extensions. If tag is not set it’s taken from the used tactus branch or tag. In extra we can define extra config files to include.

[general]
  reference_date  = "-P1D"
  tag = "my_label_"
  extra = []
  selection = [
    "cy49t2_alaro",
    "cy49t2_alaro_target",
  ]

Leaving out the selection section will run all defined cases. Check with -l how it works. To test different compilers we can add the compiler section. Here we define the section as active, configurations patterns to exclude and possible extra config files.

[general.compiler.gnu_]
  active = true
  exclude = ["cy48t2", "cy46h"]
  extra = ["tactus/data/config_files/modifications/submission/atos_bologna_gnu.toml"]

In the configuration step the generation of new files are done in parallel. The maximum number of threads can be controlled by setting e.g.

[general]
  max_workers = 1

Case

Here we define the config settings per case.

  • base gives the config to start from

  • host defines the ecflow mirror dependency

  • extra is extra config files to add for this specific case

  • case.X.modifs.Y allows to modify abitrary config settings for this case only

[cases.cy49t2_alaro_eps]
  host = "alaro"
  base = "cy49t2_alaro"
  extra = [
    "tactus/data/config_files/include/eps/eps_7members.toml",
    "tactus/data/config_files/include/eps/alaro.toml",
  ]

[cases.cy49t2_alaro_eps.modifs.eps.general]
  members = "0:3"

Modifs

Here we define global modifications to the default config files. Works the same way as for the config modifications mentioned above.

[modifs.archiving.FDB.fdb.fpgrib_files]
  active = false

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
  exclude  = "(.*)" - regular expression which specifies which files not to delete. Leave empty to deactivate
  cleaning_delay = "P1D"
  cleaning_max_delay = "P2D"
  step = "PT6H"
  wipe = false - Removes everything under "path". Disables the meaning of include or exclude
  ecfs_prefix = None - Specifies path to ecfs if this is concerned

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/tactus/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/tactus/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.

Removal of a complete case

All files produced by a run case be removed by

tactus remove [--config-file CONFIG_FILE_WITH_CLEANING_SETTINGS.toml] YOUR_CONFIG_FILE[S].toml [--execute-removal] [-f]

What to actually remove is defined in tactus/data/config_files/include/remove.toml. The settings are the same as for the cleaning config apart from remove_from_scheduler which removes the suite from the scheduler. With the default remove_not_completed_suites=True the removal is only executed if the suite is actually completed. This check can be overrided by using -f on command line. The latter also forces data to be removed even if a suite does not exist. Without including --execute-removal one only gets a list of what would have been removed.

The following section was automatically generated running tactus doc config on 2026-06-18T08:54:29.

Config

Title: Config

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

+ general

No

object

-

General Section

- suite_control

No

object

-

Suite control

- clean_old_data

No

object

-

Cleaning old data

- system

No

object

-

System

- compile

No

object

-

Compilation configuration

- boundaries

No

object

-

Boundary Section

- collectlogs

No

object

-

CollectLogs Section

- perturbations

No

object

-

Perturbation Section

- pgd

No

object

-

Pgd Section

- fullpos

No

object

-

Fullpos Section

- troika

No

object

-

Troika

- include

No

object

-

Include Section

- gribmodify

No

object

-

Section for modify grib

- archiving

No

object

-

Archiving Section, defined in include/archiving.toml

- cleaning

No

object

-

CleaningSection

- creategrib

No

object

-

Creategrib Section, defined in include/creategrib.toml

- domain

No

object

-

Domain Section, defined in files under include/domains

- eps

No

object

-

EPS Members Configuration

- extractsqlite

No

object

-

Extract sqlite Section, defined in include/sqlite.toml

- fdb

No

object

-

FDB Section, defined in include/fdb.toml

- file_templates

No

object

-

File Templates, defined in include/file_templates.toml

- json2tab

No

object

-

json-2-tab Section, defined in include/json2tab.toml

- macros

No

object

-

Macros Section, defined in include/macros.toml

- mars

No

object

-

MARS settings, defined in include/mars_settings.toml

- platform

No

object

-

Platform Section, defined in files under include/platform_paths

- reference_checker

No

object

-

Reference Checker Configuration

- remove

No

object

-

RemoveSection

- scheduler

No

object

-

Scheduler Section, defined in files under include/scheduler

- submission

No

object

-

Submission Section, defined in files under include/submission

- vertical_levels

No

object

-

Vertical Levels, defined in files under include/vertica_levels

- additionalProperties

No

object

-

-

Required Property Config > general

Title: General Section

Type

object

Additional properties

Any type: allowed

Description: Model for the ‘general’ section.

Property

Pattern

Type

Definition

Title/Description

+ times

No

Combination

-

Time-Related Entries

- accept_static_namelists

No

boolean

-

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

No

string

-

Experiment name

- member_str

No

string

-

String identifier of a member in the ensemble

- member

No

integer

-

Member number of a member in the ensemble

- cnmexp

No

string

-

Experiment short name

- loglevel

No

enum (of string)

-

Logger output level

- e923_optional_sections

No

array of integer

-

Option to include/exclude part 5 and 6 of e923. Set to ‘[5,6]’ to retain traditional climate files.

- surfex

No

boolean

-

SURFEX switch

- keep_workdirs

No

boolean

-

Do not remove working directories

- csc

No

enum (of string)

-

CSC

- cycle

No

enum (of string)

-

IAL cycle

- famodel

No

string

-

faModelName for handling grib output settings. Needed to specify encodings of ensemble members as well as sub-hourly outputs. Do not replace default name.

- initfile

No

string

-

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

No

string

-

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

No

object

-

Namelist

- output_settings

No

object

-

Output Settings

- remove_sections

No

array

-

Sections to remove prior to config merge

- windfarm

No

boolean

-

Switch for enabeling wind farm parameterisation

- fullpos_windpower

No

boolean

-

Switch for enabeling wind power production in fullpos output. Normally no need to provide but wind power output via full pos is not supported in CY48.

- upd_sst_sic

No

boolean

-

Switch to update SST/SIC during forecast

- surfex_sea_ice

No

enum (of string)

-

Treatment of sea ice in surfex

Required Property Config > general > times

Title: Time-Related Entries

Type

combining

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- forecast_range

No

string

-

Forecast range

- start

No

Combination

-

Start time, given as a date-time string ‘YYYY-MM-DDTHH:mm:ssZ’ or duration, e.g. ‘-P1D’ for yesterday, which is relative to the current date at 00Z.

- end

No

Combination

-

End time if the run covers several cycles. Date time format or duration relative start.

- list

No

array of string

-

List of dates, placeholder for future needs.

- cycle_length

No

string

-

Cycle length defined as duration

- basetime

No

string

-

Initial date and time for the current task.

- validtime

No

string

-

Final date and time for the current task.

One of(Option)

item 0

item 1

Property Config > general > times > oneOf > item 0

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

item 1

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

Type

combining

Additional properties

Any type: allowed

Must not be

Type

object

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

Additional properties

Any type: allowed

Must not be

Type

combining

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

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

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

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

Additional properties

Any type: allowed

Must not be

Type

combining

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

Additional properties

Any type: allowed

The following properties are required
  • start

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

Type

object

Additional properties

Any type: allowed

The following properties are required
  • end

The following properties are required
  • list

Optional Property Config > general > times > forecast_range

Type

string

Format

duration

Description: Forecast range

Optional Property Config > general > times > start

Type

combining

Description: Start time, given as a date-time string ‘YYYY-MM-DDTHH:mm:ssZ’ or duration, e.g. ‘-P1D’ for yesterday, which is relative to the current date at 00Z.

One of(Option)

item 0

item 1

Property Config > general > times > start > oneOf > item 0

Type

object

Format

date-time

Additional properties

Any type: allowed

Property Config > general > times > start > oneOf > item 1

Type

object

Format

duration

Additional properties

Any type: allowed

Optional Property Config > general > times > end

Type

combining

Description: End time if the run covers several cycles. Date time format or duration relative start.

One of(Option)

item 0

item 1

Property Config > general > times > end > oneOf > item 0

Type

object

Format

date-time

Additional properties

Any type: allowed

Property Config > general > times > end > oneOf > item 1

Type

object

Format

duration

Additional properties

Any type: allowed

Optional Property Config > general > times > list

Type

array of string

Description: List of dates, placeholder for future needs.

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

Format

date-time

Optional Property Config > general > times > cycle_length

Type

string

Format

duration

Default

"PT3H"

Description: Cycle length defined as duration

Optional Property Config > general > times > basetime

Type

string

Format

date-time

Description: Initial date and time for the current task.

Optional Property Config > general > times > validtime

Type

string

Format

date-time

Description: Final date and time for the current task.

Optional Property Config > general > accept_static_namelists

Type

boolean

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.

Optional Property Config > general > case

Type

string

Default

"tactus_case"

Description: Experiment name

Restrictions

Must match regular expression

^[^0-9][^.]*$ Test

Optional Property Config > general > member_str

Type

string

Default

"mbr000"

Description: String identifier of a member in the ensemble

Restrictions

Must match regular expression

^mbr\d{3}$ Test

Optional Property Config > general > member

Type

integer

Default

0

Description: Member number of a member in the ensemble

Optional Property Config > general > cnmexp

Type

string

Default

"DEOD"

Description: Experiment short name

Restrictions

Min length

4

Max length

4

Optional Property Config > general > loglevel

Type

enum (of string)

Description: Logger output level

Must be one of:

  • “CRITICAL”

  • “ERROR”

  • “DEBUG”

  • “INFO”

  • “WARNING”

Optional Property Config > general > e923_optional_sections

Type

array of integer

Default

[]

Description: Option to include/exclude part 5 and 6 of e923. Set to ‘[5,6]’ to retain traditional climate files.

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

e923_optional_sections items

-

Config > general > e923_optional_sections > e923_optional_sections items

Type

integer

Optional Property Config > general > surfex

Type

boolean

Description: SURFEX switch

Optional Property Config > general > keep_workdirs

Type

boolean

Description: Do not remove working directories

Optional Property Config > general > csc

Type

enum (of string)

Default

"AROME"

Description: CSC

Must be one of:

  • “AROME”

  • “ALARO”

  • “HARMONIE_AROME”

Optional Property Config > general > cycle

Type

enum (of string)

Description: IAL cycle

Must be one of:

  • “CY50t2”

  • “CY49t2”

  • “CY48t3”

  • “CY46h1”

Optional Property Config > general > famodel

Type

string

Description: faModelName for handling grib output settings. Needed to specify encodings of ensemble members as well as sub-hourly outputs. Do not replace default name.

Optional Property Config > general > initfile

Type

string

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.

Optional Property Config > general > initfile_sfx

Type

string

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.

Optional Property Config > general > namelist

Title: Namelist

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- nrazts

No

string

-

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

- radiation_frequency

No

string

-

Time interval for radiation compitations in the model.

Optional Property Config > general > namelist > nrazts

Type

string

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

Optional Property Config > general > namelist > radiation_frequency

Type

string

Description: Time interval for radiation compitations in the model.

Optional Property Config > general > output_settings

Title: Output Settings

Type

object

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

Pattern

Type

Definition

Title/Description

- ddh_dl

No

Combination

-

-

- ddh_gl

No

Combination

-

-

- ddh_zo

No

Combination

-

-

- history

No

Combination

-

-

- surfex

No

Combination

-

-

- fullpos

No

Combination

-

-

Optional Property Config > general > output_settings > ddh_dl

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

item 1

item 2

Property Config > general > output_settings > ddh_dl > anyOf > item 0

Type

string

Restrictions

Max length

0

Property Config > general > output_settings > ddh_dl > anyOf > item 1

Type

string

Format

duration

Property Config > general > output_settings > ddh_dl > anyOf > item 2

Type

array

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 > ddh_dl > anyOf > item 2 > item 2 items

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

Property Config > general > output_settings > ddh_dl > anyOf > item 2 > item 2 items > anyOf > item 0

Type

string

Format

duration_slice

Optional Property Config > general > output_settings > ddh_gl

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

item 1

item 2

Property Config > general > output_settings > ddh_gl > anyOf > item 0

Type

string

Restrictions

Max length

0

Property Config > general > output_settings > ddh_gl > anyOf > item 1

Type

string

Format

duration

Property Config > general > output_settings > ddh_gl > anyOf > item 2

Type

array

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 > ddh_gl > anyOf > item 2 > item 2 items

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

Property Config > general > output_settings > ddh_gl > anyOf > item 2 > item 2 items > anyOf > item 0

Type

string

Format

duration_slice

Optional Property Config > general > output_settings > ddh_zo

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

item 1

item 2

Property Config > general > output_settings > ddh_zo > anyOf > item 0

Type

string

Restrictions

Max length

0

Property Config > general > output_settings > ddh_zo > anyOf > item 1

Type

string

Format

duration

Property Config > general > output_settings > ddh_zo > anyOf > item 2

Type

array

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 > ddh_zo > anyOf > item 2 > item 2 items

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

Property Config > general > output_settings > ddh_zo > anyOf > item 2 > item 2 items > anyOf > item 0

Type

string

Format

duration_slice

Optional Property Config > general > output_settings > history

Type

combining

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

Restrictions

Max length

0

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

Type

string

Format

duration

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

Type

array

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

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

Format

duration_slice

Optional Property Config > general > output_settings > surfex

Type

combining

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

Restrictions

Max length

0

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

Type

string

Format

duration

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

Type

array

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

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

Format

duration_slice

Optional Property Config > general > output_settings > fullpos

Type

combining

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

Restrictions

Max length

0

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

Type

string

Format

duration

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

Type

array

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

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

Format

duration_slice

Optional Property Config > general > remove_sections

Type

array

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

Optional Property Config > general > windfarm

Type

boolean

Default

false

Description: Switch for enabeling wind farm parameterisation

Optional Property Config > general > fullpos_windpower

Type

boolean

Default

true

Description: Switch for enabeling wind power production in fullpos output. Normally no need to provide but wind power output via full pos is not supported in CY48.

Optional Property Config > general > upd_sst_sic

Type

boolean

Default

false

Description: Switch to update SST/SIC during forecast

Optional Property Config > general > surfex_sea_ice

Type

enum (of string)

Default

"sice"

Description: Treatment of sea ice in surfex

Must be one of:

  • “sice”

  • “none”

Optional Property Config > suite_control

Title: Suite control

Type

object

Additional properties

Any type: allowed

Description: Suite control options

Property

Pattern

Type

Definition

Title/Description

- suite_definition

No

string

-

Suite definition to play in EcFlow

- compile

No

boolean

-

Compile IAL source code

- do_creategrib_static

No

boolean

-

Activate grib conversion for static files

- do_soil

No

boolean

-

Activate preparation of SOILGRID data as input for PGD

- do_pgd

No

boolean

-

Activate generation of a PGD file

- mode

No

enum (of string)

-

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

No

boolean

-

Activates the boundary interpolation

- do_interpolsstsic

No

boolean

-

Activates the SST & SIC boundary interpolation

- do_marsprep

No

boolean

-

Run marsprep or skip extraction

- do_extractsqlite

No

boolean

-

Activates extraction of selected points to SQLite files for verification.

- do_addcalculatedfields

No

boolean

-

Activates additional GRIB postprocessing

- do_mergesqlite

No

boolean

-

Activates merging of extracted sqlite files. Requires do_extractsqlite to be true, and number of ensemble members to be greater than 1, to have an effect.

- create_static_data

No

boolean

-

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

- create_time_dependent_suite

No

boolean

-

Activate the time dependent part of the suite

- split_mars

No

boolean

-

Do marsprep only for one step before c903

- do_cleaning

No

boolean

-

Do file cleaning

- n_io_merge

No

integer

-

Number of IOmerge tasks

- n_creategrib

No

integer

-

Number of CreateGrib tasks

- n_addcalculatedfields

No

integer

-

Number of AddCalculatedFields tasks

- member_specific_static_data

No

boolean

-

Whether to create member specific static data (true) or not

- member_specific_mars_prep

No

boolean

-

Whether to do member specific marsprep (true) or common marsprep

- mirror_globalDT

No

boolean

-

Mirror globalDT suite (true) and trigger if globalDT is available

- mirror_host_case

No

boolean

-

Mirror a host suite and trigger if available.

- mirror_offline

No

boolean

-

Mirror offlineSFX suite and trigger if offline is available

- mirror_suite

No

boolean

-

Mirror system.host_suite and trigger when the PostMortem task is completed

- max_static_data_tasks

No

integer

-

Limit for max number of monthly tasks, run at same time

Optional Property Config > suite_control > suite_definition

Type

string

Default

"TactusSuiteDefinition"

Description: Suite definition to play in EcFlow

Optional Property Config > suite_control > compile

Type

boolean

Default

false

Description: Compile IAL source code

Optional Property Config > suite_control > do_creategrib_static

Type

boolean

Default

false

Description: Activate grib conversion for static files

Optional Property Config > suite_control > do_soil

Type

boolean

Description: Activate preparation of SOILGRID data as input for PGD

Optional Property Config > suite_control > do_pgd

Type

boolean

Description: Activate generation of a PGD file

Optional Property Config > suite_control > mode

Type

enum (of string)

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”

Optional Property Config > suite_control > interpolate_boundaries

Type

boolean

Description: Activates the boundary interpolation

Optional Property Config > suite_control > do_interpolsstsic

Type

boolean

Description: Activates the SST & SIC boundary interpolation

Optional Property Config > suite_control > do_marsprep

Type

boolean

Description: Run marsprep or skip extraction

Optional Property Config > suite_control > do_extractsqlite

Type

boolean

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

Optional Property Config > suite_control > do_addcalculatedfields

Type

boolean

Description: Activates additional GRIB postprocessing

Optional Property Config > suite_control > do_mergesqlite

Type

boolean

Description: Activates merging of extracted sqlite files. Requires do_extractsqlite to be true, and number of ensemble members to be greater than 1, to have an effect.

Optional Property Config > suite_control > create_static_data

Type

boolean

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

Optional Property Config > suite_control > create_time_dependent_suite

Type

boolean

Description: Activate the time dependent part of the suite

Optional Property Config > suite_control > split_mars

Type

boolean

Default

false

Description: Do marsprep only for one step before c903

Optional Property Config > suite_control > do_cleaning

Type

boolean

Default

false

Description: Do file cleaning

Optional Property Config > suite_control > n_io_merge

Type

integer

Default

1

Description: Number of IOmerge tasks

Optional Property Config > suite_control > n_creategrib

Type

integer

Default

1

Description: Number of CreateGrib tasks

Optional Property Config > suite_control > n_addcalculatedfields

Type

integer

Default

1

Description: Number of AddCalculatedFields tasks

Optional Property Config > suite_control > member_specific_static_data

Type

boolean

Default

false

Description: Whether to create member specific static data (true) or not

Optional Property Config > suite_control > member_specific_mars_prep

Type

boolean

Default

false

Description: Whether to do member specific marsprep (true) or common marsprep

Optional Property Config > suite_control > mirror_globalDT

Type

boolean

Default

false

Description: Mirror globalDT suite (true) and trigger if globalDT is available

Optional Property Config > suite_control > mirror_host_case

Type

boolean

Default

false

Description: Mirror a host suite and trigger if available.

Optional Property Config > suite_control > mirror_offline

Type

boolean

Default

false

Description: Mirror offlineSFX suite and trigger if offline is available

Optional Property Config > suite_control > mirror_suite

Type

boolean

Default

false

Description: Mirror system.host_suite and trigger when the PostMortem task is completed

Optional Property Config > suite_control > max_static_data_tasks

Type

integer

Default

10

Description: Limit for max number of monthly tasks, run at same time

Optional Property Config > clean_old_data

Title: Cleaning old data

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- cases_period

No

string

-

Age for old cases in days

- ignore

No

array

-

-

- scratch_ext

No

string

-

-

- force_delete_period

No

string

-

-

- dw_case_prefixes

No

array

-

-

Optional Property Config > clean_old_data > cases_period

Type

string

Default

"P7D"

Description: Age for old cases in days

Restrictions

Must match regular expression

^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?$ Test

Optional Property Config > clean_old_data > ignore

Type

array

Default

[]

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > clean_old_data > scratch_ext

Type

string

Default

"tactus"

Optional Property Config > clean_old_data > force_delete_period

Type

string

Default

"P365D"

Restrictions

Must match regular expression

^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?$ Test

Optional Property Config > clean_old_data > dw_case_prefixes

Type

array

Default

["AUTOMATED_RUN", "HARMONIE_AROME", "AROME", "ALARO"]

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > system

Title: System

Type

object

Additional properties

Any type: allowed

Description: TACTUS system specific path settings

Property

Pattern

Type

Definition

Title/Description

- forecast_dir_link

No

string

-

Name of the softlink pointing to the Forecast task work directory

- bdfile_sfx_template

No

string

-

Name template for input initial surfex file for prep

- bdfile_sst_template

No

string

-

Name template for input SST & SIC files of the host model

- bdfile_template

No

string

-

Name template for input boundary files

- sstfile_template

No

string

-

Name template for SST & SIC input boundary files interpolated to the model grid (currently hard-coded in model code)

- bddir_sfx

No

string

-

Location of input intial file for surfex

- bddir

No

string

-

Location of input boundaries from e.g. MARS

- intp_bddir

No

string

-

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

- intp_bddir_sfx

No

string

-

Location of the inital surfex file for the current domain, i.e. the output directory of Prep

- climdir

No

string

-

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

- bindir

No

string

-

Location of binaries

- bdclimdir

No

string

-

Location of host model climate files used for e927/c903

- wrk

No

string

-

Location of date specific working directory

- fullpos_config_file

No

string

-

Path to the fullpos yml config file

- archive_timestamp

No

string

-

Relative path of date specific archive

- archive

No

string

-

Absolute path of date specific archive

- logs

No

string

-

Location of collected logfiles

- namelists

No

string

-

Path to static namelists

- global_sfcdir

No

string

-

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

- prev_case

No

string

-

Name of the previous experiment

- sfx_input_definition

No

string

-

Path to the surfex json config file

- forecast_input_definition

No

string

-

Path to the forecast json config file

- c903_input_definition

No

string

-

Path to the c903 json config file

- e923_input_definition

No

string

-

Path to the e923 json config file

- e927_input_definition

No

string

-

Path to the e927 json config file

- sys_name

No

string

-

System/package name (typically matching PACKAGE_NAME) used when resolving paths.

Optional Property Config > system > bdfile_sfx_template

Type

string

Description: Name template for input initial surfex file for prep

Optional Property Config > system > bdfile_sst_template

Type

string

Description: Name template for input SST & SIC files of the host model

Optional Property Config > system > bdfile_template

Type

string

Description: Name template for input boundary files

Optional Property Config > system > sstfile_template

Type

string

Description: Name template for SST & SIC input boundary files interpolated to the model grid (currently hard-coded in model code)

Optional Property Config > system > bddir_sfx

Type

string

Description: Location of input intial file for surfex

Optional Property Config > system > bddir

Type

string

Description: Location of input boundaries from e.g. MARS

Optional Property Config > system > intp_bddir

Type

string

Default

"@WRK@"

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

Optional Property Config > system > intp_bddir_sfx

Type

string

Default

"@ARCHIVE@"

Description: Location of the inital surfex file for the current domain, i.e. the output directory of Prep

Optional Property Config > system > climdir

Type

string

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

Optional Property Config > system > bindir

Type

string

Description: Location of binaries

Optional Property Config > system > bdclimdir

Type

string

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

Optional Property Config > system > wrk

Type

string

Default

"@CASEDIR@/@YYYY@@MM@@DD@_@HH@@mm@"

Description: Location of date specific working directory

Optional Property Config > system > fullpos_config_file

Type

string

Description: Path to the fullpos yml config file

Optional Property Config > system > archive_timestamp

Type

string

Default

"@YYYY@/@MM@/@DD@/@HH@/"

Description: Relative path of date specific archive

Optional Property Config > system > archive

Type

string

Default

"@ARCHIVE_ROOT@/@ARCHIVE_TIMESTAMP@/@MEMBER_STR@"

Description: Absolute path of date specific archive

Optional Property Config > system > logs

Type

string

Description: Location of collected logfiles

Optional Property Config > system > namelists

Type

string

Default

"@TACTUS_HOME@/data/namelists/@CYCLE@"

Description: Path to static namelists

Optional Property Config > system > global_sfcdir

Type

string

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

Optional Property Config > system > prev_case

Type

string

Default

"@CASE@"

Description: Name of the previous experiment

Optional Property Config > system > sfx_input_definition

Type

string

Default

"@CYCLE@/sfx.json"

Description: Path to the surfex json config file

Optional Property Config > system > forecast_input_definition

Type

string

Default

"@CYCLE@/forecast.json"

Description: Path to the forecast json config file

Optional Property Config > system > c903_input_definition

Type

string

Default

"@CYCLE@/c903.json"

Description: Path to the c903 json config file

Optional Property Config > system > e923_input_definition

Type

string

Default

"@CYCLE@/e923.json"

Description: Path to the e923 json config file

Optional Property Config > system > e927_input_definition

Type

string

Default

"@CYCLE@/e927.json"

Description: Path to the e927 json config file

Optional Property Config > system > sys_name

Type

string

Default

"tactus"

Description: System/package name (typically matching PACKAGE_NAME) used when resolving paths.

Optional Property Config > compile

Title: Compilation configuration

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- ial_dir

No

string

-

Local path to IAL source dir

- ial_git_repo

No

string

-

Git repo for IAL source

- git_token

No

string

-

Git token for IAL source access

- ial_git_branch

No

string

-

Branch/tag

- arch

No

string

-

Compiler configuration

- dir

No

string

-

Directory where compilation will occur

- bundle_update

No

boolean

-

whether to update bundle_file with another bundle

- update_bundle_file

No

string

-

bundle used for compiling binaries

- bundle_file

No

string

-

bundle used for compiling binaries

- ninja

No

boolean

-

whether to use ninja for compilation

- skip_build

No

boolean

-

whether to skip build step

- clean_build

No

boolean

-

whether to clean build folder before compilation

- cache

No

boolean

-

whether to use chache build/install folders

- cache_dir

No

string

-

whether to use chache build/install folders

Optional Property Config > compile > ial_dir

Type

string

Default

"@CASEDIR@/IAL"

Description: Local path to IAL source dir

Optional Property Config > compile > ial_git_repo

Type

string

Default

"git@github.com:ACCORD-NWP/IAL"

Description: Git repo for IAL source

Optional Property Config > compile > git_token

Type

string

Default

""

Description: Git token for IAL source access

Optional Property Config > compile > ial_git_branch

Type

string

Default

"develop"

Description: Branch/tag

Optional Property Config > compile > arch

Type

string

Default

"source/ial-source/bundle/arch/ecmwf/hpc2020"

Description: Compiler configuration

Optional Property Config > compile > dir

Type

string

Default

"@CASEDIR@/bundle"

Description: Directory where compilation will occur

Optional Property Config > compile > bundle_update

Type

boolean

Default

true

Description: whether to update bundle_file with another bundle

Optional Property Config > compile > update_bundle_file

Type

string

Default

"@TACTUS_HOME@/data/compilation/@CYCLE@/bundle.yml"

Description: bundle used for compiling binaries

Optional Property Config > compile > bundle_file

Type

string

Default

"@CASEDIR@/IAL/bundle/bundle.yml"

Description: bundle used for compiling binaries

Optional Property Config > compile > ninja

Type

boolean

Default

false

Description: whether to use ninja for compilation

Optional Property Config > compile > skip_build

Type

boolean

Default

false

Description: whether to skip build step

Optional Property Config > compile > clean_build

Type

boolean

Default

false

Description: whether to clean build folder before compilation

Optional Property Config > compile > cache

Type

boolean

Default

false

Description: whether to use chache build/install folders

Optional Property Config > compile > cache_dir

Type

string

Default

"@REFERENCE_DATA@/bundle_cache"

Description: whether to use chache build/install folders

Optional Property Config > boundaries

Title: Boundary Section

Type

object

Additional properties

Any type: allowed

Description: Settings for control of boundary treatment.

Property

Pattern

Type

Definition

Title/Description

- bdint

No

string

-

Boundary interval

- bdshift

No

string

-

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

- bdshift_sfx

No

string

-

Shift of SURFEX prep input initial time. E.g. ‘PT24H’ would mean use 24H old file

- lbc_per_task

No

number

-

Number of LBCs processed in a single task

- max_interpolation_tasks

No

number

-

Number of interpolate tasks run in parallel

- bdmodel

No

enum (of string)

-

Coupling model

- bdmodel_sfx

No

enum (of string)

-

SURFEX prep input file

- sstmodels

No

array of enum (of string)

-

Coupling model for SST & SIC

- sst_is_lsm

No

enum (of string)

-

Switch for using SST as LSM

- humi_gp

No

boolean

-

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

- lam

No

object

-

LAM related boundary settings

- ifs

No

object

-

IFS related settings

- bd_has_surfex

No

boolean

-

Set to true if the host model runs with surfex

- do_slaf

No

boolean

-

Set to true if using the SLAF scheme for ensemble member boundary files

- slaflag

No

string

-

SLAF shift of boundary initial time. E.g. ‘PT3H’ would mean use 3H old(er) boundaries

- slafdiff

No

string

-

SLAF difference of boundary initial times. E.g. ‘PT6H’ would mean a 6H difference

- slafk

No

number

-

SLAF difference scaling factor

Optional Property Config > boundaries > bdint

Type

string

Format

duration

Description: Boundary interval

Optional Property Config > boundaries > bdshift

Type

string

Format

duration

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

Optional Property Config > boundaries > bdshift_sfx

Type

string

Format

duration

Description: Shift of SURFEX prep input initial time. E.g. ‘PT24H’ would mean use 24H old file

Optional Property Config > boundaries > lbc_per_task

Type

number

Default

7

Description: Number of LBCs processed in a single task

Optional Property Config > boundaries > max_interpolation_tasks

Type

number

Description: Number of interpolate tasks run in parallel

Optional Property Config > boundaries > bdmodel

Type

enum (of string)

Default

"ifs"

Description: Coupling model

Must be one of:

  • “lam”

  • “ifs”

Optional Property Config > boundaries > bdmodel_sfx

Type

enum (of string)

Default

"from_grib"

Description: SURFEX prep input file

Must be one of:

  • “from_grib”

  • “from_fa”

  • “from_nc”

Optional Property Config > boundaries > sstmodels

Type

array of enum (of string)

Description: Coupling model for SST & SIC

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

sstmodels items

-

Config > boundaries > sstmodels > sstmodels items

Type

enum (of string)

Must be one of:

  • “IFS”

Optional Property Config > boundaries > sst_is_lsm

Type

enum (of string)

Default

"auto"

Description: Switch for using SST as LSM

Must be one of:

  • “lsm”

  • “sst”

  • “auto”

Optional Property Config > boundaries > humi_gp

Type

boolean

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

Optional Property Config > boundaries > lam

Title: LAM related boundary settings

Type

object

Additional properties

Any type: allowed

Description: LAM related boundary settings

Property

Pattern

Type

Definition

Title/Description

- bdcycle_start

No

string

-

lam boundary model cycle start hour

- bdcycle

No

string

-

lam boundary model cycle interval

Optional Property Config > boundaries > lam > bdcycle_start

Type

string

Default

"PT0H"

Description: lam boundary model cycle start hour

Restrictions

Must match regular expression

^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$ Test

Optional Property Config > boundaries > lam > bdcycle

Type

string

Default

"PT24H"

Description: lam 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

Optional Property Config > boundaries > ifs

Title: IFS related settings

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- selection

No

enum (of string)

-

Selection

- bdmember

No

Combination

-

Specification of boundary members to nest in if selection is IFS. The order of bdmembers determines which member uses what bdmember. The bdmembers can be specified as integer, string slice or a list of integers. String slices have to be in the format ‘start:end[:step]’. Use empty list for no bdmembers.

Optional Property Config > boundaries > ifs > selection

Type

enum (of string)

Description: Selection

Must be one of:

  • “atos_bologna_DT”

  • “lumi_DT”

  • “ATOS_DT”

  • “HRES”

  • “@HOST@_DT”

  • “DT12”

  • “i5qp”

  • “i7u4”

  • “i7ye”

  • “i8hy”

  • “IFSENS”

  • “iit7”

  • “ilv7”

  • “is6g”

  • “irok”

  • “iyzp”

Optional Property Config > boundaries > ifs > bdmember

Type

combining

Additional properties

Any type: allowed

Default

[]

Description: Specification of boundary members to nest in if selection is IFS. The order of bdmembers determines which member uses what bdmember. The bdmembers can be specified as integer, string slice or a list of integers. String slices have to be in the format ‘start:end[:step]’. Use empty list for no bdmembers.

Any of(Option)

item 0

item 1

item 2

Property Config > boundaries > ifs > bdmember > anyOf > item 0

Type

integer

Property Config > boundaries > ifs > bdmember > anyOf > item 1

Type

string

Property Config > boundaries > ifs > bdmember > anyOf > item 2

Type

array

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > boundaries > bd_has_surfex

Type

boolean

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

Optional Property Config > boundaries > do_slaf

Type

boolean

Description: Set to true if using the SLAF scheme for ensemble member boundary files

Optional Property Config > boundaries > slaflag

Type

string

Format

duration

Description: SLAF shift of boundary initial time. E.g. ‘PT3H’ would mean use 3H old(er) boundaries

Optional Property Config > boundaries > slafdiff

Type

string

Format

duration

Description: SLAF difference of boundary initial times. E.g. ‘PT6H’ would mean a 6H difference

Optional Property Config > boundaries > slafk

Type

number

Description: SLAF difference scaling factor

Optional Property Config > collectlogs

Title: CollectLogs Section

Type

object

Additional properties

Any type: allowed

Description: Settings for control of log collection.

Property

Pattern

Type

Definition

Title/Description

- staticlogs

No

object

-

Collection settings for static tasks

- hourlogs

No

object

-

Collection settings for time dependent tasks

Optional Property Config > collectlogs > staticlogs

Type

object

Additional properties

Any type: allowed

Description: Collection settings for static tasks

Property

Pattern

Type

Definition

Title/Description

- joboutdir

No

string

-

Top output dir to collect logs from

- tarname

No

string

-

Name of the resulting tar file

- task_logs

No

string

-

Search path for task specific logs

Optional Property Config > collectlogs > staticlogs > joboutdir

Type

string

Description: Top output dir to collect logs from

Optional Property Config > collectlogs > staticlogs > tarname

Type

string

Description: Name of the resulting tar file

Optional Property Config > collectlogs > staticlogs > task_logs

Type

string

Description: Search path for task specific logs

Optional Property Config > collectlogs > hourlogs

Type

object

Additional properties

Any type: allowed

Description: Collection settings for time dependent tasks

Property

Pattern

Type

Definition

Title/Description

- joboutdir

No

string

-

Top output dir to collect logs from

- tarname

No

string

-

Name of the resulting tar file

- task_logs

No

string

-

Search path for task specific logs

Optional Property Config > collectlogs > hourlogs > joboutdir

Type

string

Description: Top output dir to collect logs from

Optional Property Config > collectlogs > hourlogs > tarname

Type

string

Description: Name of the resulting tar file

Optional Property Config > collectlogs > hourlogs > task_logs

Type

string

Description: Search path for task specific logs

Optional Property Config > perturbations

Title: Perturbation Section

Type

object

Additional properties

Any type: allowed

Description: Settings for control of perturbations.

Property

Pattern

Type

Definition

Title/Description

- pertana

No

boolean

-

Perturbation of initial atmospheric conditions with boundary data.

- pertsurf

No

boolean

-

Perturbation of initial surfex conditions

Optional Property Config > perturbations > pertana

Title: Perturbation of initial atmospheric conditions with boundary data.

Type

boolean

Default

false

Optional Property Config > perturbations > pertsurf

Title: Perturbation of initial surfex conditions

Type

boolean

Default

false

Optional Property Config > pgd

Title: Pgd Section

Type

object

Additional properties

Any type: allowed

Description: Settings for control of Pgd selection.

Property

Pattern

Type

Definition

Title/Description

- npatch

No

integer

-

Number of patches for surfex variables

- one_decade

No

boolean

-

Option for using one decade

- use_osm

No

boolean

-

Option to use Open Street map input data

Optional Property Config > pgd > npatch

Title: Number of patches for surfex variables

Type

integer

Default

3

Optional Property Config > pgd > one_decade

Title: Option for using one decade

Type

boolean

Default

true

Optional Property Config > pgd > use_osm

Title: Option to use Open Street map input data

Type

boolean

Default

false

Optional Property Config > fullpos

Title: Fullpos Section

Type

object

Additional properties

Any type: allowed

Description: Settings for control of fullpos selection.

Property

Pattern

Type

Definition

Title/Description

- config_path

No

string

-

Path to fullpos config files

- main

No

array of string

-

List of mandatory rules

- selection

No

object

-

List of selections to include

- domain_name

No

string

-

Name of your domain as used by fullpos

Optional Property Config > fullpos > config_path

Title: Path to fullpos config files

Type

string

Default

"@TACTUS_HOME@/data/namelist_generation_input/@CYCLE@/fullpos"

Optional Property Config > fullpos > main

Type

array of string

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

Optional Property Config > fullpos > selection

Type

object

Additional properties

Should-conform

Description: List of selections to include

Property

Pattern

Type

Definition

Title/Description

- fullpos_selection_additionalProperties

No

array of string

-

-

Property Config > fullpos > selection > additionalProperties

Type

array of string

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

Optional Property Config > fullpos > domain_name

Type

string

Default

"DOMAIN"

Description: Name of your domain as used by fullpos

Restrictions

Max length

20

Optional Property Config > troika

Title: Troika

Type

object

Additional properties

Any type: allowed

Description: TACTUS system specific path settings

Property

Pattern

Type

Definition

Title/Description

- config_file

No

string

-

Troika config file

- troika

No

string

-

Troika command, allows to specify troika with full path

Optional Property Config > troika > config_file

Type

string

Default

"@TACTUS_HOME@/data/config_files/troika.yml"

Description: Troika config file

Optional Property Config > troika > troika

Type

string

Default

"troika"

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

Optional Property Config > include

Title: Include Section

Type

object

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.

Optional Property Config > gribmodify

Title: Section for modify grib

Type

object

Additional properties

Any type: allowed

Description: Rules for modifications to be made to the grib output

Property

Pattern

Type

Definition

Title/Description

- conversions

No

array

-

List of file types to be converted

- gribmodify_rules_file

No

string

-

File specifying the gribmodify rules for the specified conversions

- fullpos.1

No

object

-

Total rain

- fullpos.2

No

object

-

Total snow

- fullpos.3

No

object

-

Total precpipation

- fullpos.4

No

object

-

10m wind speed

- fullpos.5

No

object

-

100m wind speed

- fullpos.6

No

object

-

10m gust wind speed

- fullpos.7

No

object

-

2m dewpoint temperature

- surfex.1

No

object

-

Leaf area index

- surfex.2

No

object

-

Albedo

- surfex.3

No

object

-

Top 20 cm average soil moisture

- surfex.4

No

object

-

Top 100 cm average soil moisture

- surfex.5

No

object

-

Top 20 cm average soil temperature

- surfex.6

No

object

-

Top 100 cm soil temperature

- surfex.7

No

object

-

Root depth soil moisture

- surfex.8

No

object

-

Canopy water

Optional Property Config > gribmodify > conversions

Type

array

Default

[]

Description: List of file types to be converted

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > gribmodify > gribmodify_rules_file

Type

string

Description: File specifying the gribmodify rules for the specified conversions

Optional Property Config > gribmodify > fullpos.1

Title: Total rain

Type

object

Additional properties

Any type: allowed

Description: Calculates total rain from components

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.1 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.1 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.1 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.1 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > fullpos.2

Title: Total snow

Type

object

Additional properties

Any type: allowed

Description: Calculates total snow from components

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.2 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.2 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.2 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.2 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > fullpos.3

Title: Total precpipation

Type

object

Additional properties

Any type: allowed

Description: Calculates total precipitation from components

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.3 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.3 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.3 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.3 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > fullpos.4

Title: 10m wind speed

Type

object

Additional properties

Any type: allowed

Description: Calculates 10m wind speed

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.4 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.4 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.4 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.4 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > fullpos.5

Title: 100m wind speed

Type

object

Additional properties

Any type: allowed

Description: Calculates 100m wind speed

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.5 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.5 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.5 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.5 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > fullpos.6

Title: 10m gust wind speed

Type

object

Additional properties

Any type: allowed

Description: Calculates 10m gust wind speed

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.6 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.6 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.6 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.6 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > fullpos.7

Title: 2m dewpoint temperature

Type

object

Additional properties

Any type: allowed

Description: Calculates 2m temperature based on Lawrence 2005, BAMS, doi: 10.1175/BAMS-86-2-225

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > fullpos.7 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > fullpos.7 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > fullpos.7 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > fullpos.7 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.1

Title: Leaf area index

Type

object

Additional properties

Any type: allowed

Description: Calculates nature-weighted leaf area index

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.1 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.1 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.1 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.1 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.2

Title: Albedo

Type

object

Additional properties

Any type: allowed

Description: Calculates albedo

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.2 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.2 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.2 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.2 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.3

Title: Top 20 cm average soil moisture

Type

object

Additional properties

Any type: allowed

Description: Calculates the nature-weighted patch-averaged soil moisture in the top 20 cm

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.3 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.3 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.3 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.3 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.4

Title: Top 100 cm average soil moisture

Type

object

Additional properties

Any type: allowed

Description: Calculates the nature-weighted patch-averaged soil moisture in the top 100 cm

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.4 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.4 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.4 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.4 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.5

Title: Top 20 cm average soil temperature

Type

object

Additional properties

Any type: allowed

Description: Calculates the patch-averaged soil temperature in the top 20 cm

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.5 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.5 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.5 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.5 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.6

Title: Top 100 cm soil temperature

Type

object

Additional properties

Any type: allowed

Description: Calculates the patch-averaged soil temperature in the top 100 cm

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.6 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.6 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.6 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.6 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.7

Title: Root depth soil moisture

Type

object

Additional properties

Any type: allowed

Description: Calculates root depth soil moisture

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.7 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.7 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.7 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.7 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > gribmodify > surfex.8

Title: Canopy water

Type

object

Additional properties

Any type: allowed

Description: Calculates the patch-averaged canopy water

Property

Pattern

Type

Definition

Title/Description

- csc_specific

No

array of string

-

CSC specific selection

- output_name

No

string

-

Output parameter name

- minumum_frequency

No

object

-

Minimum frequency

Optional Property Config > gribmodify > surfex.8 > csc_specific

Title: CSC specific selection

Type

array of string

Description: The CSCs for which the specified conversion should happen.

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

csc_specific items

-

Config > gribmodify > surfex.8 > csc_specific > csc_specific items

Type

string

Optional Property Config > gribmodify > surfex.8 > output_name

Title: Output parameter name

Type

string

Description: Chosen name of output parameter.

Optional Property Config > gribmodify > surfex.8 > minumum_frequency

Title: Minimum frequency

Type

object

Format

duration

Additional properties

Any type: allowed

Description: Minimum output frequency expected

Optional Property Config > archiving

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

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- prefix

No

object

-

Path prefixes

- hour

No

object

-

Example settings for the ‘ArchiveHour task

- archiving_additionalProperties

No

object

-

-

Optional Property Config > archiving > prefix

Title: Path prefixes

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- archive_type

No

string

-

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

Optional Property Config > archiving > prefix > archive_type

Type

string

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

Optional Property Config > archiving > hour

Title: Example settings for the ‘ArchiveHour task

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- example

No

object

-

Example settings for the archiving rules. Any number of rules can be defined to accomodate the needs

Optional Property Config > archiving > hour > example

Title: Example settings for the archiving rules. Any number of rules can be defined to accomodate the needs

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- active

No

boolean

-

Activates the default archiving. Could be boolean or string refering to a boolean in the config file. See the sqlite archiving for an example

- inpath

No

string

-

Location of input files for archiving

- outpath

No

string

-

Relative location of the archived files

- pattern

No

Combination

-

Search pattern for files to be included. Could be a single pattern or list of patterns.

- newname

No

string

-

Target name for renaming of files. Only works is pattern is a string and matches an existing file

- tarname

No

string

-

Tar file name in case of compress method.

Optional Property Config > archiving > hour > example > active

Type

boolean

Description: Activates the default archiving. Could be boolean or string refering to a boolean in the config file. See the sqlite archiving for an example

Optional Property Config > archiving > hour > example > inpath

Type

string

Description: Location of input files for archiving

Optional Property Config > archiving > hour > example > outpath

Type

string

Description: Relative location of the archived files

Optional Property Config > archiving > hour > example > pattern

Type

combining

Additional properties

Any type: allowed

Description: Search pattern for files to be included. Could be a single pattern or list of patterns.

Any of(Option)

item 0

item 1

Property Config > archiving > hour > example > pattern > anyOf > item 0

Type

string

Property Config > archiving > hour > example > pattern > anyOf > item 1

Type

array of string

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 1 items

-

Config > archiving > hour > example > pattern > anyOf > item 1 > item 1 items

Type

string

Optional Property Config > archiving > hour > example > newname

Type

string

Description: Target name for renaming of files. Only works is pattern is a string and matches an existing file

Optional Property Config > archiving > hour > example > tarname

Type

string

Description: Tar file name in case of compress method.

Optional Property Config > cleaning

Title: CleaningSection

Type

object

Additional properties

Any type: allowed

Description: Model for validation of the cleaning configuration.

Property

Pattern

Type

Definition

Title/Description

+ defaults

No

Combination

-

-

- Cleaning_example

No

object

-

-

- cleaning_additionalProperties

No

object

-

-

Required Property Config > cleaning > defaults

Type

combining

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- include

No

string

-

regular expression according to it which files to clean

- ncycles_delay

No

number

-

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

- cleaning_delay

No

string

-

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

No

string

-

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

- step

No

string

-

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

- active

No

boolean

-

Activate cleaning files

- dry_run

No

boolean

-

test cleaning without to delete files

- path

No

string

-

Path to clean

- wipe

No

boolean

-

Flag for cleaning everything in a path

One of(Option)

item 0

item 1

Property Config > cleaning > defaults > oneOf > item 0

Type

object

Additional properties

Any type: allowed

The following properties are required
  • include

  • ncycles_delay

  • active

Property Config > cleaning > defaults > oneOf > item 1

Type

object

Additional properties

Any type: allowed

The following properties are required
  • include

  • cleaning_delay

  • cleaning_max_delay

  • active

Optional Property Config > cleaning > defaults > include

Type

string

Description: regular expression according to it which files to clean

Optional Property Config > cleaning > defaults > ncycles_delay

Type

number

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

Optional Property Config > cleaning > defaults > cleaning_delay

Type

string

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.

Optional Property Config > cleaning > defaults > cleaning_max_delay

Type

string

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.

Optional Property Config > cleaning > defaults > step

Type

string

Format

duration

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

Optional Property Config > cleaning > defaults > active

Type

boolean

Description: Activate cleaning files

Optional Property Config > cleaning > defaults > dry_run

Type

boolean

Description: test cleaning without to delete files

Optional Property Config > cleaning > defaults > path

Type

string

Default

""

Description: Path to clean

Optional Property Config > cleaning > defaults > wipe

Type

boolean

Default

false

Description: Flag for cleaning everything in a path

Optional Property Config > cleaning > Cleaning_example

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

+ path

No

string

-

path to the folder where files will be cleaned

- include

No

string

-

regular expression for files to select for cleaning

- exclude

No

string

-

regular expression for files to explicitly exclude from cleaning

- ncycles_delay

No

number

-

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

- cleaning_delay

No

string

-

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

No

string

-

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

- step

No

string

-

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

- active

No

boolean

-

Activate cleaning files

- dry_run

No

boolean

-

test cleaning without to delete files

Required Property Config > cleaning > Cleaning_example > path

Type

string

Description: path to the folder where files will be cleaned

Optional Property Config > cleaning > Cleaning_example > include

Type

string

Default

"(.*)"

Description: regular expression for files to select for cleaning

Optional Property Config > cleaning > Cleaning_example > exclude

Type

string

Description: regular expression for files to explicitly exclude from cleaning

Optional Property Config > cleaning > Cleaning_example > ncycles_delay

Type

number

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

Optional Property Config > cleaning > Cleaning_example > cleaning_delay

Type

string

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.

Optional Property Config > cleaning > Cleaning_example > cleaning_max_delay

Type

string

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.

Optional Property Config > cleaning > Cleaning_example > step

Type

string

Format

duration

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

Optional Property Config > cleaning > Cleaning_example > active

Type

boolean

Description: Activate cleaning files

Optional Property Config > cleaning > Cleaning_example > dry_run

Type

boolean

Description: test cleaning without to delete files

Optional Property Config > creategrib

Title: Creategrib Section, defined in include/creategrib.toml

Type

object

Additional properties

Any type: allowed

Description: Settings for grib conversions with gl

Property

Pattern

Type

Definition

Title/Description

- CreateGrib

No

object

-

CreateGrib definitions

- CreateGribStatic

No

object

-

CreateGribStatic definitions

- creategrib_additionalProperties

No

object

-

-

Optional Property Config > creategrib > CreateGrib

Title: CreateGrib definitions

Type

object

Additional properties

Any type: allowed

Description: Definitions for grib conversion of time dependent data

Property

Pattern

Type

Definition

Title/Description

- conversions

No

array

-

List of file types to be converted

- surfex

No

object

-

Rules for surfex files

- history

No

object

-

Rules for history files

- tiles

No

object

-

Rules for files output on tiles

Optional Property Config > creategrib > CreateGrib > conversions

Type

array

Default

[]

Description: List of file types to be converted

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > creategrib > CreateGrib > surfex

Title: Rules for surfex files

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- namelist

No

array

-

List of namelist arguments

- output_format

No

string

-

Output format

Optional Property Config > creategrib > CreateGrib > surfex > namelist

Type

array

Default

[]

Description: List of namelist arguments

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > creategrib > CreateGrib > surfex > output_format

Type

string

Default

"FA2GRIB2"

Description: Output format

Optional Property Config > creategrib > CreateGrib > history

Title: Rules for history files

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- namelist

No

array

-

List of namelist arguments

- output_format

No

string

-

Output format

- basetime_only

No

boolean

-

Output only at basetime

Optional Property Config > creategrib > CreateGrib > history > namelist

Type

array

Description: List of namelist arguments

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > creategrib > CreateGrib > history > output_format

Type

string

Default

"FA2GRIB2"

Description: Output format

Optional Property Config > creategrib > CreateGrib > history > basetime_only

Type

boolean

Default

false

Description: Output only at basetime

Optional Property Config > creategrib > CreateGrib > tiles

Title: Rules for files output on tiles

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- output_frequency_reference

No

string

-

The variable for which the forecast output frequency is defined

- namelist

No

array

-

List of namelist arguments

- output_format

No

string

-

Output format

Optional Property Config > creategrib > CreateGrib > tiles > output_frequency_reference

Type

string

Description: The variable for which the forecast output frequency is defined

Optional Property Config > creategrib > CreateGrib > tiles > namelist

Type

array

Description: List of namelist arguments

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > creategrib > CreateGrib > tiles > output_format

Type

string

Default

"FA2GRIB2"

Description: Output format

Optional Property Config > creategrib > CreateGribStatic

Title: CreateGribStatic definitions

Type

object

Additional properties

Any type: allowed

Description: Definitions for grib conversion of static data

Property

Pattern

Type

Definition

Title/Description

- pgd

No

object

-

Rules for pgd files

Optional Property Config > creategrib > CreateGribStatic > pgd

Title: Rules for pgd files

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- files_in

No

array

-

List of input files

- files_out

No

array

-

List of input files

- output_format

No

string

-

Output format

- namelist

No

array

-

List of namelist arguments

Optional Property Config > creategrib > CreateGribStatic > pgd > files_in

Type

array

Default

[]

Description: List of input files

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > creategrib > CreateGribStatic > pgd > files_out

Type

array

Default

[]

Description: List of input files

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > creategrib > CreateGribStatic > pgd > output_format

Type

string

Default

"GRIB"

Description: Output format

Optional Property Config > creategrib > CreateGribStatic > pgd > namelist

Type

array

Default

[]

Description: List of namelist arguments

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > domain

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

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- gridtype

No

enum (of string)

-

Select truncation type

- gridtype_oro

No

enum (of string)

-

Select truncation type for orographic_smoothing

- orographic_smoothing_method

No

enum (of string)

-

Orographic smoothing method

- name

No

string

-

Name of your domain

- number

No

Combination

-

Sequence number for domain

- nzsfilter

No

enum (of integer)

-

Activate the PGD orographic filtering

- nimax

No

number

-

Number of grid points zonally

- njmax

No

number

-

Number of grid points meridionally

- xdx

No

number

-

Zonal grid size in meters

- xdy

No

number

-

Meridional grid size in meters

- ilone

No

number

-

Zonal extension zone

- ilate

No

number

-

Meridional extension zone

- nbzong

No

number

-

Meridional coupling zone width

- nbzonl

No

number

-

Zonal coupling zone width

- tstep

No

Combination

-

Model time step in seconds

- xloncen

No

number

-

Domain center longitude

- xlatcen

No

number

-

Domain center latitude

- xlon0

No

Combination

-

Longitude of center of projection

- xlat0

No

Combination

-

Latitude of center of projection

- xbeta

No

number

-

Rotation parameter for the conformal projection

- spectral_smoothing_by_gridtype

No

object

-

Defines for which gridypes spectral smoothing is applied when activated

- truncation_by_gridtype

No

object

-

Defines default gridtype_oro mapping when truncation smoothing is applied.

- dtf_lead_time

No

enum (of string)

-

Lead time of DTF, which trigger the domain

- domain_additionalProperties

No

object

-

-

Optional Property Config > domain > gridtype

Type

enum (of string)

Description: Select truncation type

Must be one of:

  • “linear”

  • “quadratic”

  • “cubic”

  • “custom”

Optional Property Config > domain > gridtype_oro

Type

enum (of string)

Default

""

Description: Select truncation type for orographic_smoothing

Must be one of:

  • “linear”

  • “quadratic”

  • “cubic”

  • “custom”

  • “”

Optional Property Config > domain > orographic_smoothing_method

Type

enum (of string)

Default

"truncation"

Description: Orographic smoothing method

Must be one of:

  • “spectral”

  • “truncation”

  • “nzsfilter”

  • “raw”

Optional Property Config > domain > name

Type

string

Description: Name of your domain

Optional Property Config > domain > number

Type

combining

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

Restrictions

Max length

0

Property Config > domain > number > oneOf > item 1

Type

number

Restrictions

Minimum

≥ 0

Optional Property Config > domain > nzsfilter

Type

enum (of integer)

Description: Activate the PGD orographic filtering

Must be one of:

  • 0

  • 1

Optional Property Config > domain > nimax

Type

number

Description: Number of grid points zonally

Restrictions

Minimum

≥ 0

Optional Property Config > domain > njmax

Type

number

Description: Number of grid points meridionally

Restrictions

Minimum

≥ 0

Optional Property Config > domain > xdx

Type

number

Description: Zonal grid size in meters

Restrictions

Minimum

≥ 0

Optional Property Config > domain > xdy

Type

number

Description: Meridional grid size in meters

Restrictions

Minimum

≥ 0

Optional Property Config > domain > ilone

Type

number

Default

11

Description: Zonal extension zone

Restrictions

Minimum

≥ 0

Optional Property Config > domain > ilate

Type

number

Default

11

Description: Meridional extension zone

Restrictions

Minimum

≥ 0

Optional Property Config > domain > nbzong

Type

number

Default

-1

Description: Meridional coupling zone width

Restrictions

Minimum

≥ -1

Optional Property Config > domain > nbzonl

Type

number

Default

-1

Description: Zonal coupling zone width

Restrictions

Minimum

≥ -1

Optional Property Config > domain > tstep

Type

combining

Additional properties

Any type: allowed

Description: Model time step in seconds

One of(Option)

item 0

item 1

Property Config > domain > tstep > oneOf > item 0

Type

string

Property Config > domain > tstep > oneOf > item 1

Type

number

Optional Property Config > domain > xloncen

Type

number

Description: Domain center longitude

Restrictions

Minimum

≥ -180

Maximum

≤ 180

Optional Property Config > domain > xlatcen

Type

number

Description: Domain center latitude

Restrictions

Minimum

≥ -90

Maximum

≤ 90

Optional Property Config > domain > xlon0

Type

combining

Additional properties

Any type: allowed

Description: Longitude of center of projection

One of(Option)

item 0

item 1

Property Config > domain > xlon0 > oneOf > item 0

Type

string

Restrictions

Max length

0

Property Config > domain > xlon0 > oneOf > item 1

Type

number

Restrictions

Minimum

≥ -180

Maximum

≤ 180

Optional Property Config > domain > xlat0

Type

combining

Additional properties

Any type: allowed

Description: Latitude of center of projection

One of(Option)

item 0

item 1

Property Config > domain > xlat0 > oneOf > item 0

Type

string

Restrictions

Max length

0

Property Config > domain > xlat0 > oneOf > item 1

Type

number

Restrictions

Minimum

≥ -90

Maximum

≤ 90

Optional Property Config > domain > xbeta

Type

number

Default

0.0

Description: Rotation parameter for the conformal projection

Optional Property Config > domain > spectral_smoothing_by_gridtype

Type

object

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

Optional Property Config > domain > truncation_by_gridtype

Type

object

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.

Optional Property Config > domain > dtf_lead_time

Type

enum (of string)

Default

""

Description: Lead time of DTF, which trigger the domain

Must be one of:

  • “”

  • “01”

  • “02”

Optional Property Config > eps

Title: EPS Members Configuration

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- general

No

object

-

-

Optional Property Config > eps > general

Type

object

Additional properties

Any type: allowed

Default

{}

Property

Pattern

Type

Definition

Title/Description

- members

No

Combination

-

The members of the ensemble

Optional Property Config > eps > general > members

Type

combining

Additional properties

Any type: allowed

Default

[0]

Description: The members of the ensemble

One of(Option)

item 0

item 1

item 2

Property Config > eps > general > members > oneOf > item 0

Type

integer

Property Config > eps > general > members > oneOf > item 1

Type

string

Property Config > eps > general > members > oneOf > item 2

Type

array of integer

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 > eps > general > members > oneOf > item 2 > item 2 items

Type

integer

Optional Property Config > extractsqlite

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

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- parameter_list

No

array of object

-

A list where each element contains name of parameter and location files

- sqlite_model_name

No

string

-

Model name used in the sqlite tables

- sqlite_path

No

string

-

Path to generated sqlite files

- sqlite_template

No

string

-

File name template for generated sqlite files

- selection

No

string

-

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

- extractsqlite_additionalProperties

No

object

-

-

Optional Property Config > extractsqlite > parameter_list

Type

array of object

Default

[]

Description: A list where each element contains name of parameter and location files

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

parameter_list items

-

Config > extractsqlite > parameter_list > parameter_list items

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- param_list

No

string

-

-

- location_list

No

string

-

-

The following properties are required
  • param_file

  • location_file

Property Config > extractsqlite > parameter_list > parameter_list items > param_list

Type

string

Property Config > extractsqlite > parameter_list > parameter_list items > location_list

Type

string

Optional Property Config > extractsqlite > sqlite_model_name

Type

string

Default

"@CASE@"

Description: Model name used in the sqlite tables

Optional Property Config > extractsqlite > sqlite_path

Type

string

Default

"@ARCHIVE_ROOT@/sqlite/"

Description: Path to generated sqlite files

Optional Property Config > extractsqlite > sqlite_template

Type

string

Default

"FCTABLE/{MODEL}/{YYYY}/{MM}/FCTABLE_{PP}_{YYYY}{MM}_{HH}.sqlite"

Description: File name template for generated sqlite files

Optional Property Config > extractsqlite > selection

Type

string

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

Optional Property Config > fdb

Title: FDB Section, defined in include/fdb.toml

Type

object

Additional properties

Any type: allowed

Description: FDB settings

Property

Pattern

Type

Definition

Title/Description

- negative_rules

No

object

-

Fields to filter out prior to archiving. For a given key a list of values should be given

- expver_restrictions

No

object

-

List users allowed to archive to a specific expver.

- grib_set

No

object

-

GRIB2 metadata updated before archiving to FDB. Any GRIB key may be added

- databridge_user

No

string

-

User allowed to write to the databridge

- fdb_additionalProperties

No

object

-

-

Optional Property Config > fdb > negative_rules

Type

object

Additional properties

Any type: allowed

Description: Fields to filter out prior to archiving. For a given key a list of values should be given

Property

Pattern

Type

Definition

Title/Description

- levtype

No

array

-

Type of level

Optional Property Config > fdb > negative_rules > levtype

Type

array

Description: Type of level

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > fdb > expver_restrictions

Type

object

Additional properties

Any type: allowed

Description: List users allowed to archive to a specific expver.

Property

Pattern

Type

Definition

Title/Description

- 0001

No

Combination

-

Operational expver

- 0099

No

Combination

-

Pre-operational expver

- 0098

No

Combination

-

Development expver

Optional Property Config > fdb > expver_restrictions > 0001

Type

combining

Additional properties

Any type: allowed

Description: Operational expver

Any of(Option)

item 0

item 1

Property Config > fdb > expver_restrictions > 0001 > anyOf > item 0

Type

string

Default

"@PROD_USER@"

Property Config > fdb > expver_restrictions > 0001 > anyOf > item 1

Type

array

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > fdb > expver_restrictions > 0099

Type

combining

Additional properties

Any type: allowed

Description: Pre-operational expver

Any of(Option)

item 0

item 1

Property Config > fdb > expver_restrictions > 0099 > anyOf > item 0

Type

string

Default

"@PROD_USER@"

Property Config > fdb > expver_restrictions > 0099 > anyOf > item 1

Type

array

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > fdb > expver_restrictions > 0098

Type

combining

Additional properties

Any type: allowed

Description: Development expver

Any of(Option)

item 0

item 1

Property Config > fdb > expver_restrictions > 0098 > anyOf > item 0

Type

string

Default

"@DEV_USER@"

Property Config > fdb > expver_restrictions > 0098 > anyOf > item 1

Type

array

Array restrictions

Min items

N/A

Max items

N/A

Items unicity

False

Additional items

False

Tuple validation

N/A

Optional Property Config > fdb > grib_set

Type

object

Additional properties

Any type: allowed

Description: GRIB2 metadata updated before archiving to FDB. Any GRIB key may be added

Property

Pattern

Type

Definition

Title/Description

- expver

No

string

-

Experiment id for FDB, read documentation before use

Optional Property Config > fdb > grib_set > expver

Type

string

Description: Experiment id for FDB, read documentation before use

Restrictions

Min length

4

Max length

4

Optional Property Config > fdb > databridge_user

Type

string

Default

"@PROD_USER@"

Description: User allowed to write to the databridge

Optional Property Config > file_templates

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

Type

object

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

Pattern

Type

Definition

Title/Description

- duration

No

object

-

Duration

- ddh_dl

No

object

-

DDH limited area or points

- ddh_gl

No

object

-

Global DDH

- ddh_zo

No

object

-

Zonal DDH

- fullpos

No

object

-

Fullpos

- interpolated_boundaries

No

object

-

Interpolated boundaries

- history

No

object

-

History

- pgd

No

object

-

PGD

- pgd_prel

No

object

-

Preliminary PGD

- pgd_host

No

object

-

Host PGD

- surfex

No

object

-

Surfex

- file_templates_additionalProperties

No

object

-

-

Optional Property Config > file_templates > duration

Title: Duration

Type

object

Additional properties

Any type: allowed

Description: Time stamp templates for output files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > duration > archive

Type

string

Default

"@LLLH@h@LM@m@LS@s"

Description: File template as stored in the archive

Optional Property Config > file_templates > duration > model

Type

string

Default

"@LLLH@:@LM@:@LS@"

Description: File template as used by the model

Optional Property Config > file_templates > ddh_dl

Title: DDH limited area or points

Type

object

Additional properties

Any type: allowed

Description: File name templates for DDH DL files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > ddh_dl > archive

Type

string

Description: File template as stored in the archive

Optional Property Config > file_templates > ddh_dl > model

Type

string

Description: File template as used by the model

Optional Property Config > file_templates > ddh_gl

Title: Global DDH

Type

object

Additional properties

Any type: allowed

Description: File name templates for DDH GL files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > ddh_gl > archive

Type

string

Description: File template as stored in the archive

Optional Property Config > file_templates > ddh_gl > model

Type

string

Description: File template as used by the model

Optional Property Config > file_templates > ddh_zo

Title: Zonal DDH

Type

object

Additional properties

Any type: allowed

Description: File name templates for DDH ZO files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > ddh_zo > archive

Type

string

Description: File template as stored in the archive

Optional Property Config > file_templates > ddh_zo > model

Type

string

Description: File template as used by the model

Optional Property Config > file_templates > fullpos

Title: Fullpos

Type

object

Additional properties

Any type: allowed

Description: File name templates for fullpos files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > fullpos > archive

Type

string

Default

"GRIBPF@CNMEXP@@DOMAIN@+@DURATION_ARCHIVE@"

Description: File template as stored in the archive

Optional Property Config > file_templates > fullpos > model

Type

string

Default

"GRIBPF@CNMEXP@@DOMAIN@+@DURATION_MODEL@"

Description: File template as used by the model

Optional Property Config > file_templates > interpolated_boundaries

Title: Interpolated boundaries

Type

object

Additional properties

Any type: allowed

Description: File name templates for interpolated boundary files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > interpolated_boundaries > archive

Type

string

Description: File template as stored in the archive

Optional Property Config > file_templates > interpolated_boundaries > model

Type

string

Description: File template as used by the model

Optional Property Config > file_templates > history

Title: History

Type

object

Additional properties

Any type: allowed

Description: File name templates for history files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > history > archive

Type

string

Default

"ICMSH@CNMEXP@+@DURATION_ARCHIVE@"

Description: File template as stored in the archive

Optional Property Config > file_templates > history > model

Type

string

Default

"ICMSH@CNMEXP@+@DURATION_MODEL@"

Description: File template as used by the model

Optional Property Config > file_templates > pgd

Title: PGD

Type

object

Additional properties

Any type: allowed

Description: File name templates for final PGD files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > pgd > archive

Type

string

Default

"Const.Clim@ONE_DECADE@.sfx"

Description: File template as stored in the archive

Optional Property Config > file_templates > pgd > model

Type

string

Default

"Const.Clim.sfx"

Description: File template as used by the model

Optional Property Config > file_templates > pgd_prel

Title: Preliminary PGD

Type

object

Additional properties

Any type: allowed

Description: File name templates for the preliminary PGD files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > pgd_prel > archive

Type

string

Default

"PGD_prel@ONE_DECADE@.fa"

Description: File template as stored in the archive

Optional Property Config > file_templates > pgd_prel > model

Type

string

Default

"PGD_prel.fa"

Description: File template as used by the model

Optional Property Config > file_templates > pgd_host

Title: Host PGD

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > pgd_host > archive

Type

string

Default

"Const.Clim@ONE_DECADE@.sfx"

Description: File template as stored in the archive

Optional Property Config > file_templates > pgd_host > model

Type

string

Default

"Const.Clim.sfx"

Description: File template as used by the model

Optional Property Config > file_templates > surfex

Title: Surfex

Type

object

Additional properties

Any type: allowed

Description: File name templates for surfex output files

Property

Pattern

Type

Definition

Title/Description

- archive

No

string

-

File template as stored in the archive

- model

No

string

-

File template as used by the model

Optional Property Config > file_templates > surfex > archive

Type

string

Default

"ICMSH@CNMEXP@+@DURATION_ARCHIVE@.sfx"

Description: File template as stored in the archive

Optional Property Config > file_templates > surfex > model

Type

string

Default

"ICMSH@CNMEXP@+@DURATION_MODEL@.sfx"

Description: File template as used by the model

Optional Property Config > json2tab

Title: json-2-tab Section, defined in include/json2tab.toml

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- enabled

No

boolean

-

Switch to use the Json-2-tab converter to generate domain specific tab-files for windfarm parameterization WFP.

- force_rewrite

No

boolean

-

Switch to always run json2tab when WFP is on (and maybe override existing windturbine tab-files when they already exist)

- config_file

No

string

-

Config file for some json-2-tab configurations not managed by tactus.

- loglevel

No

enum (of string)

-

Loglevel as used for json-2-tab logging

- input

No

object

-

Input configuration section for json-2-tab.

- output

No

object

-

Output configuration section for json-2-tab.

- json2tab_additionalProperties

No

object

-

-

Optional Property Config > json2tab > enabled

Type

boolean

Default

true

Description: Switch to use the Json-2-tab converter to generate domain specific tab-files for windfarm parameterization WFP.

Optional Property Config > json2tab > force_rewrite

Type

boolean

Default

false

Description: Switch to always run json2tab when WFP is on (and maybe override existing windturbine tab-files when they already exist)

Optional Property Config > json2tab > config_file

Type

string

Default

"@TACTUS_HOME@/data/json2tab/json2tab-config.yaml"

Description: Config file for some json-2-tab configurations not managed by tactus.

Optional Property Config > json2tab > loglevel

Type

enum (of string)

Default

"auto"

Description: Loglevel as used for json-2-tab logging

Must be one of:

  • “auto”

  • “debug”

  • “info”

  • “warning”

  • “error”

Optional Property Config > json2tab > input

Type

object

Additional properties

Any type: allowed

Description: Input configuration section for json-2-tab.

Property

Pattern

Type

Definition

Title/Description

- turbine_locations

No

string

-

Main file containing turbine locations (csv, tab or geojson).

- turbine_database

No

array of string

-

List of turbine type databases with turbine specifications.

Optional Property Config > json2tab > input > turbine_locations

Type

string

Default

"@WINDFARM_PATH@/euromap.csv"

Description: Main file containing turbine locations (csv, tab or geojson).

Optional Property Config > json2tab > input > turbine_database

Type

array of string

Default

["@WINDFARM_PATH@/turbine_database+gened_ct_curves.json", "@WINDFARM_PATH@/turbine_database+knmi.json", "@WINDFARM_PATH@/turbine_database+wf101.json", "@WINDFARM_PATH@/turbine_specifications+belgian.csv", "@WINDFARM_PATH@/known_wf101_mapping.csv"]

Description: List of turbine type databases with turbine specifications.

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

turbine_database items

Path to database with turbine specifications

Config > json2tab > input > turbine_database > turbine_database items

Type

string

Description: Path to database with turbine specifications

Optional Property Config > json2tab > output

Type

object

Additional properties

Any type: allowed

Description: Output configuration section for json-2-tab.

Property

Pattern

Type

Definition

Title/Description

- directory

No

string

-

Directory for all output files.

- files

No

object

-

Specification for output files.

Optional Property Config > json2tab > output > directory

Type

string

Default

"@ARCHIVE_ROOT@/windfarm_data/"

Description: Directory for all output files.

Optional Property Config > json2tab > output > files

Type

object

Additional properties

Any type: allowed

Description: Specification for output files.

Property

Pattern

Type

Definition

Title/Description

- location_tab

No

string

-

Tab file output with selected turbines.

- type_tab_prefix

No

string

-

Prefix of tab file output with type definitions (will be followed by type ID and .tab)

Optional Property Config > json2tab > output > files > location_tab

Type

string

Default

"turbine_locations.tab"

Description: Tab file output with selected turbines.

Optional Property Config > json2tab > output > files > type_tab_prefix

Type

string

Default

"wind_turbine_"

Description: Prefix of tab file output with type definitions (will be followed by type ID and .tab)

Optional Property Config > macros

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

Type

object

Additional properties

Any type: allowed

Description: Model for the ‘macros’ section.

Property

Pattern

Type

Definition

Title/Description

- select

No

object

-

Macro subsection

- macros_additionalProperties

No

object

-

-

Optional Property Config > macros > select

Title: Macro subsection

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- default

No

object

-

Default macros

Optional Property Config > macros > select > default

Title: Default macros

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- gen_macros

No

array

-

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

- group_macros

No

array of string

-

Turns a full config section to a macro

- os_macros

No

array of string

-

Environment variables used as macros

Optional Property Config > macros > select > default > gen_macros

Type

array

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 > select > default > gen_macros > gen_macros items

Type

combining

Additional properties

Any type: allowed

Any of(Option)

item 0

item 1

Property Config > macros > select > default > gen_macros > gen_macros items > anyOf > item 0

Type

string

Property Config > macros > select > default > gen_macros > gen_macros items > anyOf > item 1

Type

object

Additional properties

Any type: allowed

Optional Property Config > macros > select > default > group_macros

Type

array of string

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 > select > default > group_macros > group_macros items

Type

string

Optional Property Config > macros > select > default > os_macros

Type

array of string

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 > select > default > os_macros > os_macros items

Type

string

Optional Property Config > mars

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

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- HRES

No

object

-

Operational HRES

- IFSENS

No

object

-

Operational ensemble forecasts

- ATOS_DT

No

object

-

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

- atos_bologna_DT

No

object

-

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

- DT12

No

object

-

Global DT runs on ATOS but starting at 12Z

- i5qp

No

object

-

Paris RDP case Tco2559

- i7u4

No

object

-

Paris RDP case Tco3999 with Urban scheme

- i7ye

No

object

-

Paris RDP case Tco3999 without Urban scheme

- i8hy

No

object

-

AQ winter case over central Europe

- lumi_DT

No

object

-

Global DT near real-time runs on LUMI

- mars_additionalProperties

No

object

-

-

Optional Property Config > mars > HRES

Title: Operational HRES

Type

object

Additional properties

Any type: allowed

Description: Parameters for oper data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- class

No

string

-

Class of expver

- levelist

No

object

-

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

- grid

No

object

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG1

No

string

-

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

- GG_sea

No

string

-

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

- GG_soil

No

string

-

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

- grid_GG1

No

object

-

Grid parameter for mars request of GG1 fields

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

object

-

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

Optional Property Config > mars > HRES > ifs_cycle_start

Type

string

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

Optional Property Config > mars > HRES > class

Type

string

Description: Class of expver

Optional Property Config > mars > HRES > levelist

Type

object

Additional properties

Any type: allowed

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

Optional Property Config > mars > HRES > grid

Type

object

Additional properties

Any type: allowed

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

Optional Property Config > mars > HRES > ifs_cycle_length

Type

string

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

Optional Property Config > mars > HRES > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > HRES > GG

Type

string

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

Optional Property Config > mars > HRES > GG1

Type

string

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

Optional Property Config > mars > HRES > GG_sea

Type

string

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

Optional Property Config > mars > HRES > GG_soil

Type

string

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

Optional Property Config > mars > HRES > grid_GG1

Type

object

Additional properties

Any type: allowed

Description: Grid parameter for mars request of GG1 fields

Optional Property Config > mars > HRES > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > HRES > SH

Type

string

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

Optional Property Config > mars > HRES > SHZ

Type

string

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

Optional Property Config > mars > HRES > UA

Type

string

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

Optional Property Config > mars > HRES > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > HRES > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > HRES > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > HRES > stream

Type

object

Additional properties

Any type: allowed

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

Optional Property Config > mars > IFSENS

Title: Operational ensemble forecasts

Type

object

Additional properties

Any type: allowed

Description: Parameters for oper data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

object

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

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

- GG

No

string

-

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

- GG1

No

string

-

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

- GG_sea

No

string

-

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

- GG_soil

No

string

-

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

- grid_GG1

No

object

-

Grid parameter for mars request of GG1 fields

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- resolution

No

string

-

Resolution of global model

- stream

No

string

-

MARS stream

- stream_control

No

string

-

MARS stream for control member. Required to be set if stream is not the same as for the other members.

Optional Property Config > mars > IFSENS > ifs_cycle_start

Type

string

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

Optional Property Config > mars > IFSENS > class

Type

string

Description: Class of expver

Optional Property Config > mars > IFSENS > levelist

Type

string

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

Optional Property Config > mars > IFSENS > grid

Type

object

Additional properties

Any type: allowed

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

Optional Property Config > mars > IFSENS > ifs_cycle_length

Type

string

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

Optional Property Config > mars > IFSENS > start_date

Type

string

Format

date-time

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

Optional Property Config > mars > IFSENS > GG

Type

string

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

Optional Property Config > mars > IFSENS > GG1

Type

string

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

Optional Property Config > mars > IFSENS > GG_sea

Type

string

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

Optional Property Config > mars > IFSENS > GG_soil

Type

string

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

Optional Property Config > mars > IFSENS > grid_GG1

Type

object

Additional properties

Any type: allowed

Description: Grid parameter for mars request of GG1 fields

Optional Property Config > mars > IFSENS > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > IFSENS > SH

Type

string

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

Optional Property Config > mars > IFSENS > SHZ

Type

string

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

Optional Property Config > mars > IFSENS > UA

Type

string

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

Optional Property Config > mars > IFSENS > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > IFSENS > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > IFSENS > stream

Type

string

Description: MARS stream

Optional Property Config > mars > IFSENS > stream_control

Type

string

Description: MARS stream for control member. Required to be set if stream is not the same as for the other members.

Optional Property Config > mars > ATOS_DT

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

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > ATOS_DT > ifs_cycle_start

Type

string

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

Optional Property Config > mars > ATOS_DT > default

Type

string

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

Optional Property Config > mars > ATOS_DT > class

Type

string

Description: Class of expver

Optional Property Config > mars > ATOS_DT > levelist

Type

string

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

Optional Property Config > mars > ATOS_DT > grid

Type

string

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

Optional Property Config > mars > ATOS_DT > ifs_cycle_length

Type

string

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

Optional Property Config > mars > ATOS_DT > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > ATOS_DT > GG

Type

string

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

Optional Property Config > mars > ATOS_DT > GG_sea

Type

string

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

Optional Property Config > mars > ATOS_DT > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > ATOS_DT > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > ATOS_DT > SH

Type

string

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

Optional Property Config > mars > ATOS_DT > SHZ

Type

string

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

Optional Property Config > mars > ATOS_DT > UA

Type

string

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

Optional Property Config > mars > ATOS_DT > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > ATOS_DT > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > ATOS_DT > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > ATOS_DT > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > atos_bologna_DT

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

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > atos_bologna_DT > ifs_cycle_start

Type

string

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

Optional Property Config > mars > atos_bologna_DT > default

Type

string

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

Optional Property Config > mars > atos_bologna_DT > class

Type

string

Description: Class of expver

Optional Property Config > mars > atos_bologna_DT > levelist

Type

string

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

Optional Property Config > mars > atos_bologna_DT > grid

Type

string

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

Optional Property Config > mars > atos_bologna_DT > ifs_cycle_length

Type

string

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

Optional Property Config > mars > atos_bologna_DT > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > atos_bologna_DT > GG

Type

string

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

Optional Property Config > mars > atos_bologna_DT > GG_sea

Type

string

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

Optional Property Config > mars > atos_bologna_DT > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > atos_bologna_DT > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > atos_bologna_DT > SH

Type

string

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

Optional Property Config > mars > atos_bologna_DT > SHZ

Type

string

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

Optional Property Config > mars > atos_bologna_DT > UA

Type

string

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

Optional Property Config > mars > atos_bologna_DT > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > atos_bologna_DT > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > atos_bologna_DT > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > atos_bologna_DT > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > DT12

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

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > DT12 > ifs_cycle_start

Type

string

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

Optional Property Config > mars > DT12 > default

Type

string

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

Optional Property Config > mars > DT12 > class

Type

string

Description: Class of expver

Optional Property Config > mars > DT12 > levelist

Type

string

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

Optional Property Config > mars > DT12 > grid

Type

string

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

Optional Property Config > mars > DT12 > ifs_cycle_length

Type

string

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

Optional Property Config > mars > DT12 > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > DT12 > GG

Type

string

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

Optional Property Config > mars > DT12 > GG_sea

Type

string

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

Optional Property Config > mars > DT12 > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > DT12 > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > DT12 > SH

Type

string

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

Optional Property Config > mars > DT12 > SHZ

Type

string

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

Optional Property Config > mars > DT12 > UA

Type

string

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

Optional Property Config > mars > DT12 > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > DT12 > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > DT12 > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > DT12 > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > i5qp

Title: Paris RDP case Tco2559

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > i5qp > ifs_cycle_start

Type

string

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

Optional Property Config > mars > i5qp > default

Type

string

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

Optional Property Config > mars > i5qp > class

Type

string

Description: Class of expver

Optional Property Config > mars > i5qp > levelist

Type

string

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

Optional Property Config > mars > i5qp > grid

Type

string

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

Optional Property Config > mars > i5qp > ifs_cycle_length

Type

string

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

Optional Property Config > mars > i5qp > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > i5qp > GG

Type

string

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

Optional Property Config > mars > i5qp > GG_sea

Type

string

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

Optional Property Config > mars > i5qp > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > i5qp > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > i5qp > SH

Type

string

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

Optional Property Config > mars > i5qp > SHZ

Type

string

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

Optional Property Config > mars > i5qp > UA

Type

string

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

Optional Property Config > mars > i5qp > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > i5qp > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > i5qp > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > i5qp > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > i7u4

Title: Paris RDP case Tco3999 with Urban scheme

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > i7u4 > ifs_cycle_start

Type

string

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

Optional Property Config > mars > i7u4 > default

Type

string

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

Optional Property Config > mars > i7u4 > class

Type

string

Description: Class of expver

Optional Property Config > mars > i7u4 > levelist

Type

string

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

Optional Property Config > mars > i7u4 > grid

Type

string

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

Optional Property Config > mars > i7u4 > ifs_cycle_length

Type

string

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

Optional Property Config > mars > i7u4 > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > i7u4 > GG

Type

string

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

Optional Property Config > mars > i7u4 > GG_sea

Type

string

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

Optional Property Config > mars > i7u4 > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > i7u4 > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > i7u4 > SH

Type

string

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

Optional Property Config > mars > i7u4 > SHZ

Type

string

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

Optional Property Config > mars > i7u4 > UA

Type

string

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

Optional Property Config > mars > i7u4 > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > i7u4 > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > i7u4 > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > i7u4 > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > i7ye

Title: Paris RDP case Tco3999 without Urban scheme

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > i7ye > ifs_cycle_start

Type

string

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

Optional Property Config > mars > i7ye > default

Type

string

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

Optional Property Config > mars > i7ye > class

Type

string

Description: Class of expver

Optional Property Config > mars > i7ye > levelist

Type

string

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

Optional Property Config > mars > i7ye > grid

Type

string

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

Optional Property Config > mars > i7ye > ifs_cycle_length

Type

string

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

Optional Property Config > mars > i7ye > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > i7ye > GG

Type

string

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

Optional Property Config > mars > i7ye > GG_sea

Type

string

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

Optional Property Config > mars > i7ye > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > i7ye > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > i7ye > SH

Type

string

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

Optional Property Config > mars > i7ye > SHZ

Type

string

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

Optional Property Config > mars > i7ye > UA

Type

string

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

Optional Property Config > mars > i7ye > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > i7ye > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > i7ye > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > i7ye > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > i8hy

Title: AQ winter case over central Europe

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > i8hy > ifs_cycle_start

Type

string

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

Optional Property Config > mars > i8hy > default

Type

string

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

Optional Property Config > mars > i8hy > class

Type

string

Description: Class of expver

Optional Property Config > mars > i8hy > levelist

Type

string

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

Optional Property Config > mars > i8hy > grid

Type

string

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

Optional Property Config > mars > i8hy > ifs_cycle_length

Type

string

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

Optional Property Config > mars > i8hy > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > i8hy > GG

Type

string

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

Optional Property Config > mars > i8hy > GG_sea

Type

string

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

Optional Property Config > mars > i8hy > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > i8hy > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > i8hy > SH

Type

string

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

Optional Property Config > mars > i8hy > SHZ

Type

string

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

Optional Property Config > mars > i8hy > UA

Type

string

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

Optional Property Config > mars > i8hy > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > i8hy > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > i8hy > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > i8hy > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > mars > lumi_DT

Title: Global DT near real-time runs on LUMI

Type

object

Additional properties

Any type: allowed

Description: Parameters for global DT data

Property

Pattern

Type

Definition

Title/Description

- ifs_cycle_start

No

string

-

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

- default

No

string

-

Other section to copy settings from if not given here

- class

No

string

-

Class of expver

- levelist

No

string

-

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

- grid

No

string

-

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

- ifs_cycle_length

No

string

-

Boundary model cycle interval

- start_date

No

string

-

Date from when are data available in Mars

- GG

No

string

-

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

- GG_sea

No

string

-

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

- tco

No

enum (of string)

-

Truncation for static RD data

- grid_ML

No

string

-

Grid parameter for mars request of model level fields

- SH

No

string

-

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

- SHZ

No

string

-

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

- UA

No

string

-

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

- SHZ_type

No

string

-

Type for geopotential

- GGZ_type

No

string

-

Type for geopotential in gridpoint

- resolution

No

string

-

Resolution of global model

- stream

No

Combination

-

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

Optional Property Config > mars > lumi_DT > ifs_cycle_start

Type

string

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

Optional Property Config > mars > lumi_DT > default

Type

string

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

Optional Property Config > mars > lumi_DT > class

Type

string

Description: Class of expver

Optional Property Config > mars > lumi_DT > levelist

Type

string

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

Optional Property Config > mars > lumi_DT > grid

Type

string

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

Optional Property Config > mars > lumi_DT > ifs_cycle_length

Type

string

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

Optional Property Config > mars > lumi_DT > start_date

Type

string

Format

date-time

Description: Date from when are data available in Mars

Optional Property Config > mars > lumi_DT > GG

Type

string

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

Optional Property Config > mars > lumi_DT > GG_sea

Type

string

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

Optional Property Config > mars > lumi_DT > tco

Type

enum (of string)

Description: Truncation for static RD data

Must be one of:

  • “255”

  • “399”

Optional Property Config > mars > lumi_DT > grid_ML

Type

string

Description: Grid parameter for mars request of model level fields

Optional Property Config > mars > lumi_DT > SH

Type

string

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

Optional Property Config > mars > lumi_DT > SHZ

Type

string

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

Optional Property Config > mars > lumi_DT > UA

Type

string

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

Optional Property Config > mars > lumi_DT > SHZ_type

Type

string

Description: Type for geopotential

Optional Property Config > mars > lumi_DT > GGZ_type

Type

string

Description: Type for geopotential in gridpoint

Optional Property Config > mars > lumi_DT > resolution

Type

string

Description: Resolution of global model

Optional Property Config > mars > lumi_DT > stream

Type

combining

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

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

Type

object

Additional properties

Any type: allowed

Optional Property Config > platform

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

Type

object

Additional properties

Any type: allowed

Description: TACTUS platform specific path settings

Property

Pattern

Type

Definition

Title/Description

- archive_types

No

array of enum (of string)

-

Methods available for archiving

- ecoclim_data_path

No

string

-

Path to the ECOCLIMAP-II data

- tactus_home

No

string

-

Path to the tactus code, normally no need to change

- pgd_data_path

No

string

-

Path to PGD input data

- soilgrid_data_path

No

string

-

Path to solgrid input data

- global_sfcdir

No

string

-

Path to global IFS surface data

- topo_data_path

No

string

-

Path to topography input data directory

- topo_source

No

enum (of string)

-

Topography data source type

- ecosg_data_path

No

string

-

Path to ECOCLIMAP SG data

- climdata

No

string

-

Macro used in other platform paths

- static_data

No

string

-

Macro used in other platform paths

- e923_data

No

string

-

Path to e923 input data

- ncdir

No

string

-

Path to ECrad NetCDF data

- references_folder

No

string

-

Path to references checker input

- references_generation_folder

No

string

-

Path to references checker generation folder

- rrtm_dir

No

string

-

Path to RRTM input data

- rttov_coefdir

No

string

-

Path to RTTOV_COEF input data

- scratch

No

string

-

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

- task_name

No

string

-

Placeholder macro.

- flake_dir

No

string

-

Path to climate PGD dir.

- albnir_soil_dir

No

string

-

Path to near-infrared spectrum soil data.

- albnir_veg_dir

No

string

-

Path to near-infrared spectrum vegetation data.

- albvis_soil_dir

No

string

-

Path to visible soil spectrum data.

- albvis_veg_dir

No

string

-

Path to visible spectrum vegetation data.

- install_dir

No

string

-

Install location

- lai_dir

No

string

-

TBA

- osm_data_eu

No

string

-

Directory containing OSM data for Europe

- tree_height_dir

No

string

-

Path to tree_height data.

- windfarm_path

No

string

-

Path to wind farm parameterisation input data.

- uv_cache_dir

No

string

-

Path to uv cache dir used to install some plug-ins.

- eclipse_data_dir

No

string

-

Path to sun/moon position as used for eclipses.

- archive_root

No

string

-

Path to the main archive directory

- unix_group

No

string

-

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

- platform_additionalProperties

No

object

-

-

Optional Property Config > platform > archive_types

Type

array of enum (of string)

Default

["compress", "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)

Must be one of:

  • “compress”

  • “copy”

  • “ecfs”

  • “fdb”

  • “move”

  • “scp”

Optional Property Config > platform > ecoclim_data_path

Type

string

Description: Path to the ECOCLIMAP-II data

Optional Property Config > platform > tactus_home

Type

string

Default

"set-by-the-system"

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

Optional Property Config > platform > pgd_data_path

Type

string

Description: Path to PGD input data

Optional Property Config > platform > soilgrid_data_path

Type

string

Description: Path to solgrid input data

Optional Property Config > platform > global_sfcdir

Type

string

Default

""

Description: Path to global IFS surface data

Optional Property Config > platform > topo_data_path

Type

string

Description: Path to topography input data directory

Optional Property Config > platform > topo_source

Type

enum (of string)

Default

"gmted2010"

Description: Topography data source type

Must be one of:

  • “gmted2010”

  • “gmted_eur”

  • “gtopo30”

  • “glo90”

Optional Property Config > platform > ecosg_data_path

Type

string

Description: Path to ECOCLIMAP SG data

Optional Property Config > platform > climdata

Type

string

Description: Macro used in other platform paths

Optional Property Config > platform > static_data

Type

string

Description: Macro used in other platform paths

Optional Property Config > platform > e923_data

Type

string

Description: Path to e923 input data

Optional Property Config > platform > ncdir

Type

string

Description: Path to ECrad NetCDF data

Optional Property Config > platform > references_folder

Type

string

Description: Path to references checker input

Optional Property Config > platform > references_generation_folder

Type

string

Description: Path to references checker generation folder

Optional Property Config > platform > rrtm_dir

Type

string

Description: Path to RRTM input data

Optional Property Config > platform > rttov_coefdir

Type

string

Description: Path to RTTOV_COEF input data

Optional Property Config > platform > scratch

Type

string

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

Optional Property Config > platform > task_name

Type

string

Description: Placeholder macro.

Optional Property Config > platform > flake_dir

Type

string

Description: Path to climate PGD dir.

Optional Property Config > platform > albnir_soil_dir

Type

string

Description: Path to near-infrared spectrum soil data.

Optional Property Config > platform > albnir_veg_dir

Type

string

Description: Path to near-infrared spectrum vegetation data.

Optional Property Config > platform > albvis_soil_dir

Type

string

Description: Path to visible soil spectrum data.

Optional Property Config > platform > albvis_veg_dir

Type

string

Description: Path to visible spectrum vegetation data.

Optional Property Config > platform > install_dir

Type

string

Description: Install location

Optional Property Config > platform > lai_dir

Type

string

Description: TBA

Optional Property Config > platform > osm_data_eu

Type

string

Description: Directory containing OSM data for Europe

Optional Property Config > platform > tree_height_dir

Type

string

Description: Path to tree_height data.

Optional Property Config > platform > windfarm_path

Type

string

Description: Path to wind farm parameterisation input data.

Optional Property Config > platform > uv_cache_dir

Type

string

Description: Path to uv cache dir used to install some plug-ins.

Optional Property Config > platform > eclipse_data_dir

Type

string

Default

"@STATIC_DATA@/climate/eclipse"

Description: Path to sun/moon position as used for eclipses.

Optional Property Config > platform > archive_root

Type

string

Description: Path to the main archive directory

Optional Property Config > platform > unix_group

Type

string

Default

""

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

Optional Property Config > reference_checker

Title: Reference Checker Configuration

Type

object

Additional properties

Any type: allowed

Description: Reference checker settings

Property

Pattern

Type

Definition

Title/Description

- check

No

boolean

-

Activate the check comparison against reference files

- generate

No

boolean

-

Activate the generation of reference files

- summary_active

No

array of string

-

List of summaries to produce

- rules_active

No

array of string

-

List of comparisons to perform

- methods

No

object

-

Define a comparison method

- summary

No

object

-

Summary generation settings

- tasks

No

object

-

Comparison settings for a task

- reference_checker_additionalProperties

No

object

-

-

Optional Property Config > reference_checker > check

Type

boolean

Description: Activate the check comparison against reference files

Optional Property Config > reference_checker > generate

Type

boolean

Description: Activate the generation of reference files

Optional Property Config > reference_checker > summary_active

Type

array of string

Description: List of summaries to produce

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

summary_active items

Name of a summary generation rule

Config > reference_checker > summary_active > summary_active items

Type

string

Description: Name of a summary generation rule

Optional Property Config > reference_checker > rules_active

Type

array of string

Description: List of comparisons to perform

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

rules_active items

Name of a comparison rule

Config > reference_checker > rules_active > rules_active items

Type

string

Description: Name of a comparison rule

Optional Property Config > reference_checker > methods

Type

object

Additional properties

Any type: allowed

Description: Define a comparison method

Property

Pattern

Type

Definition

Title/Description

- tool

No

enum (of string)

-

Name of the tool used for comparison

- binary

No

string

-

Path to the binary of the tool

- args_template

No

string

-

Templated arguments to provide to the tool

- file_format

No

enum (of string)

-

Format of the file that is expected

- tolerance

No

number

-

Tolerance value used for comparison

- mode

No

string

-

Mode used for comparison

- which

No

string

-

Which value to use for comparison

Optional Property Config > reference_checker > methods > tool

Type

enum (of string)

Description: Name of the tool used for comparison

Must be one of:

  • “normschecker”

  • “xtool”

Optional Property Config > reference_checker > methods > binary

Type

string

Description: Path to the binary of the tool

Optional Property Config > reference_checker > methods > args_template

Type

string

Description: Templated arguments to provide to the tool

Optional Property Config > reference_checker > methods > file_format

Type

enum (of string)

Description: Format of the file that is expected

Must be one of:

  • “FA”

  • “GRIB”

  • “LOG”

Optional Property Config > reference_checker > methods > tolerance

Type

number

Description: Tolerance value used for comparison

Optional Property Config > reference_checker > methods > mode

Type

string

Default

"get_worst"

Description: Mode used for comparison

Optional Property Config > reference_checker > methods > which

Type

string

Default

"first_and_last_spectral"

Description: Which value to use for comparison

Optional Property Config > reference_checker > summary

Type

object

Additional properties

Any type: allowed

Description: Summary generation settings

Property

Pattern

Type

Definition

Title/Description

- file

No

string

-

Name of the summary file

- format

No

enum (of string)

-

Format of the summary file

Optional Property Config > reference_checker > summary > file

Type

string

Default

"@WRK@/checks/summary.txt"

Description: Name of the summary file

Optional Property Config > reference_checker > summary > format

Type

enum (of string)

Default

"txt"

Description: Format of the summary file

Must be one of:

  • “json”

  • “txt”

Optional Property Config > reference_checker > tasks

Type

object

Additional properties

Any type: allowed

Description: Comparison settings for a task

Property

Pattern

Type

Definition

Title/Description

- rules

No

object

-

Comparison rule settings

Optional Property Config > reference_checker > tasks > rules

Type

object

Additional properties

Any type: allowed

Description: Comparison rule settings

Property

Pattern

Type

Definition

Title/Description

- inpath

No

string

-

Name of the input folder where input file are located

- pattern

No

string

-

Regex Pattern to select the input files to compare

- generate_folder

No

string

-

Folder into which the generated files will be stored

- method

No

string

-

Name of a comparison method

- reference_folder

No

string

-

Folder containing the reference files

- result_folder

No

string

-

Folder into which the results of the comparison will be stored

Optional Property Config > reference_checker > tasks > rules > inpath

Type

string

Description: Name of the input folder where input file are located

Optional Property Config > reference_checker > tasks > rules > pattern

Type

string

Description: Regex Pattern to select the input files to compare

Optional Property Config > reference_checker > tasks > rules > generate_folder

Type

string

Default

"@REFERENCES_GENERATION_FOLDER@/@CASE@/@ARCHIVE_TIMESTAMP@/@MEMBER_STR@"

Description: Folder into which the generated files will be stored

Optional Property Config > reference_checker > tasks > rules > method

Type

string

Description: Name of a comparison method

Optional Property Config > reference_checker > tasks > rules > reference_folder

Type

string

Default

"@REFERENCES_FOLDER@/@CASE@/@ARCHIVE_TIMESTAMP@/@MEMBER_STR@"

Description: Folder containing the reference files

Optional Property Config > reference_checker > tasks > rules > result_folder

Type

string

Default

"@WRK@/checks"

Description: Folder into which the results of the comparison will be stored

Optional Property Config > remove

Title: RemoveSection

Type

object

Additional properties

Any type: allowed

Description: Model for validation of the remove configuration.

Property

Pattern

Type

Definition

Title/Description

- defaults

No

object

-

-

- remove_from_scheduler

No

boolean

-

Remove suite from the used scheduler.

- remove_not_completed_suites

No

boolean

-

Force removal of suites not completed

- Cleaning_example

No

object

-

-

- remove_additionalProperties

No

object

-

-

Optional Property Config > remove > defaults

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- include

No

string

-

regular experssion according to it which files to clean

- ncycles_delay

No

number

-

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

- cleaning_delay

No

string

-

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

No

string

-

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

- step

No

string

-

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

- active

No

boolean

-

Activate cleaning files

- dry_run

No

boolean

-

test cleaning without to delete files

- path

No

string

-

Path to clean

- wipe

No

boolean

-

Flag for cleaning everything in a path

- execute_removal

No

boolean

-

Execute the actual removal

Optional Property Config > remove > defaults > include

Type

string

Description: regular experssion according to it which files to clean

Optional Property Config > remove > defaults > ncycles_delay

Type

number

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

Optional Property Config > remove > defaults > cleaning_delay

Type

string

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.

Optional Property Config > remove > defaults > cleaning_max_delay

Type

string

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.

Optional Property Config > remove > defaults > step

Type

string

Format

duration

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

Optional Property Config > remove > defaults > active

Type

boolean

Description: Activate cleaning files

Optional Property Config > remove > defaults > dry_run

Type

boolean

Description: test cleaning without to delete files

Optional Property Config > remove > defaults > path

Type

string

Default

""

Description: Path to clean

Optional Property Config > remove > defaults > wipe

Type

boolean

Default

false

Description: Flag for cleaning everything in a path

Optional Property Config > remove > defaults > execute_removal

Type

boolean

Default

false

Description: Execute the actual removal

Optional Property Config > remove > remove_from_scheduler

Type

boolean

Description: Remove suite from the used scheduler.

Optional Property Config > remove > remove_not_completed_suites

Type

boolean

Description: Force removal of suites not completed

Optional Property Config > remove > Cleaning_example

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

+ path

No

string

-

path to the folder where files will be cleaned

- include

No

string

-

regular expression for files to select for cleaning

- exclude

No

string

-

regular expression for files to explicitly exclude from cleaning

- ncycles_delay

No

number

-

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

- cleaning_delay

No

string

-

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

No

string

-

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

- step

No

string

-

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

- active

No

boolean

-

Activate cleaning files

- dry_run

No

boolean

-

test cleaning without to delete files

Required Property Config > remove > Cleaning_example > path

Type

string

Description: path to the folder where files will be cleaned

Optional Property Config > remove > Cleaning_example > include

Type

string

Default

"(.*)"

Description: regular expression for files to select for cleaning

Optional Property Config > remove > Cleaning_example > exclude

Type

string

Description: regular expression for files to explicitly exclude from cleaning

Optional Property Config > remove > Cleaning_example > ncycles_delay

Type

number

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

Optional Property Config > remove > Cleaning_example > cleaning_delay

Type

string

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.

Optional Property Config > remove > Cleaning_example > cleaning_max_delay

Type

string

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.

Optional Property Config > remove > Cleaning_example > step

Type

string

Format

duration

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

Optional Property Config > remove > Cleaning_example > active

Type

boolean

Description: Activate cleaning files

Optional Property Config > remove > Cleaning_example > dry_run

Type

boolean

Default

true

Description: test cleaning without to delete files

Optional Property Config > scheduler

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

Type

object

Additional properties

Any type: allowed

Description: Settings for implemented schedulers

Property

Pattern

Type

Definition

Title/Description

- ecfvars

No

object

-

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

- mirror_globalDT

No

object

-

Settings to mirror globalDT

- mirror_offline

No

object

-

Settings to mirror offlineSFX

- mirror_host_case

No

object

-

Settings to mirror a host case

- scheduler_additionalProperties

No

object

-

-

Optional Property Config > scheduler > ecfvars

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

Type

object

Additional properties

Any type: allowed

Description: TACTUS HPC specific ecflow settings

Property

Pattern

Type

Definition

Title/Description

- ecf_ssl

No

string

-

Ecflow comminucation using SSL

- ecf_tries

No

integer

-

Ecflow tries.

- ecf_host

No

string

-

Ecflow host. HPC dependent.

- ecf_host_resolved

No

string

-

Resolved Ecflow host for downstream usage

- ecf_port

No

Combination

-

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_port_resolved

No

Combination

-

Parsed ecflow port for communication

- ecf_jobout

No

string

-

Path to Ecflow job output.

- ecf_files

No

string

-

Path to Ecflow operating files.

- ecf_files_remotely

No

string

-

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

- ecf_home

No

string

-

Path to Ecflow home.

- ecf_user

No

string

-

Ecflow user, only set when required

- ecf_remoteuser

No

string

-

Ecflow remote user, only set when required

- ecf_tactus_home

No

string

-

tactus home directory stripped for parts specific to where a node is mounted on a cluster

Optional Property Config > scheduler > ecfvars > ecf_ssl

Type

string

Default

"0"

Description: Ecflow comminucation using SSL

Optional Property Config > scheduler > ecfvars > ecf_tries

Type

integer

Default

1

Description: Ecflow tries.

Optional Property Config > scheduler > ecfvars > ecf_host

Type

string

Description: Ecflow host. HPC dependent.

Optional Property Config > scheduler > ecfvars > ecf_host_resolved

Type

string

Default

""

Description: Resolved Ecflow host for downstream usage

Optional Property Config > scheduler > ecfvars > ecf_port

Type

combining

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

item 2

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

Type

integer

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

Type

string

Restrictions

Must match regular expression

_set_port_from_user\((.*),\) Test

Property Config > scheduler > ecfvars > ecf_port > anyOf > item 2

Type

string

Restrictions

Must match regular expression

_set_port_from_json\((.*),\) Test

Optional Property Config > scheduler > ecfvars > ecf_port_resolved

Type

combining

Default

""

Description: Parsed ecflow port for communication

Any of(Option)

item 0

item 1

Property Config > scheduler > ecfvars > ecf_port_resolved > anyOf > item 0

Type

integer

Property Config > scheduler > ecfvars > ecf_port_resolved > anyOf > item 1

Type

string

Optional Property Config > scheduler > ecfvars > ecf_jobout

Type

string

Description: Path to Ecflow job output.

Optional Property Config > scheduler > ecfvars > ecf_files

Type

string

Description: Path to Ecflow operating files.

Optional Property Config > scheduler > ecfvars > ecf_files_remotely

Type

string

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

Optional Property Config > scheduler > ecfvars > ecf_home

Type

string

Description: Path to Ecflow home.

Optional Property Config > scheduler > ecfvars > ecf_user

Type

string

Default

""

Description: Ecflow user, only set when required

Optional Property Config > scheduler > ecfvars > ecf_remoteuser

Type

string

Default

""

Description: Ecflow remote user, only set when required

Optional Property Config > scheduler > ecfvars > ecf_tactus_home

Type

string

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

Optional Property Config > scheduler > mirror_globalDT

Title: Settings to mirror globalDT

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- check_var

No

string

-

Remote variable (like YMD) that is checked for triggering. Leave empty if not required.

- mirror_name

No

string

-

Name for the mirror in ecflow

- remote_auth

No

string

-

the location to the Mirror authentication credentials file, if required

- remote_host

No

string

-

the remote ecFlow server host

- remote_path

No

string

-

the path of the node on the remote ecFlow server

- remote_port

No

string

-

the remote ecFlow server port

- remote_polling

No

string

-

the value (in seconds) used to periodically contact the remote ecFlow server

- remote_ssl

No

boolean

-

to connect to the ecFlow server using SSL

Optional Property Config > scheduler > mirror_globalDT > check_var

Type

string

Default

""

Description: Remote variable (like YMD) that is checked for triggering. Leave empty if not required.

Optional Property Config > scheduler > mirror_globalDT > mirror_name

Type

string

Default

""

Description: Name for the mirror in ecflow

Optional Property Config > scheduler > mirror_globalDT > remote_auth

Type

string

Default

""

Description: the location to the Mirror authentication credentials file, if required

Optional Property Config > scheduler > mirror_globalDT > remote_host

Type

string

Default

""

Description: the remote ecFlow server host

Optional Property Config > scheduler > mirror_globalDT > remote_path

Type

string

Default

""

Description: the path of the node on the remote ecFlow server

Optional Property Config > scheduler > mirror_globalDT > remote_port

Type

string

Default

""

Description: the remote ecFlow server port

Optional Property Config > scheduler > mirror_globalDT > remote_polling

Type

string

Default

""

Description: the value (in seconds) used to periodically contact the remote ecFlow server

Optional Property Config > scheduler > mirror_globalDT > remote_ssl

Type

boolean

Default

false

Description: to connect to the ecFlow server using SSL

Optional Property Config > scheduler > mirror_offline

Title: Settings to mirror offlineSFX

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- check_var

No

string

-

Remote variable (like YMD) that is checked for triggering. Leave empty if not required.

- mirror_name

No

string

-

Name for the mirror in ecflow

- remote_auth

No

string

-

the location to the Mirror authentication credentials file, if required

- remote_host

No

string

-

the remote ecFlow server host

- remote_path

No

string

-

the path of the node on the remote ecFlow server

- remote_port

No

string

-

the remote ecFlow server port

- remote_polling

No

string

-

the value (in seconds) used to periodically contact the remote ecFlow server

- remote_ssl

No

boolean

-

to connect to the ecFlow server using SSL

Optional Property Config > scheduler > mirror_offline > check_var

Type

string

Default

""

Description: Remote variable (like YMD) that is checked for triggering. Leave empty if not required.

Optional Property Config > scheduler > mirror_offline > mirror_name

Type

string

Default

""

Description: Name for the mirror in ecflow

Optional Property Config > scheduler > mirror_offline > remote_auth

Type

string

Default

""

Description: the location to the Mirror authentication credentials file, if required

Optional Property Config > scheduler > mirror_offline > remote_host

Type

string

Default

""

Description: the remote ecFlow server host

Optional Property Config > scheduler > mirror_offline > remote_path

Type

string

Default

""

Description: the path of the node on the remote ecFlow server

Optional Property Config > scheduler > mirror_offline > remote_port

Type

string

Default

""

Description: the remote ecFlow server port

Optional Property Config > scheduler > mirror_offline > remote_polling

Type

string

Default

""

Description: the value (in seconds) used to periodically contact the remote ecFlow server

Optional Property Config > scheduler > mirror_offline > remote_ssl

Type

boolean

Default

false

Description: to connect to the ecFlow server using SSL

Optional Property Config > scheduler > mirror_host_case

Title: Settings to mirror a host case

Type

object

Additional properties

Any type: allowed

Property

Pattern

Type

Definition

Title/Description

- check_var

No

string

-

Remote variable (like YMD) that is checked for triggering. Leave empty if not required.

- mirror_name

No

string

-

Name for the mirror in ecflow

- remote_auth

No

string

-

the location to the Mirror authentication credentials file, if required

- remote_host

No

string

-

the remote ecFlow server host

- remote_path

No

string

-

the path of the node on the remote ecFlow server

- remote_port

No

string

-

the remote ecFlow server port

- remote_polling

No

string

-

the value (in seconds) used to periodically contact the remote ecFlow server

- remote_ssl

No

boolean

-

to connect to the ecFlow server using SSL

Optional Property Config > scheduler > mirror_host_case > check_var

Type

string

Default

""

Description: Remote variable (like YMD) that is checked for triggering. Leave empty if not required.

Optional Property Config > scheduler > mirror_host_case > mirror_name

Type

string

Default

""

Description: Name for the mirror in ecflow

Optional Property Config > scheduler > mirror_host_case > remote_auth

Type

string

Default

""

Description: the location to the Mirror authentication credentials file, if required

Optional Property Config > scheduler > mirror_host_case > remote_host

Type

string

Default

""

Description: the remote ecFlow server host

Optional Property Config > scheduler > mirror_host_case > remote_path

Type

string

Default

""

Description: the path of the node on the remote ecFlow server

Optional Property Config > scheduler > mirror_host_case > remote_port

Type

string

Default

""

Description: the remote ecFlow server port

Optional Property Config > scheduler > mirror_host_case > remote_polling

Type

string

Default

""

Description: the value (in seconds) used to periodically contact the remote ecFlow server

Optional Property Config > scheduler > mirror_host_case > remote_ssl

Type

boolean

Default

false

Description: to connect to the ecFlow server using SSL

Optional Property Config > submission

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

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- account

No

string

-

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

No

string

-

Location of IAL binaries

- bindir_gl

No

string

-

Location of GL binary

- compiler

No

enum (of string)

-

Compiler used to build IAL

- precision

No

enum (of string)

-

Floating point precision as used in the Forecast task

- ial_version

No

string

-

Version of IAL binary to use

- gl_version

No

string

-

Version of GL binary to use

- nproma

No

number

-

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

- lfftw

No

boolean

-

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

- module_initfile

No

string

-

File to use for module initialization, overrides module_initpath

- module_initpath

No

string

-

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

- default_submit_type

No

string

-

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

- task_exceptions

No

object

-

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

- types

No

object

-

Submission types

- iomerge

No

object

-

IO-merge group

- submission_additionalProperties

No

object

-

-

Optional Property Config > submission > account

Type

string

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

Optional Property Config > submission > bindir

Type

string

Default

"@CASEDIR@/install/R64/bin"

Description: Location of IAL binaries

Optional Property Config > submission > bindir_gl

Type

string

Default

"@CASEDIR@/install/R64/bin/"

Description: Location of GL binary

Optional Property Config > submission > compiler

Type

enum (of string)

Default

"intel"

Description: Compiler used to build IAL

Must be one of:

  • “intel”

  • “gnu”

  • “”

Optional Property Config > submission > precision

Type

enum (of string)

Default

"R32"

Description: Floating point precision as used in the Forecast task

Must be one of:

  • “R32”

  • “R64”

  • “”

Optional Property Config > submission > ial_version

Type

string

Default

"latest"

Description: Version of IAL binary to use

Optional Property Config > submission > gl_version

Type

string

Default

"latest"

Description: Version of GL binary to use

Optional Property Config > submission > nproma

Type

number

Default

-32

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

Optional Property Config > submission > lfftw

Type

boolean

Default

true

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

Optional Property Config > submission > module_initfile

Type

string

Description: File to use for module initialization, overrides module_initpath

Optional Property Config > submission > module_initpath

Type

string

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

Optional Property Config > submission > default_submit_type

Type

string

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

Optional Property Config > submission > task_exceptions

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- Marsprep

No

object

-

Settings specific to Marsprep tasks

- TactusBundleBuild

No

object

-

Settings specific toTactusBundleBuild tasks

Optional Property Config > submission > task_exceptions > Marsprep

Type

object

Additional properties

Any type: allowed

Description: Settings specific to Marsprep tasks

Property

Pattern

Type

Definition

Title/Description

- ENV

No

object

-

Sets environment variables

Optional Property Config > submission > task_exceptions > Marsprep > ENV

Type

object

Additional properties

Any type: allowed

Default

{}

Description: Sets environment variables

Property

Pattern

Type

Definition

Title/Description

- MARS_MULTITARGET_STRICT_FORMAT

No

number

-

Strict format for multitarget operations

- MARS_READANY_BUFFER_SIZE

No

number

-

Reandomly buffer size in mars

Optional Property Config > submission > task_exceptions > Marsprep > ENV > MARS_MULTITARGET_STRICT_FORMAT

Type

number

Default

1

Description: Strict format for multitarget operations

Optional Property Config > submission > task_exceptions > Marsprep > ENV > MARS_READANY_BUFFER_SIZE

Type

number

Default

17893020000

Description: Reandomly buffer size in mars

Optional Property Config > submission > task_exceptions > TactusBundleBuild

Type

object

Additional properties

Any type: allowed

Description: Settings specific toTactusBundleBuild tasks

Property

Pattern

Type

Definition

Title/Description

- ENV

No

object

-

Sets environment variables

Optional Property Config > submission > task_exceptions > TactusBundleBuild > ENV

Type

object

Additional properties

Any type: allowed

Default

{}

Description: Sets environment variables

Property

Pattern

Type

Definition

Title/Description

- IAL_DIR

No

string

-

path to IAL_DIR

Optional Property Config > submission > task_exceptions > TactusBundleBuild > ENV > IAL_DIR

Type

string

Default

"@CASEDIR@/IAL"

Description: path to IAL_DIR

Optional Property Config > submission > types

Title: Submission types

Type

object

Additional properties

Any type: allowed

Description: Defines settings related to various groups

Property

Pattern

Type

Definition

Title/Description

- serial

No

object

-

Submission group

- parallel

No

object

-

Submission group

- background_vm

No

object

-

Submission group

- background_hpc

No

object

-

Submission group

- gnu

No

object

-

Submission group

- sqlite

No

object

-

Submission group

- Forecast_cpu

No

object

-

Submission group

- Forecast_gpu

No

object

-

Submission group

Optional Property Config > submission > types > serial

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > serial > tasks

Type

array of string

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 Property Config > submission > types > serial > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > serial > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > serial > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > serial > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > serial > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > serial > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > serial > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

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

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > parallel

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > parallel > tasks

Type

array of string

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 Property Config > submission > types > parallel > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > parallel > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > parallel > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > parallel > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > parallel > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > parallel > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > parallel > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > parallel > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > background_vm

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > background_vm > tasks

Type

array of string

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 Property Config > submission > types > background_vm > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > background_vm > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > background_vm > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > background_vm > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > background_vm > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > background_vm > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > background_vm > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > background_vm > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > background_hpc

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > background_hpc > tasks

Type

array of string

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 Property Config > submission > types > background_hpc > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > background_hpc > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > background_hpc > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > background_hpc > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > background_hpc > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > background_hpc > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > background_hpc > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > background_hpc > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > gnu

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > gnu > tasks

Type

array of string

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 Property Config > submission > types > gnu > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > gnu > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > gnu > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > gnu > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > gnu > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > gnu > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > gnu > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > gnu > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > sqlite

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > sqlite > tasks

Type

array of string

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 Property Config > submission > types > sqlite > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > sqlite > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > sqlite > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > sqlite > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > sqlite > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > sqlite > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > sqlite > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > sqlite > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > Forecast_cpu

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > Forecast_cpu > tasks

Type

array of string

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 Property Config > submission > types > Forecast_cpu > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > Forecast_cpu > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > Forecast_cpu > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > Forecast_cpu > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > Forecast_cpu > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > Forecast_cpu > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > Forecast_cpu > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > Forecast_cpu > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > types > Forecast_gpu

Title: Submission group

Type

object

Additional properties

Any type: allowed

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

Property

Pattern

Type

Definition

Title/Description

- tasks

No

array of string

-

List of tasks belonging to this group

+ SCHOST

No

string

-

Name of the host where the job runs

- NPROC

No

number

-

Number of processors for this task

- NPROC_IO

No

number

-

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

- WRAPPER

No

string

-

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

- BATCH

No

object

-

Sets batch job arguments like walltime

- ENV

No

object

-

Sets environment variables

- MODULES

No

object

-

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

Optional Property Config > submission > types > Forecast_gpu > tasks

Type

array of string

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 Property Config > submission > types > Forecast_gpu > SCHOST

Type

string

Description: Name of the host where the job runs

Restrictions

Min length

1

Optional Property Config > submission > types > Forecast_gpu > NPROC

Type

number

Description: Number of processors for this task

Optional Property Config > submission > types > Forecast_gpu > NPROC_IO

Type

number

Default

0

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

Optional Property Config > submission > types > Forecast_gpu > WRAPPER

Type

string

Default

""

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

Optional Property Config > submission > types > Forecast_gpu > BATCH

Type

object

Additional properties

Any type: allowed

Description: Sets batch job arguments like walltime

Optional Property Config > submission > types > Forecast_gpu > ENV

Type

object

Additional properties

Any type: allowed

Description: Sets environment variables

Optional Property Config > submission > types > Forecast_gpu > MODULES

Type

object

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

Pattern

Type

Definition

Title/Description

- ^(.*)$

Yes

array of string

-

-

Optional Pattern Property Config > submission > types > Forecast_gpu > MODULES > ^(.*)$

All properties whose name matches the regular expression ^(.*)$ (Test) must respect the following conditions

Type

array of string

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

Optional Property Config > submission > iomerge

Title: IO-merge group

Type

object

Additional properties

Any type: allowed

Description: Defines settings related to the iomerge task

Property

Pattern

Type

Definition

Title/Description

- age_limit

No

object

-

IO-merge processing wait limits

- files_expected

No

object

-

IO-merge file expectations

Optional Property Config > submission > iomerge > age_limit

Title: IO-merge processing wait limits

Type

object

Additional properties

Any type: allowed

Description: Time in seconds to wait before processing files.

Property

Pattern

Type

Definition

Title/Description

- forecast_directory

No

number

-

Time to wait for the Forecast directory

- fullpos

No

number

-

Fullpos files

- history

No

number

-

History files

- surfex

No

number

-

Surfex files

Optional Property Config > submission > iomerge > age_limit > forecast_directory

Type

number

Default

300

Description: Time to wait for the Forecast directory

Optional Property Config > submission > iomerge > age_limit > fullpos

Type

number

Default

15

Description: Fullpos files

Optional Property Config > submission > iomerge > age_limit > history

Type

number

Default

20

Description: History files

Optional Property Config > submission > iomerge > age_limit > surfex

Type

number

Default

15

Description: Surfex files

Optional Property Config > submission > iomerge > files_expected

Title: IO-merge file expectations

Type

object

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

Pattern

Type

Definition

Title/Description

- history

No

number

-

History files, 0 implies -1 as the number of files is highly output dependent.

- surfex

No

number

-

Surfex files, 0 implies nproc_io files

- fullpos

No

number

-

Fullpos files, 0 implies 1+nproc_io files

Optional Property Config > submission > iomerge > files_expected > history

Type

number

Default

-1

Description: History files, 0 implies -1 as the number of files is highly output dependent.

Optional Property Config > submission > iomerge > files_expected > surfex

Type

number

Default

0

Description: Surfex files, 0 implies nproc_io files

Optional Property Config > submission > iomerge > files_expected > fullpos

Type

number

Default

0

Description: Fullpos files, 0 implies 1+nproc_io files

Optional Property Config > vertical_levels

Title: Vertical Levels, defined in files under include/vertica_levels

Type

object

Additional properties

Any type: allowed

Description: Options for vertical levels

Property

Pattern

Type

Definition

Title/Description

- nlev

No

integer

-

Number of vertical full levels

- ahalf

No

array

-

Level definition for the a coefficient of half levels

- bhalf

No

array

-

Level definition for the b coefficient of half levels

- vertical_levels_additionalProperties

No

object

-

-

Optional Property Config > vertical_levels > nlev

Type

integer

Description: Number of vertical full levels

Optional Property Config > vertical_levels > ahalf

Type

array

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

Optional Property Config > vertical_levels > bhalf

Type

array

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


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.