Command Line Interface

ResInsight supports several command line parameters that can be used to automate some tasks using shell scripts.

Command line parameters are prefixed using a double dash. This convention is used on all platforms to make it possible to reuse scripts across different platforms. See GNU Standards for Command Line Interfaces.

Examples on how command line options are used are given below

Command line options

General

Parameter Description
--help, --? Displays help text and version info
--project <filename> Open project file <filename>.
--last Open last used project.
--size <width> <height> Set size of the main application window.
--console Launch as a console application without graphics
--server [<portnumber>] Launch as a GRPC server. Default port is 50051
--startdir <folder> Set startup directory.

Command files

Parameter Description
--commandFile <commandFile> Execute a command file. See command file documentation.
--commandFileProject <filename> Project to use if performing case looping for command file. Used in conjunction with commandFileReplaceCases.

Snapshots

Parameter Description
--savesnapshots all|views|plots| Save snapshot of all views or plots to project file location sub folder ‘snapshots’. Option ‘all’ will include both views and plots. Application closes after snapshots have been written.
--multiCaseSnapshots <gridListFile> For each grid file listed in the <gridListFile> file, replace the first case in the project and save snapshot of all views.

Case handling

Parameter Description
--case <casename|filename> [<casename|filename>] Imports the Eclipse cases specified by case name with or without extension.If <casename>, import the corresponding grid file and summary file. If <filename> has extension .GRRID/.EGRID, import the grid file and corresponding summary file. If <filename> has extension .SMSPEC, import the summary file (does not open the grid file)
--replaceCase [<caseId>] <newGridFile> Replace grid in <caseId> or first case with <newGridFile>. Repeat parameter for multiple replace operations.
--replaceSourceCases [<caseGroupId>] <gridListFile> Replace source cases in <caseGroupId> or first grid case group with the grid files listed in the <gridListFile> file. Repeat parameter for multiple replace operations.
--commandFileReplaceCases [<caseId>] <caseListFile> Supply list of cases to replace in project, performing command file for each case. Project to replace cases must be set with commandFileProject. If caseId is not supplied, first case is replaced. When supplying caseId, multiple cases may be replaced at once, by supplying several caseIds and a file containing a list of grid-files to replace with for each caseId.

Reduce project load time using –replaceSourceCases
ResInsight stores data computed by statistics calculation in a cache file. When a project file is loaded, data from this cache is also imported. For large cases, the cached data can be large. When replacing source cases during batch, this data is never used and can be removed from the cache using the following workaround:

  • Open the project file used to produce statistics
  • Select the statistics object in the project tree
  • Click the button Edit (Will DELETE current result)
  • Save the project file

Summary plotting

The summary plotting command option follows the following syntax:

resinsight --summaryplot [<plotOptions>] <eclipsesummaryvectorfilters> <eclipsedatafiles>

where:
<plotOptions>                 denote summary plot options, see table below
<eclipsesummaryvectorfilters> has the syntax <vectorname>[:<item>[:<subitem>[:i,j,k]]]
<eclipsedatafiles>            lists a set of Eclipse data files with or without extension

The summary plotting command option creates one summary plot for each of the the summary vectors matched by
<eclipsesummaryvectorfilters> using all listed Eclipse data files in each plot.

Eclipse summary vector filters specify a list of vectors separated by spaces following the syntax noted above. Wildcards can be used in the specification. Brief examples are:

  • WOPT:*: One total oil production curve for each well.
  • FOPT FWPT: Two curves with oil and water total production.
  • BPR:15,28,*: Oil phase pressure for all blocks along k as separate curves. Please note no space in expression.

Examples are listed below.

As long as only summary vectors are requested, only the corresponding SMSPEC file will be opened for each case. However, if a grid property is requested, the corresponding EGRID and restart data will be loaded as well.

Specifying summary plot options is optional, c.f. table below.

Option Description
-help Shows help text and ignores any other option.
-h Includes history vectors read from summary file if the vectors exist. Only history vectors from the first summary case in the project will be included.
-nl Omits legend in plot.
-s Creates only one plot including all the defined vectors and cases.
-n Scales all curves into the range 0.0-1.0. Useful when using -s.
-e Imports all the cases as an ensemble, and create ensemble curves sets instead of single curves.
-c <parametername> Same as -e, but colors the curves by the ensemble parameter .
-cl <parametername> Same as -c, but uses logarithmic legend.

Testing

Parameter Description
--regressiontest <folder> System command
--updateregressiontestbase <folder> System command
--unittest Execute integration tests
--ignoreArgs System command

See also the Regression Test System for a more in-depth explanation.

Examples

Most examples are also available from the test section.

Create snapshots of all views for multiple cases

A list of cases is defined in CaseList.txt, containing the following

Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
Real30/BRUGGE_0030.EGRID
Real40/BRUGGE_0040.EGRID

The command line used to run this example is shown here:

ResInsight --project BatchTest.rsp --multiCaseSnapshots CaseList.txt --size 500 500

This will instruct ResInsight to read the project file BatchTest.rsp. All cases will be replaced one by one in ResInsight, and snapshots of all views will be written to file.

Replace a single case and take snapshots of all views

The command line used to run this example is shown here:

ResInsight --project BatchTest.rsp --replaceCase "Real10\BRUGGE_0010.EGRID" --savesnapshots

This will instruct ResInsight to read the project file BatchTest.rsp. The specified case Real10\BRUGGE_0010.EGRID will be imported into the project, and snapshots of all views will be written to file.

Replace source cases in a case group and create snapshot

A list of cases is defined in CaseList2.txt, containing the following

Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID

The command line used to run this example is shown here:

ResInsight --project BatchStatistics.rsp --replaceSourceCases CaseList2.txt --savesnapshots

This will instruct ResInsight to read the project file BatchStatistics.rsp. All cases specified will be imported in the case group specified in the project file. Statistics will be computed, and snapshots for all views will be written to file.

Replace source cases in multiple case groups and create snapshots

Multiple source case groups can be updated by repeating the replaceSourceCases parameter.

The command line used to run this example is shown here:

ResInsight --project BatchStatistics.rsp --replaceSourceCases 0 CaseList2.txt --replaceSourceCases 1 CaseList3.txt --savesnapshots

This will instruct ResInsight to read the project file BatchStatistics.rsp. Source cases for case group 0 is given in CaseList2.txt, and source cases for case group 1 is given in CaseList3.txt. Statistics will be computed, and snapshots for all views will be written to file.

The possibility to replace multiple cases can also be applied for single case replace (parameter replaceCase).

Summary plotting

The following command line performs a summary plot for FOPT based on Eclipse summary file 1_R001_REEK-0.SMSPEC.

ResInsight --summaryplot 1_R001_REEK-0 FOPT

Based on file 1_R001_REEK-0.SMSPEC, the following command line performs a summary plot for FOPT and any WOPT-vector for well op_2. The trailing option -s gathers the vectors into a single summary plot.

ResInsight --summaryplot 1_R001_REEK-0 FOPT WOPT*:op_2 -s

Adding to previous example, the following command line also plots the 3D grid property SOIL for cell (20, 21, 1).

ResInsight --summaryplot 1_R001_REEK-0 FOPT WOPT*:op_2 SOIL:20,21,1