Command Line Interface¶
Tool for performing reservoir management optimization
usage: everest <command> [<args>]
The most commonly used everest commands are:
branch Construct possible restart config file
export Export data from a completed optimization case
gui Start the graphical user interface (Removed)
kill Kill a running optimization case base on given config file
lint Validate a config file
monitor Monitor a running optimization case base on given config file
render Display the configuration data loaded from a config file
results Start everest visualization plugin
run Start an optimization case base on given config file
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¶
Everest console runner, start an optimization case based on a given config file
usage: everest run <config_file> [arguments]
Positional Arguments¶
- config
The path to the everest configuration file
Named Arguments¶
- --new-run
Run the optimization even though results are already available
Default:
False- --gui
Spawn a GUI monitoring simulation statuses.
Default:
False- --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- --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
Closing the console used to start the optimization case while it is running will not terminate the optimization process. To continue monitoring the running optimization use the command everest monitor config_file.yml. To stop a running optimization use everest kill config_file.yml.
Everest monitor¶
Everest console monitor a running optimization case based on a config file
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
Closing the console while monitoring the optimization case will not terminate the optimization process.
Using again the command everest monitor config_file.yml, will reattach to the optimization case and display the optimization progress from the point it has reached.
Everest kill¶
Kill a running optimization case based on a given config file
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 export¶
The everest export has been removed. All data is now always exported to the optimization output directory.
Everest lint¶
Check if a config file is valid
usage: everest lint <config_file>
Positional Arguments¶
- config_file
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 new config file with updated controls from specified simulation batch number Warning: Previous simulation output folder will be overwritten if it was placed outside the everest output folder
usage: everest branch <config_file> <new_config_file> -b #
Positional Arguments¶
- input_config
The path to the everest configuration file
- output_config
The path to the new everest file
Named Arguments¶
- -b, --batch
Batch id from which to retrieve control values
Description
The everest branch command is designed to help users quickly create a new config file based on a previous config file used in an optimization experiment.
The user is required to provide an existing batch number form the previous optimization experiment.
The newly created config file will contain updated values for the control’s initial guesses.
The new values for the control’s initial guess will be the control values associated with the given batch number in the previous optimization case.
Warning Removing the optimization output folder before running the branch will make the command unable to successfully execute
The branch command does not provide optimization experiment restart functionality. Starting an optimization case based on the newly created config file is considered an new optimization experiment.
Everest results¶
Start possible plugin containing everest visualization
usage: everest results <config_file>
Positional Arguments¶
- config_file
The path to the everest configuration file
If no visualization plugin is installed the message:
No visualization plugin installed! will be displayed in the console.
Plugin¶
The recommended open-source everest visualization plugin is Everviz
It can be installed using pip
pip install everviz