Command Line Interface¶
everest¶
Tool for performing reservoir management optimization.
usage: everest <command> [<args>]
Supported commands:
run Start an optimization run
monitor Monitor a running optimization
kill Kill a running optimization
lint Validate the configuration file
render Display the configuration data
branch Construct a new configuration file from a given batch
results Start the everest plotter
The visualization module is imported lazily to avoid requiring
optional GUI dependencies for CLI commands that do not use it.
Run everest <command> --help for more information on a command
Positional Arguments¶
- command
Subcommand to run
Named Arguments¶
- --version
show program’s version number and exit
everest run¶
Start an optimization run.
Closing the console or interrupting the everest run process does not terminate the optimization. To continue monitoring the running optimization, use everest monitor config_file.yml. To stop a running optimization, use everest kill config_file.yml.
usage: everest run <config_file> [arguments]
Positional Arguments¶
- config
The path to the everest configuration file.
Named Arguments¶
- --new-run
DEPRECATED: This option is deprecated and has no effect. Update your scripts accordingly.
Default:
False- --gui
Spawn a GUI monitoring simulation statuses.
Default:
False- --debug
Display debug information in the terminal.
Default:
False- --show-all-jobs
DEPRECATED: This option no longer has an effect, and will be removed in a future version.
Default:
False- --skip-prompt
Flag used to disable user prompts that will stop execution.
Default:
False- --disable-monitoring
Disable monitoring of the optimization run. This will reduce the output to the terminal.
Default:
False
everest monitor¶
Monitor a running optimization process.
Closing the console or interrupting the everest run process does not terminate the optimization process. To continue monitoring the running optimization, use everest monitor config_file.yml. To stop a running optimization, use everest kill config_file.yml.
usage: everest monitor <config_file>
Positional Arguments¶
- config
The path to the everest configuration file.
Named Arguments¶
- --debug
Display debug information in the terminal.
Default:
False- --show-all-jobs
This option no longer has an effect, and will be removed in a future version.
Default:
False
everest kill¶
Kill a running optimization process.
usage: everest kill <config_file>
Positional Arguments¶
- config
The path to the everest configuration file.
Named Arguments¶
- --debug
Display debug information in the terminal.
Default:
False
everest lint¶
Check if a configuration file is valid.
usage: everest lint <config_file>
Positional Arguments¶
- config
The path to the everest configuration file.
Named Arguments¶
- -v, --verbose
Display verbose errors and warnings.
Default:
False
everest render¶
Display the configuration data loaded from a config file after replacing templated arguments.
usage: everest show <config_file>
Positional Arguments¶
- config_file
The path to the everest configuration file.
everest branch¶
Create a configuration file with updated controls based on a previous run.
The everest branch command reads an existing configuration and creates a new configuration file, with initial control values taken from a batch of a previous optimization run.
Warning: Do not remove the optimization output folder before running the branch command or it will fail.
Note: The branch command does not provide true restart functionality. The new config file merely sets new initial controls defined by the given batch. Subsequent optimization runs will likely produce slightly different results.
usage: everest branch <config_file> <new_config_file> -b #
Positional Arguments¶
- config
The path to the everest configuration file.
- output_config
The path to the new everest configuration file.
Named Arguments¶
- -b, --batch
ID of the batch providing the new control values.
everest results¶
Start the plotter for for Everest data.
usage: everest results <config_file>
Positional Arguments¶
- config
The path to the everest configuration file.
Named Arguments¶
- --ert_plotter
No-op option, ert_plotter is already default.
Default:
False
everest export¶
The everest export command has been removed. All data is now always exported
to the optimization output directory.
everest gui¶
The everest gui has been removed. Please use everest run --gui instead.