Workflow jobs

These are the workflow jobs installed in your ERT environment. To use them in the configuration file they must be included in a workflow and loaded in the configuration file as shown in Configure Workflows

Observations

Correlation

EXPORT_MISFIT_DATA

Will export misfit per observation and realization to a hdf file.

The hdf file has the observation as key, and the misfit as values. The filename is “misfit.hdf” by default, but can be overridden by giving the filename as the first parameter:

EXPORT_MISFIT_DATA path/to/output.hdf

The misfit its calculated as follows:

((response_value - observation_data) / observation_std)**2

Category
observations.correlation
Source package
plugins.hook_implementations.workflows.export_misfit_data

MISFIT_PREPROCESSOR

MISFIT_PREPROCESSOR is removed, use ANALYSIS_SET_VAR OBSERVATIONS AUTO_SCALE.

Example:

ANALYSIS_SET_VAR OBSERVATIONS AUTO_SCALE * – all observations”

Category
observations.correlation
Source package
plugins.hook_implementations.workflows.misfit_preprocessor

Other

Other

EXPORT_RUNPATH

The EXPORT_RUNPATH workflow job writes the runpath file.

The job can have no arguments, or one can set a range of realizations and a range of iterations as arguments. Note: no check is made for whether the corresponding runpath has been created.

Example usage of this job in a workflow:

EXPORT_RUNPATH

With no arguments, entries for iterations 0 and all realizations are written to the runpath file. The job can also be given ranges of iterations and realizations to run:

EXPORT_RUNPATH 0-5 | *

“|” is used as a delimiter to separate realizations and iterations. “*” can be used to select all realizations or iterations. In the example above, entries for realizations 0-5 for all iterations are written to the runpath file.

Category
other
Source package
plugins.hook_implementations.workflows.export_runpath

DISABLE_PARAMETERS

The DISABLE_PARAMETERS workflow has been deprecated and removed.

Add

GEN_KW <name> … UPDATE:FALSE

to the configuration instead.

Category
other
Source package
plugins.hook_implementations.workflows.disable_parameters

CSV_EXPORT

Export of summary, misfit, design matrix data and gen kw into a single CSV file.

The script expects a single argument:

output_file: this is the path to the file to output the CSV data to

Optional arguments:

ensemble_list: a JSON string representation of a dictionary where keys are

UUID strings and values are ensemble names. A single * can be used to export all ensembles

design_matrix: a path to a file containing the design matrix

The script also looks for default values for output path and design matrix path to present in the GUI. These can be specified with DATA_KW keyword in the config file:

DATA_KW <CSV_OUTPUT_PATH> {some path} DATA_KW <DESIGN_MATRIX_PATH> {some path}

Category
other
Source package
plugins.hook_implementations.workflows.csv_export

GEN_DATA_RFT

Export of GEN_DATA based RFT responses to a CSV file. The csv file will

in addition contain the depth as duplicated seperate row.

The script expects four arguments:

output_file: this is the path to the file to output the CSV data to

key: this is the ert GEN_DATA key used for this particular RFT.

report_step: This is the report step configured in the ert

configuration file for this RFT.

trajectory_file: This is the the file containing the

Optional arguments:

ensemble_data_as_json: a comma separated list of ensembles to

export (no spaces allowed). If no list is provided the current ensemble is exported

Category
other
Source package
plugins.hook_implementations.workflows.gen_data_rft_export

Utility

File_system

MAKE_DIRECTORY

Will create the directory <DIRECTORY>, with all sub directories.

Category
utility.file_system
Source package
ert

MOVE_DIRECTORY

MOVE_DIRECTORY will move a directory. If the target directory already exists, it will be replaced.

Category
utility.file_system
Source package
ert

CAREFUL_COPY_FILE

CAREFUL_COPY_FILE will copy a file. If the <TO> argument has a directory component, that directory will be created. This is an extension of the normal cp command which will not create directories in this way. This supersedes an older version called CAREFULL_COPY and should be used instead.

Category
utility.file_system
Source package
ert

COPY_FILE

Copies file from <FROM> to <TO>. If no directory is specified in <TO>, the file will be copied to RUNPATH. If the <TO> argument includes a directory component, that directory will be created. Unlike the standard cp command, this will automatically create any missing directories in the destination path.

Category
utility.file_system
Source package
ert

MOVE_FILE

MOVE_FILE will move file to target directory. If file already exists, it will move the file to the target directory and then replace the existing file.

Category
utility.file_system
Source package
ert

COPY_DIRECTORY

Copies the directory <FROM> to the target <TO>. If <TO> points to a non-existing directory structure, it will be created first. If the <TO> folder already exist it creates a new directory within the existing one. E.g. COPY_DIRECTORY (<FROM>=foo, <TO>=bar) creates bar/foo if the directory bar already exists. If bar does not exist it becomes a copy of foo.

Category
utility.file_system
Source package
ert

DELETE_DIRECTORY

DELETE_DIRECTORY will recursively remove a directory and all the files in the directory. Like DELETE_FILE it will only delete files and directories which are owned by the current user. If one delete operation fails it will continue, but unless all delete calls succeed (parts of) the directory structure will remain.

Warning

If the directory to delete is a symlink to a directory, it will only delete the link and not the directory. However, if you add a trailing slash to the directory name (the symlink), then the link itself is kept, but the directory it links to will be removed.

Category
utility.file_system
Source package
ert

DELETE_FILE

DELETE_FILE will only remove files which are owned by the current user, even if file system permissions would have allowed the delete operation to proceed. The DELETE_FILE will not delete a directory, and if presented with a symbolic link it will only delete the link, and not the target.

Category
utility.file_system
Source package
ert