Configuration keys

Note

This section is automatically generated.

App

Schema for the app section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
OUTPATH	string	✅	string			Path to the output directory
ENERGY_INDICATORS	string		False True			If energy indicators enabled
ENERGY_OFFSHORE	string		False True			If energy offshore enabled
HYDROLAND	string		False True			If hydroland enabled
HYDROMET	string		False True			If hydromet enabled
WILDFIRES_FWI	string		False True			If wildfires FWI enabled
WILDFIRES_WISE	string		False True			If wildfires WISE enabled
OBSALL	string		False True			If OBSALL enabled
DATA	string		False True			If data workflow enabled
READ_FROM_DATABRIDGE	string		False True			If the data will be read from the databridge

AQUA

Schema for the AQUA section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
REGENERATE_CATALOGS	string	✅	False True			Flag to determine if catalogs should be regenerated.
CONTAINER_VERSION	string	✅	string			Specify the version of the container used in the workflow.
SOURCE_HL	string	✅	string			Source for hourly-native-hl data.
SOURCE_O2D	string	✅	string			Source for daily-hpz5-oce2d data.
SOURCE_O3D	string	✅	string			Source for daily-hpz5-oce3d data.
SOURCE_PL	string	✅	string			Source for hourly-hpz5-atm3d data.
SOURCE_SFC	string	✅	string			Source for hourly-hpz5-atm2d data.
SOURCE_SOL	string	✅	string			Source for hourly-native-sol data.
VARS_HL	string	✅	string			Variables for hourly-native-hl data.
VARS_O2D	string	✅	string			Variables for daily-hpz5-oce2d data.
VARS_O3D	string	✅	string			Variables for daily-hpz5-oce3d data.
VARS_PL	string	✅	string			Variables for hourly-hpz5-atm3d data.
VARS_SFC	string	✅	string			Variables for hourly-hpz5-atm2d data.
VARS_SOL	string	✅	string			Variables for hourly-native-sol data.
WORKERS_HL	integer	✅	integer			Number of workers for hourly-native-hl data.
WORKERS_O2D	integer	✅	integer			Number of workers for daily-hpz5-oce2d data.
WORKERS_O3D	integer	✅	integer			Number of workers for daily-hpz5-oce3d data.
WORKERS_PL	integer	✅	integer			Number of workers for hourly-hpz5-atm3d data.
WORKERS_SFC	integer	✅	integer			Number of workers for hourly-hpz5-atm2d data.
WORKERS_SOL	integer	✅	integer			Number of workers for hourly-native-sol data.
RESOLUTION_OCE	string	✅	string			Resolution for ocean data.
RESOLUTION_ATM	string	✅	string			Resolution for atmosphere data.
BUCKET	string		string			Bucket to push the data in AQUA-push.

Experiment

Schema for the Experiment section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
DATELIST	integer	✅	integer			List of dates to run the simulation.
CHUNKSIZEUNIT	string	✅	hour day month year			Unit of the chunk size.
CHUNKSIZE	integer	✅	integer			Size of the chunk, in CHUNKSIZEUNITs.
NUMCHUNKS	integer	✅	integer			Number of chunks to run.
CALENDAR	string	✅	noleap standard			Calendar to use.
MEMBERS	string		string			Name of ensemble members. (Example: fc0 fc1 fc2)

GSV

Schema for the GSV section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
VERSION	string	✅	string		"2.6.0"	Specify the version of the GSV_interface container used in the workflow.
WEIGHTS_PATH	string	✅	string		"%CONFIGURATION.HPC_PROJECT_DIR%/gsv_files/gsv_weights"	Path to the weights.
TEST_FILES	string	✅	string		"%CONFIGURATION.HPC_PROJECT_DIR%/gsv_files/gsv_test_files"	Path to the test files.
DEFINITION_PATH	string	✅	string		"%CONFIGURATION.HPC_PROJECT_DIR%/gsv_files/grid_definitions"	Path to the grid definitions.

Jobs

Schema for the jobs section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
LOCAL_SETUP	object	✅	object
REMOTE_SETUP	object	✅	object
SYNCHRONIZE	object	✅	object
INI	object		object
SIM	object		object
CHECK_MEM	object		object
DQC_BASIC	object		object
DQC_FULL	object		object
LRA_GENERATOR	object		object			Job for generating the Low Resolution Archive (LRA).
AQUA_ANALYSIS	object		object
AQUA_PUSH	object		object
CLEAN	object		object
APP_DATA	object		object

Request

Request that is used by APPS to retrieve data from the fdb, and for the MODEL to find the correct data in the fdb (used in DQC, AQUA).

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
CLASS	string	✅	d1 rd			Experiment class for data government. d1 is production(?), rd is research.
EXPVER	string	✅	^[A-Za-z0-9]{4}$			Experiment version string used to identify experiments. Needs to be 0001 for production experiments.
FDB_HOME	string	✅	string			Home directory of the fdb that is to be used.
ACTIVITY	string	✅	baseline projections			Activity key in the FDB
REALIZATION	integer	✅	integer			Realization key in the FDB
GENERATION	integer	✅	1 2			Generation key in the FDB
EXPERIMENT	string	✅	cont hist SSP3-7.0			Experiment key in the FDB
MODEL	string	✅	icon ifs-nemo ifs-fesom			Model key in the FDB
INFO_FILE_PATH	string		string			Path to the FDB directory within the experiment folder
INFO_FILE_NAME	string		string			Path to the YAML file within the FDB directory of the experiment folder
RESOLUTION	string		standard high			Sets the resolution

