Did not find what you were looking for?

Command File

The command file interface allows a sequence of specified commands to be run in order from the command line. The interface is used by supplying the command file as a command line parameter. Once the command file is finished executing, ResInsight will exit.

It is possible to use these commands directly from a Python script. For further details, please see the ResInsight Python API.

Command List

Case Control Commands

• openProject
• closeProject
• setStartDir
• loadCase
• createGridCaseGroup
• createStatisticsCase
• replaceCase
• replaceSourceCases

Export Commands

• setExportFolder
• exportMultiCaseSnapshots
• exportSnapshots
• exportProperty
• exportPropertyInViews
• exportWellPathCompletions
• exportSimWellFractureCompletions
• exportMsw
• exportWellPaths
• exportVisibleCells
• exportFlowCharacteristics

Other Commands

• runOctaveScript
• setMainWindowSize
• computeCaseGroupStatistics
• setTimeStep
• scaleFractureTemplate
• setFractureContainment
• createMultipleFractures
• createLgrForCompletions
• createSaturationPressurePlots

Syntax

The command file is comprised of a set of commands to be executed in order. Each command must begin on a separate line, i.e. there cannot be two commands on the same line.

The line starts with the command name, followed by parenthesis. Within the parenthesis, parameters can be supplied. Each parameter must be named, followed by an equals sign and its value.

As an example; openProject(path="/path/to/ResInsightProject.rsp") will execute the command openProject with the parameter path. path is a string, see Types for a list of all types a parameter can have.

Not all parameters are required, in which case they can be omitted and their value will be defaulted. The order of parameters does not matter.

Command file examples are displayed in sections like this.

Types

There are different types of parameters that can be supplied.

¹ The backslash (\) character is used as an escape character within strings, so to use a quote within a string, use "escape \" with \"". To input a literal backslash character, use "\\".

Case Control Commands

openProject

Opens a ResInsight project file.

openProject(path="/home/user/ResInsightProject.rsp")

closeProject

Closes the current open project.

closeProject()

setStartDir

Set startup directory.

setStartDir(path="/home/user")

loadCase

Import Eclipse case from file.

loadCase(path="/home/user/reservoir.EGRID")

createGridCaseGroup

Create a Grid Case Group from a list of files.

createStatisticsCase

Create a Statistics Case in a Grid Case Group.

createGridCaseGroup(path=["/home/user/reservoir.EGRID", "/home/user/other_reservoir.EGRID"])
createStatisticsCase(caseGroupId=0)

replaceCase

Replaces a case in the current project with the specified new case.

openProject must be called before this command to set which project file is to be used when replacing cases. This command re-opens the project with the new case replaced. To replace more than one case at the same time, use replaceSourceCases.

replaceCase(newGridFile="/home/user/otherReservoir.EGRID", caseId=4)

replaceSourceCases

Replaces multiple source cases in the current project.

openProject must be called before this command to set which project file is to be used when replacing cases. This command re-opens tje project with the cases replaced.

replaceSourceCases(gridListFile="C:/resinsight/replacement_files.txt")

Export Commands

exportMultiCaseSnapshots

Replaces the first case in the current project with each case in the given file and saves snapshots of all views.

openProject must be called before this command to set which project file is to be used when replacing cases.

Folder to output snapshots should be set using setExportFolder with SNAPSHOTS type.

exportMultiCaseSnapshots(gridListFile="C:\\resinsight\\replacement_files.txt")

exportSnapshots

Export snapshots of specified type.

Folder to output snapshots should be set using setExportFolder with SNAPSHOTS type.

exportSnapshots(type=PLOTS)

exportProperty

Exports property values for all cells in the grid to file in Eclipse format.

exportProperty(caseId=1, timeStep=4, property="SOIL")

exportPropertyInViews

Exports property values for all cells in the grid to file in Eclipse format. Use specified cell result in view to define the export property. One file per view will be exported.

exportPropertyInViews(caseId=1)

exportPropertyInViews(caseId=1, viewNames=["view A", "view 4"])

exportWellPathCompletions

Export well path completions.

exportWellPathCompletions(caseId=3, timeStep=5, includeFishbones=false)

exportSimWellFractureCompletions

Export fracture completions for simulation wells.

exportSimWellFractureCompletions(caseId=3, viewName="View 2", timeStep=5)

exportMsw

Export multi-segment wells.

exportMsw(caseId=1, wellPath="MainWell")

exportWellPaths

Export well paths.

exportWellPaths(wellPathNames=["B-1H", "B-2H"], mdStepSize=1.5)

exportVisibleCells

Export visible cells

exporVisibleCells(caseId=0, viewName="View 1", exportKeyword=MULTNUM)

exportFlowCharacteristics

Export Flow Characteristics data to text file in CSV format

exportFlowCharacteristics(caseId=0, timeSteps=[1, 5, 6], injectors=["INJA", "INJB"], producers=["PROD_F"], fileName="myData.csv")

setExportFolder

Set the folder to export different types of data to. Set this before attempting to export data to ensure it is exported to desired location.

setExportFolder(type=SNAPSHOTS, path="/home/user/snapshots")

Other

runOctaveScript

Execute an Octave script.

runOctaveScript(path="/home/user/octave/something.m", caseIds=[1,2,6])

setMainWindowSize

Resize the main window to the specified size.

setMainWindowSize(width=1920, height=1200)

computeCaseGroupStatistics

Compute statistics for statistics cases.

computeCaseGroupStatistics(caseIds=[5])

computeCaseGroupStatistics(caseIds=[2,4,8])

setTimeStep

Set the time step for a given case. The time step is used for all views on the case.

setTimeStep(caseId=1, timeStep=8)

scaleFractureTemplate

Scale fracture template parameters.

scaleFractureTemplate(id=1, width=2, height=1.5)

setFractureContainment

Set fracture template containment parameters.

setFractureContainment(id=1, topLayer=2, baseLayer=7)

createMultipleFractures

Create multiple fractures on one or more well paths.

createMultipleFractures(caseId=0, templateId=1, wellPathNames=["B-1H", "B-2H"], action=REPLACE_FRACTURES)

createLgrForCompletions

Create temporary LGRs for completions on the selected well paths. The splitType parameter controls which main grid cells to split into LGRs. The LGR_PER_CELL option splits only those main grid cells that intersect with a completion. The LGR_PER_COMPLETION option splits all main grid cells that are located within an IJK bounding box covering all intersected cells for each completion. The LGR_PER_WELL works like the previous option, but the bounding box covers intersected cells for all completions on a well path.

createLgrForCompletions(caseId=0, timeStep=0, wellPathNames=["B-1H", "B-2H"], refinementI=2, refinementJ=3, refinementK=4, splitType=LGR_PER_WELL)

createSaturationPressurePlots

Create saturation pressure plots for the specified cases.

createSaturationPressurePlots(caseIds=[0])