Running ERT¶

Graphical User Interface (GUI)¶

Opens an independent graphical user interface for the user to interact with ERT.

usage: ert gui [-h] [--verbose] config

Positional Arguments¶

config: ERT configuration file

Named Arguments¶

--verbose

Show verbose output.

Default: False

Command Line Interface (CLI)¶

The following sub commands can be used in order to use ERT’s command line interface. Note that different sub commands may require different additional arguments.

Test Run¶

Run ‘test_run’ in cli

usage: ert test_run [-h] [--current-case CURRENT_ENSEMBLE]
                    [--current-ensemble CURRENT_ENSEMBLE] [--verbose]
                    [--color-always] [--disable-monitoring]
                    [--port-range PORT_RANGE]
                    config

Positional Arguments¶

config: ERT configuration file

Named Arguments¶

--current-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –current-ensemble instead.

Default: default

--current-ensemble

Name of the ensemble where the results for the experiment using the prior parameters will be stored.

Default: default

--verbose

Show verbose output.

Default: False

--color-always

Force coloring of monitor output, which is automatically disabled if the output stream is not a terminal.

Default: False

--disable-monitoring

Monitoring will continuously print the status of the realisations classified into Waiting, Pending, Running, Failed, Finished and Unknown.

Default: False

--port-range

Port range [a,b] to be used by the evaluator. Format: a-b

Ensemble Experiment¶

Run experiments in cli without performing any updates on the parameters.

usage: ert ensemble_experiment [-h] [--realizations REALIZATIONS]
                               [--current-case CURRENT_ENSEMBLE]
                               [--current-ensemble CURRENT_ENSEMBLE]
                               [--experiment-name EXPERIMENT_NAME] [--verbose]
                               [--color-always] [--disable-monitoring]
                               [--port-range PORT_RANGE]
                               config

Positional Arguments¶

config: ERT configuration file

Named Arguments¶

--realizations

These are the realizations that will be used to perform experiments. For example, if ‘Number of realizations:50 and Active realizations is 0-9’, then only realizations 0,1,2,3,…,9 will be used to perform experiments while realizations 10,11, 12,…,49 will be excluded.

--current-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –current-ensemble instead.

Default: default

--current-ensemble

Name of the ensemble where the results for the experiment using the prior parameters will be stored.

Default: default

--experiment-name

Name of the experiment

Default: 'ensemble-experiment'

--verbose

Show verbose output.

Default: False

--color-always

Force coloring of monitor output, which is automatically disabled if the output stream is not a terminal.

Default: False

--disable-monitoring

Monitoring will continuously print the status of the realisations classified into Waiting, Pending, Running, Failed, Finished and Unknown.

Default: False

--port-range

Port range [a,b] to be used by the evaluator. Format: a-b

Ensemble Smoother¶

Run experiments in cli while performing one update on the parameters by using the ensemble smoother algorithm.

usage: ert ensemble_smoother [-h] [--current-case CURRENT_ENSEMBLE]
                             [--current-ensemble CURRENT_ENSEMBLE]
                             [--target-case TARGET_ENSEMBLE]
                             [--target-ensemble TARGET_ENSEMBLE]
                             [--realizations REALIZATIONS]
                             [--experiment-name EXPERIMENT_NAME] [--verbose]
                             [--color-always] [--disable-monitoring]
                             [--port-range PORT_RANGE]
                             config

Positional Arguments¶

config: ERT configuration file

Named Arguments¶

--current-case

Deprecated: This argument is deprecated and has no effect.

Default: default

--current-ensemble

This argument is deprecated and has no effect.

Default: default

--target-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –target-ensemble instead.

Default: iter-%d

--target-ensemble

Name of the ensemble where the results for the updated parameters will be stored.

Default: iter-%d

--realizations

These are the realizations that will be used to perform experiments.For example, if ‘Number of realizations:50 and Active realizations is 0-9’, then only realizations 0,1,2,3,…,9 will be used to perform experiments while realizations 10,11, 12,…,49 will be excluded

--experiment-name

Name of the experiment

Default: 'es'

--verbose

Show verbose output.

Default: False

--color-always

Force coloring of monitor output, which is automatically disabled if the output stream is not a terminal.

Default: False

--disable-monitoring

Monitoring will continuously print the status of the realisations classified into Waiting, Pending, Running, Failed, Finished and Unknown.

Default: False

--port-range

Port range [a,b] to be used by the evaluator. Format: a-b

Iterative Ensemble Smoother¶

Run experiments in cli while performing updates on the parameters using the iterative ensemble smoother algorithm.