Platforms

Schema for the platforms section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
LUMI	object	✅	object
LUMI-LOGIN	object	✅	object
LUMI-TRANSFER	object	✅	object
MARENOSTRUM5	object	✅	object
MARENOSTRUM5-LOGIN	object	✅	object

Configuration section

Schema for the configuration section of the workflow

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
ADDITIONAL_JOBS	object	✅	object
CONTAINER_DIR	string		string		"%CURRENT_HPC_PROJECT_ROOT%/%CURRENT_PROJECT%/containers"	Path to the directory where the containers are stored.
PROJECT_SCRATCH	string		string		"%CURRENT_SCRATCH_DIR%/%CURRENT_PROJECT%"	Path to the directory where the project’s scratch is stored.
LIBDIR	string		string		"%HPCROOTDIR%/%PROJECT.PROJECT_DESTINATION%/lib"	Path to the directory where the lib directory is, inside the repo.
SCRIPTDIR	string		string		"%HPCROOTDIR%/git_project/runscripts"	Path to the directory where the runscripts are stored.
HPC_PROJECT_DIR	string		string		"%CURRENT_HPC_PROJECT_ROOT%/%CURRENT_PROJECT%"	Path to the directory under projects (not scratch) of the HPC project in use.
FDB_DIR	string		string		"%CURRENT_SCRATCH_DIR%/%CURRENT_PROJECT%/experiments"	Path to the experiments folder of the project. It is used by research and test experiments.
IO_ON	string		False True			False will disable the flags for IO in order to run without output in IFS-NEMO experiments.
RAPS_EXPERIMENT	string		control hist SSP370 Tplus2.0K			Specifies which experiment to run and RAPS associates the corresponding ACTIVITY.
RAPS_USER_FLAGS	string		string			Flags for RAPS.
ICMCL	string		biweekly monthly yearly yearly_extra generic			Chunking of the ICMCL (surface conditions for IFS) to be loaded in IFS-based models
DQC_PROFILE	string		develop production lowres			Profile to be used for the data quality checker.
DQC_PROFILE_ROOT	string		string		"%HPCROOTDIR%/profiles"	Path to the profiles directory, generated in the REMOTE_SETUP, and used in the DQC, TRANSFER, WIPE and CLEAN.
DQC_PROFILE_PATH	string		string			Path to the specific DQC profile to be used.
DATA_PORTFOLIO	string		full reduced			Used to determine the set of variables in the data portfolio.
DOWNLOAD_ADDITIONAL_DEPENDENCIES	string		False True			If True, in Local Setup, downloads RAPS or other dependencies.
GENERATE_PROFILES	string		False True			If True, in Remote Setup, generates data profiles from the GSV.
INPROOT_CHECKER	string		False True			If True, in Remote Setup, checks the inputs.
LOAD_FDB	string		False True			If True, in Remote Setup, loads the FDB.
CREATE_FDB_INFO_FILE	string		False True			If True, in Remote Setup, creates the FDB info file.
IFS	object		object

Model Icon

Schema for the MODEL section of the workflow, if the model is ICON.

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
NAME	string	✅	icon
ROOT_PATH	string	✅	string			Path to the root of the model directory where the different models and there different versions are stored by default.
PATH	string	✅	string			Path to the model directory, where the version of the model that you will use is/will be stored.
INPUTS	string	✅	string			Path to the directory where the input files are stored.
COMPILE	string	✅	False True			If the model will be compiled before running it.
GRID_ATM	string	✅	r2b4			Grid for the atmosphere model.
GRID_OCE	string	✅	r2b4			Grid for the ocean model.
SIMULATION	string	✅	test-icon			Simulation to run.

IFS-based MODELS

Schema for the MODEL section of the workflow for IFS-based models

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
NAME	string	✅	ifs-fesom ifs-nemo			Name of the model to run the simulation.
ROOT_PATH	string	✅	string			Path to the root of the model directory where the different models and there different versions are stored by default.
PATH	string	✅	string			Path to the model directory, where the version of the model that you will use is/will be stored.
INPUTS	string	✅	string			Path to the directory where the input files are stored.
COMPILE	string	✅	False True			If the model will be compiled before running it.
GRID_ATM	string	✅	tco79l137 tc0399l137 tco1279l137 tco2559l137			Grid for the atmosphere model.
SIMULATION	string	✅	control-ifs-nemo test-ifs-nemo ifs-fesom-projection-tco2559 historical-ifs-nemo SSP370-ifs-nemo			Simulation to run.
ICMCL_PATTERN	string	✅	string			Pattern to search for the ICMCL files.
GRID_OCE	string		eORCA1_Z75 eORCA12_Z75			Grid for the ocean model.
DVC_INPUTS_BRANCH	string		string			Branch of the DVC repository where the input files are stored.
USE_FIXED_DVC_COMMIT	string		False True			If set to true, the version used is the one pinned as a submodule by the workflow. If set to false, the value of MODEL.DVC_INPUTS_BRANCH (branch or commit) is checked out in the local setup.
RESTARTS_FROM_PATH	string		string			Path to the directory where the restart files from a previous simulation are stored.
BUNDLE_BUILD_DIR	string		string			Path to the directory where the IFS/NEMO bundle is or will be built.
BUNDLE_SOURCE_DIR	string		string			Path to the directory where the IFS/NEMO bundle source code is stored.
FDB_DIRS	string		string			Path to the directory of the native, healpix and latlon FDB.
RAPS	object		object			RAPS flags to be used in the simulation.