Magic strings

ERT exposes some magic strings that can be used in your configuration file. These strings will at runtime be replaced with corresponding values, and can be useful if you need to use information such as file paths or experiment information such as realization or iteration number in your workflows or jobs.

Example:

YOUR_WORKFLOW_JOB <RUNPATH_FILE> <CONFIG_PATH>

Will be replaced with something similar to the following at runtime

YOUR_WORKFLOW_JOB /path/to/the/runpath/file/.ert_runpath_list /path/to/config/

In the following we separate between experiment constants, experiment variables and experiment dependent variables. Experiment constants are magic strings that do not change based on the iteration or realization number, while experiment variables will typically be replaced with different values depending on the current iteration or realization index. The dependent variables might also change (depending on whether variables are used in the definition), but the changes directly depend on the changes in the experiment variables.

It should also be noted that experiment variables can only be used with forward model jobs and not with workflows.

List of keywords

• Experiment constants

  • RUNPATH_FILE

  • CONFIG_PATH

  • CONFIG_FILE

  • CONFIG_FILE_BASE

  • CWD

  • DATE

• Experiment variables

  • IENS

  • ITER

• Experiment dependent variables

  • ECLBASE/ECL_BASE

  • RUNPATH

  • ERTCASE

Experiment constants

RUNPATH_FILE

Will be replaced with an absolute path to the RUNPATH_FILE.

Example:

YOUR_WORKFLOW_JOB <RUNPATH_FILE>

Will be replaced with the following at runtime:

YOUR_WORKFLOW_JOB /path/to/the/runpath/file/.ert_runpath_list

CONFIG_PATH

Will be replaced with the path to the directory containing the config file for the experiment.

Example:

YOUR_WORKFLOW_JOB <CONFIG_PATH>

Will be replaced with the following at runtime:

YOUR_WORKFLOW_JOB /path/to/config/

CONFIG_FILE

Will be replaced with the name of the config file for the experiment.

Example:

YOUR_WORKFLOW_JOB <CONFIG_FILE>

Will be replaced with the following at runtime:

YOUR_WORKFLOW_JOB example.ert

CONFIG_FILE_BASE

Will be replaced with the base name of the config file for the experiment. This is the filename without the extension.

Example:

YOUR_WORKFLOW_JOB <CONFIG_FILE_BASE>

Given that the filename is example.ert, this will be replaced with the following at runtime:

YOUR_WORKFLOW_JOB example

CWD

Will be replaced with the current working directory. This will usually be the same as the CONFIG_PATH.

Example:

YOUR_WORKFLOW_JOB <CWD>

Will be replaced with the following at runtime:

YOUR_WORKFLOW_JOB /data/repos/ert/test-data/poly_example

DATE

Will be replaced with the current date in ISO-8601 format (YYYY-MM-DD).

Experiment variables

Warning

The experiment variables cannot be used with workflows, only forward model jobs!

IENS

Will be replaced with the index for the current realization. The realization number uses zero-based indexing.

Example:

FORWARD_MODEL JOB_NAME(<ARG0>=<IENS>)

Will in the third realization be replaced with the following at runtime:

FORWARD_MODEL JOB_NAME(<ARG0>=2)

ITER

Will be replaced with the current iteration number. The iteration number uses zero-based indexing.

Example:

FORWARD_MODEL JOB_NAME(<ARG0>=<ITER>)

In the second iteration of your experiment, this will be replaced with the following at runtime:

FORWARD_MODEL JOB_NAME(<ARG0>=1)

Experiment dependent variables

ECLBASE / ECL_BASE

Will be replaced by the basename for the ECLIPSE simulations generated by ERT. See ECLBASE for more details. For none-Eclipse jobs this will be replaced by the job name (with an iteration identifier)

Example:

FORWARD_MODEL JOB_NAME(<ARG0>=<ECLBASE>)

Given that the ECLBASE has been specified using ECLBASE eclipse/model/OIL_FIELD-<IENS> in the config file, this will be replaced with the following in the second iteration:

FORWARD_MODEL JOB_NAME(<ARG0>="eclipse/model/OIL_FIELD-2")

RUNPATH

Will be replaced with the runpath for current iteration number and realization index.

Example:

FORWARD_MODEL JOB_NAME(<ARG0>=<RUNPATH>)

In the second iteration for the fifth realization, this will be replaced with the following at runtime:

FORWARD_MODEL JOB_NAME(<ARG0>="/your/run/path/realization-4/iter-1")

ERTCASE

Will be replaced with the current case name defined when starting the experiment.

Example:

RUNPATH output/<ERTCASE>/realization-<IENS>/iter-<ITER>

In this example when running the experiment and given that the user does not change the default case name the output folder created for realization 10 iteration 4 will be the following:

output/default/realization-10/iter-4