usage: ert iterative_ensemble_smoother [-h] [--current-case CURRENT_ENSEMBLE]
                                       [--current-ensemble CURRENT_ENSEMBLE]
                                       [--target-case TARGET_ENSEMBLE]
                                       [--target-ensemble TARGET_ENSEMBLE]
                                       [--realizations REALIZATIONS]
                                       [--num-iterations NUM_ITERATIONS]
                                       [--experiment-name EXPERIMENT_NAME]
                                       [--verbose] [--color-always]
                                       [--disable-monitoring]
                                       [--port-range PORT_RANGE]
                                       config

Positional Arguments¶

config: ERT configuration file

Named Arguments¶

--current-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –current-ensemble instead.

Default: default

--current-ensemble

Name of the ensemble where the results for the experiment using the prior parameters will be stored.

Default: default

--target-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –target-ensemble instead.

Default: iter-%d

--target-ensemble

The iterative ensemble smoother creates multiple ensembles for the different iterations. The ensemble names will follow the specified format. For example, ‘Target ensemble format: iter_%d’ will generate ensembles with the names iter_0, iter_1, iter_2, iter_3, ….

Default: iter-%d

--realizations

These are the realizations that will be used to perform experiments.For example, if ‘Number of realizations:50 and active realizations are 0-9’, then only realizations 0,1,2,3,…,9 will be used to perform experiments while realizations 10,11, 12,…,49 will be excluded.

--num-iterations

The number of iterations to run.

--experiment-name

Name of the experiment

Default: 'ies'

--verbose

Show verbose output.

Default: False

--color-always

Force coloring of monitor output, which is automatically disabled if the output stream is not a terminal.

Default: False

--disable-monitoring

Monitoring will continuously print the status of the realisations classified into Waiting, Pending, Running, Failed, Finished and Unknown.

Default: False

--port-range

Port range [a,b] to be used by the evaluator. Format: a-b

ES MDA¶

Run ‘es_mda’ in cli

usage: ert es_mda [-h] [--target-case TARGET_ENSEMBLE]
                  [--target-ensemble TARGET_ENSEMBLE]
                  [--realizations REALIZATIONS] [--weights WEIGHTS]
                  [--restart-case RESTART_ENSEMBLE_ID]
                  [--restart-ensemble RESTART_ENSEMBLE_ID]
                  [--restart-ensemble-id RESTART_ENSEMBLE_ID]
                  [--experiment-name EXPERIMENT_NAME] [--verbose]
                  [--color-always] [--disable-monitoring]
                  [--port-range PORT_RANGE]
                  config

Positional Arguments¶

config: ERT configuration file

Named Arguments¶

--target-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –target-ensemble instead.

--target-ensemble

The es_mda creates multiple ensembles for the different iterations. The ensemble names will follow the specified format. For example, ‘Target ensemble format: iter-%d’ will generate ensembles with the names iter-0, iter-1, iter-2, iter-3, ….

--realizations

--weights

Example custom relative weights: ‘8,4,2,1’. This means multiple data assimilation ensemble smoother will half the weight applied to the observation errors from one iteration to the next across 4 iterations.

Default: 4, 2, 1

--restart-case

Deprecated: This argument is deprecated and will be removed in future versions. Use –restart-ensemble instead.

--restart-ensemble

Deprecated: This argument is deprecated and will be removed in future versions. Use –restart-ensemble-id instead.

--restart-ensemble-id

UUID of the ensemble where the results for the experiment using the prior parameters will be stored. Iteration number is read from this ensemble. If provided this will be a restart a run

--experiment-name

Name of the experiment

Default: es-mda

--verbose

Show verbose output.

Default: False

--color-always

Force coloring of monitor output, which is automatically disabled if the output stream is not a terminal.

Default: False

--disable-monitoring

Monitoring will continuously print the status of the realisations classified into Waiting, Pending, Running, Failed, Finished and Unknown.

Default: False

--port-range

Port range [a,b] to be used by the evaluator. Format: a-b

Workflow¶

Executes the workflow given

usage: ert workflow [-h] [--ensemble ENSEMBLE] [--verbose] [--color-always]
                    [--disable-monitoring] [--port-range PORT_RANGE]
                    name config

Positional Arguments¶

name: Name of workflow
config: ERT configuration file

Named Arguments¶

--ensemble

Which ensemble to use

--verbose

Show verbose output.

Default: False

--color-always

Force coloring of monitor output, which is automatically disabled if the output stream is not a terminal.

Default: False

--disable-monitoring

Monitoring will continuously print the status of the realisations classified into Waiting, Pending, Running, Failed, Finished and Unknown.

Default: False

--port-range

Port range [a,b] to be used by the evaluator. Format: a-b