ResInsight/scripting/commandlineinterface/index.html

<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="Hugo 0.65.3" />
    <meta name="description" content="">


    <link rel="icon" href="/images/favicon.png" type="image/png">

    <title>Command Line Interface :: ResInsight</title>


    <link href="/css/nucleus.css?1588568942" rel="stylesheet">
    <link href="/css/fontawesome-all.min.css?1588568942" rel="stylesheet">
    <link href="/css/hybrid.css?1588568942" rel="stylesheet">
    <link href="/css/featherlight.min.css?1588568942" rel="stylesheet">
    <link href="/css/perfect-scrollbar.min.css?1588568942" rel="stylesheet">
    <link href="/css/auto-complete.css?1588568942" rel="stylesheet">
    <link href="/css/atom-one-dark-reasonable.css?1588568942" rel="stylesheet">
    <link href="/css/theme.css?1588568942" rel="stylesheet">
    <link href="/css/hugo-theme.css?1588568942" rel="stylesheet">


    <script src="/js/jquery-3.3.1.min.js?1588568942"></script>

    <style>
      :root #header + #content > #left > #rlblock_left{
          display:none !important;
      }

    </style>

<script type="text/javascript" async
  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
  MathJax.Hub.Config({
  tex2jax: {
    inlineMath: [['$','$'], ['\\(','\\)']],
    displayMath: [['$$','$$'], ['\\[','\\]']],
    processEscapes: true,
    processEnvironments: true,
    skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
    TeX: { equationNumbers: { autoNumber: "AMS" },
         extensions: ["AMSmath.js", "AMSsymbols.js"] }
  }
  });
  MathJax.Hub.Queue(function() {


    var all = MathJax.Hub.getAllJax();
    while(jax = all.pop()) {
        jax.SourceElement().parentNode.className += ' has-jax';
    }
  });

  MathJax.Hub.Config({

  TeX: { equationNumbers: { autoNumber: "AMS" } }
  });
</script>

  </head>
  <body class="" data-url="/scripting/commandlineinterface/">
    <nav id="sidebar" class="">


  <div id="header-wrapper">
    <div id="header">
      <a id="logo" href="https://resinsight.org/">
  <img src="https://resinsight.org//images/ResInsightCroppedIconPicture.png">
</a>

    </div>

        <div class="searchbox">
    <label for="searchbox"><i class="fas fa-search"></i></label>
    <form action="/search/" method="GET" id="search-form">
      <input type="search" name="q" id="searchbox" placeholder="Search">
    </form>
    <span data-search-clear=""><i class="fas fa-times"></i></span>
</div>


  </div>

    <div class="highlightable">
    <ul class="topics">


    <li data-nav-id="/getting-started/" title="Getting Started" class="dd-item


        ">
      <a href="/getting-started/">
          Getting Started

      </a>


        <ul>


      <li data-nav-id="/getting-started/overview/" title="Overview" class="dd-item ">
        <a href="/getting-started/overview/">
        Overview

        </a>
    </li>


    <li data-nav-id="/getting-started/download-and-install/" title="Download and Install" class="dd-item


        ">
      <a href="/getting-started/download-and-install/">
          Download and Install

      </a>


        <ul>


      <li data-nav-id="/getting-started/download-and-install/linux-installation/" title="Linux Installation" class="dd-item ">
        <a href="/getting-started/download-and-install/linux-installation/">
        Linux Installation

        </a>
    </li>


      <li data-nav-id="/getting-started/download-and-install/windows-installation/" title="Windows Installation" class="dd-item ">
        <a href="/getting-started/download-and-install/windows-installation/">
        Windows Installation

        </a>
    </li>


      <li data-nav-id="/getting-started/download-and-install/buildinstructions/" title="Build Instructions" class="dd-item ">
        <a href="/getting-started/download-and-install/buildinstructions/">
        Build Instructions

        </a>
    </li>


        </ul>

    </li>


      <li data-nav-id="/getting-started/helpmenuanddocumentation/" title="Help Menu and Documentation" class="dd-item ">
        <a href="/getting-started/helpmenuanddocumentation/">
        Help Menu and Documentation

        </a>
    </li>


      <li data-nav-id="/getting-started/modelnavigation/" title="Model Navigation" class="dd-item ">
        <a href="/getting-started/modelnavigation/">
        Model Navigation

        </a>
    </li>


    <li data-nav-id="/getting-started/other/" title="Other" class="dd-item


        ">
      <a href="/getting-started/other/">
          Other

      </a>


        <ul>


      <li data-nav-id="/getting-started/other/releasenotification/" title="Release Notification Subscription" class="dd-item ">
        <a href="/getting-started/other/releasenotification/">
        Release Notification Subscription

        </a>
    </li>


      <li data-nav-id="/getting-started/other/testimonials/" title="Testimonials" class="dd-item ">
        <a href="/getting-started/other/testimonials/">
        Testimonials

        </a>
    </li>


        </ul>

    </li>


        </ul>

    </li>


    <li data-nav-id="/3d-main-window/" title="3D Main Window" class="dd-item


        ">
      <a href="/3d-main-window/">
          3D Main Window

      </a>


        <ul>


      <li data-nav-id="/3d-main-window/3dviews/" title="3D Views" class="dd-item ">
        <a href="/3d-main-window/3dviews/">
        3D Views

        </a>
    </li>


      <li data-nav-id="/3d-main-window/cellresults/" title="Cell Results" class="dd-item ">
        <a href="/3d-main-window/cellresults/">
        Cell Results

        </a>
    </li>


      <li data-nav-id="/3d-main-window/resultcolorlegend/" title="Result Color Legend" class="dd-item ">
        <a href="/3d-main-window/resultcolorlegend/">
        Result Color Legend

        </a>
    </li>


      <li data-nav-id="/3d-main-window/comparisonview/" title="Comparison View" class="dd-item ">
        <a href="/3d-main-window/comparisonview/">
        Comparison View

        </a>
    </li>


      <li data-nav-id="/3d-main-window/contourmaps/" title="Contour Maps" class="dd-item ">
        <a href="/3d-main-window/contourmaps/">
        Contour Maps

        </a>
    </li>


      <li data-nav-id="/3d-main-window/tensors/" title="Tensor Results" class="dd-item ">
        <a href="/3d-main-window/tensors/">
        Tensor Results

        </a>
    </li>


      <li data-nav-id="/3d-main-window/resultinspection/" title="Result Inspection" class="dd-item ">
        <a href="/3d-main-window/resultinspection/">
        Result Inspection

        </a>
    </li>


      <li data-nav-id="/3d-main-window/filters/" title="Cell Filters" class="dd-item ">
        <a href="/3d-main-window/filters/">
        Cell Filters

        </a>
    </li>


      <li data-nav-id="/3d-main-window/intersections/" title="Intersections" class="dd-item ">
        <a href="/3d-main-window/intersections/">
        Intersections

        </a>
    </li>


      <li data-nav-id="/3d-main-window/surfaces/" title="Surfaces" class="dd-item ">
        <a href="/3d-main-window/surfaces/">
        Surfaces

        </a>
    </li>


      <li data-nav-id="/3d-main-window/allandiagrams/" title="Allan Diagram" class="dd-item ">
        <a href="/3d-main-window/allandiagrams/">
        Allan Diagram

        </a>
    </li>


      <li data-nav-id="/3d-main-window/faults/" title="Faults" class="dd-item ">
        <a href="/3d-main-window/faults/">
        Faults

        </a>
    </li>


      <li data-nav-id="/3d-main-window/formations/" title=" Zonations/Formations" class="dd-item ">
        <a href="/3d-main-window/formations/">
         Zonations/Formations

        </a>
    </li>


      <li data-nav-id="/3d-main-window/gridstatisticsdialog/" title="Grid Statistics Dialog" class="dd-item ">
        <a href="/3d-main-window/gridstatisticsdialog/">
        Grid Statistics Dialog

        </a>
    </li>


      <li data-nav-id="/3d-main-window/casegroupsandstatistics/" title="Grid Case Groups and Statistics" class="dd-item ">
        <a href="/3d-main-window/casegroupsandstatistics/">
        Grid Case Groups and Statistics

        </a>
    </li>


      <li data-nav-id="/3d-main-window/linkedviews/" title="Linked Views" class="dd-item ">
        <a href="/3d-main-window/linkedviews/">
        Linked Views

        </a>
    </li>


      <li data-nav-id="/3d-main-window/measurement/" title="Measurement" class="dd-item ">
        <a href="/3d-main-window/measurement/">
        Measurement

        </a>
    </li>


      <li data-nav-id="/3d-main-window/annotations/" title="Annotations" class="dd-item ">
        <a href="/3d-main-window/annotations/">
        Annotations

        </a>
    </li>


      <li data-nav-id="/3d-main-window/derivedresults/" title="Derived Results" class="dd-item ">
        <a href="/3d-main-window/derivedresults/">
        Derived Results

        </a>
    </li>


        </ul>

    </li>


    <li data-nav-id="/plot-window/" title="Plot Main Window" class="dd-item


        ">
      <a href="/plot-window/">
          Plot Main Window

      </a>


        <ul>


      <li data-nav-id="/plot-window/summaryplots/" title="Summary Plots" class="dd-item ">
        <a href="/plot-window/summaryplots/">
        Summary Plots

        </a>
    </li>


      <li data-nav-id="/plot-window/summarysourcestepping/" title="Summary Plot Source Stepping" class="dd-item ">
        <a href="/plot-window/summarysourcestepping/">
        Summary Plot Source Stepping

        </a>
    </li>


      <li data-nav-id="/plot-window/summaryploteditor/" title="Summary Plot Editor" class="dd-item ">
        <a href="/plot-window/summaryploteditor/">
        Summary Plot Editor

        </a>
    </li>


      <li data-nav-id="/plot-window/summarycrossplots/" title="Summary Cross Plot" class="dd-item ">
        <a href="/plot-window/summarycrossplots/">
        Summary Cross Plot

        </a>
    </li>


      <li data-nav-id="/plot-window/summaryplottemplate/" title="Summary Plot Template" class="dd-item ">
        <a href="/plot-window/summaryplottemplate/">
        Summary Plot Template

        </a>
    </li>


      <li data-nav-id="/plot-window/multiplots/" title="Multi Plots" class="dd-item ">
        <a href="/plot-window/multiplots/">
        Multi Plots

        </a>
    </li>


      <li data-nav-id="/plot-window/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
        <a href="/plot-window/ensembleplotting/">
        Ensemble Plotting

        </a>
    </li>


      <li data-nav-id="/plot-window/curvecalculator/" title="Curve Calculator" class="dd-item ">
        <a href="/plot-window/curvecalculator/">
        Curve Calculator

        </a>
    </li>


      <li data-nav-id="/plot-window/welllogsandplots/" title="Well Log Plots" class="dd-item ">
        <a href="/plot-window/welllogsandplots/">
        Well Log Plots

        </a>
    </li>


      <li data-nav-id="/plot-window/wellborestabilityplots/" title="Well Bore Stability Plots" class="dd-item ">
        <a href="/plot-window/wellborestabilityplots/">
        Well Bore Stability Plots

        </a>
    </li>


      <li data-nav-id="/plot-window/rftplot/" title="RFT Plot" class="dd-item ">
        <a href="/plot-window/rftplot/">
        RFT Plot

        </a>
    </li>


      <li data-nav-id="/plot-window/ensemblerftplot/" title="Ensemble RFT Plot" class="dd-item ">
        <a href="/plot-window/ensemblerftplot/">
        Ensemble RFT Plot

        </a>
    </li>


      <li data-nav-id="/plot-window/pltplot/" title="PLT Plot" class="dd-item ">
        <a href="/plot-window/pltplot/">
        PLT Plot

        </a>
    </li>


      <li data-nav-id="/plot-window/flowdiagnosticsplots/" title="Flow Diagnostics Plots" class="dd-item ">
        <a href="/plot-window/flowdiagnosticsplots/">
        Flow Diagnostics Plots

        </a>
    </li>


      <li data-nav-id="/plot-window/gridcrossplots/" title="Grid Cross Plots" class="dd-item ">
        <a href="/plot-window/gridcrossplots/">
        Grid Cross Plots

        </a>
    </li>


      <li data-nav-id="/plot-window/saturationpressureplots/" title="Saturation Pressure Plots" class="dd-item ">
        <a href="/plot-window/saturationpressureplots/">
        Saturation Pressure Plots

        </a>
    </li>


        </ul>

    </li>


    <li data-nav-id="/wells-and-completions/" title="Wells and Completions" class="dd-item


        ">
      <a href="/wells-and-completions/">
          Wells and Completions

      </a>


        <ul>


      <li data-nav-id="/wells-and-completions/simulationwells/" title="Simulation Wells" class="dd-item ">
        <a href="/wells-and-completions/simulationwells/">
        Simulation Wells

        </a>
    </li>


      <li data-nav-id="/wells-and-completions/wellpaths/" title="Well Paths" class="dd-item ">
        <a href="/wells-and-completions/wellpaths/">
        Well Paths

        </a>
    </li>


      <li data-nav-id="/wells-and-completions/createnewwellpaths/" title="Create Well Paths" class="dd-item ">
        <a href="/wells-and-completions/createnewwellpaths/">
        Create Well Paths

        </a>
    </li>


      <li data-nav-id="/wells-and-completions/3dwelllogcurves/" title="3D Well Log Plots" class="dd-item ">
        <a href="/wells-and-completions/3dwelllogcurves/">
        3D Well Log Plots

        </a>
    </li>


      <li data-nav-id="/wells-and-completions/completions/" title="Completions" class="dd-item ">
        <a href="/wells-and-completions/completions/">
        Completions

        </a>
    </li>


      <li data-nav-id="/wells-and-completions/completionslgr/" title="Completions LGR" class="dd-item ">
        <a href="/wells-and-completions/completionslgr/">
        Completions LGR

        </a>
    </li>


      <li data-nav-id="/wells-and-completions/wellmeasurements/" title="Well Measurements" class="dd-item ">
        <a href="/wells-and-completions/wellmeasurements/">
        Well Measurements

        </a>
    </li>


        </ul>

    </li>


    <li data-nav-id="/import/" title="Import" class="dd-item


        ">
      <a href="/import/">
          Import

      </a>


        <ul>


      <li data-nav-id="/import/eclipsecases/" title="Eclipse Cases" class="dd-item ">
        <a href="/import/eclipsecases/">
        Eclipse Cases

        </a>
    </li>


      <li data-nav-id="/import/lasfile/" title="Log ASCII Standard File" class="dd-item ">
        <a href="/import/lasfile/">
        Log ASCII Standard File

        </a>
    </li>


      <li data-nav-id="/import/geomechanicaldata/" title="Geomechanical Data" class="dd-item ">
        <a href="/import/geomechanicaldata/">
        Geomechanical Data

        </a>
    </li>


      <li data-nav-id="/import/soursimrlresults/" title="SourSimRL Results" class="dd-item ">
        <a href="/import/soursimrlresults/">
        SourSimRL Results

        </a>
    </li>


      <li data-nav-id="/import/elementpropertytable/" title="Element Property Table" class="dd-item ">
        <a href="/import/elementpropertytable/">
        Element Property Table

        </a>
    </li>


      <li data-nav-id="/import/observeddata/" title="Observed Time History Data" class="dd-item ">
        <a href="/import/observeddata/">
        Observed Time History Data

        </a>
    </li>


      <li data-nav-id="/import/pasteexceltimedata/" title="Paste Excel Time History Data" class="dd-item ">
        <a href="/import/pasteexceltimedata/">
        Paste Excel Time History Data

        </a>
    </li>


        </ul>

    </li>


    <li data-nav-id="/export/" title="Export" class="dd-item


        ">
      <a href="/export/">
          Export

      </a>


        <ul>


      <li data-nav-id="/export/snapshots/" title="Snapshots" class="dd-item ">
        <a href="/export/snapshots/">
        Snapshots

        </a>
    </li>


      <li data-nav-id="/export/eclipseproperties/" title="Eclipse Properties" class="dd-item ">
        <a href="/export/eclipseproperties/">
        Eclipse Properties

        </a>
    </li>


      <li data-nav-id="/export/fluxnummultnum/" title="FLUXNUM/MULTNUM" class="dd-item ">
        <a href="/export/fluxnummultnum/">
        FLUXNUM/MULTNUM

        </a>
    </li>


      <li data-nav-id="/export/completionexport/" title="Completions" class="dd-item ">
        <a href="/export/completionexport/">
        Completions

        </a>
    </li>


      <li data-nav-id="/export/exportwellpaths/" title="Well Paths" class="dd-item ">
        <a href="/export/exportwellpaths/">
        Well Paths

        </a>
    </li>


      <li data-nav-id="/export/sectormodel/" title="Sector Model" class="dd-item ">
        <a href="/export/sectormodel/">
        Sector Model

        </a>
    </li>


      <li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
        <a href="/export/contourmapexport/">
        Contour Map Export

        </a>
    </li>


        </ul>

    </li>


    <li data-nav-id="/scripting/" title="Scripting" class="dd-item
        parent


        ">
      <a href="/scripting/">
          Scripting

      </a>


        <ul>


      <li data-nav-id="/scripting/pythoninterface/" title="Python interface" class="dd-item ">
        <a href="/scripting/pythoninterface/">
        Python interface

        </a>
    </li>


      <li data-nav-id="/scripting/commandlineinterface/" title="Command Line Interface" class="dd-item active">
        <a href="/scripting/commandlineinterface/">
        Command Line Interface

        </a>
    </li>


      <li data-nav-id="/scripting/commandfile/" title="Command File" class="dd-item ">
        <a href="/scripting/commandfile/">
        Command File

        </a>
    </li>


      <li data-nav-id="/scripting/octaveinterface/" title="Octave Interface" class="dd-item ">
        <a href="/scripting/octaveinterface/">
        Octave Interface

        </a>
    </li>


      <li data-nav-id="/scripting/octaveinterfacereference/" title="Octave Interface Reference" class="dd-item ">
        <a href="/scripting/octaveinterfacereference/">
        Octave Interface Reference

        </a>
    </li>


        </ul>

    </li>


    <li data-nav-id="/misc/" title="Miscellaneous" class="dd-item


        ">
      <a href="/misc/">
          Miscellaneous

      </a>


        <ul>


      <li data-nav-id="/misc/preferences/" title="Preferences" class="dd-item ">
        <a href="/misc/preferences/">
        Preferences

        </a>
    </li>


      <li data-nav-id="/misc/projectfile/" title="Project File and Caching" class="dd-item ">
        <a href="/misc/projectfile/">
        Project File and Caching

        </a>
    </li>


      <li data-nav-id="/misc/memorymanagement/" title="Memory Management" class="dd-item ">
        <a href="/misc/memorymanagement/">
        Memory Management

        </a>
    </li>


      <li data-nav-id="/misc/keyboardshortcuts/" title="Keyboard Shortcuts" class="dd-item ">
        <a href="/misc/keyboardshortcuts/">
        Keyboard Shortcuts

        </a>
    </li>


      <li data-nav-id="/misc/regressiontestsystem/" title="Regression Test System" class="dd-item ">
        <a href="/misc/regressiontestsystem/">
        Regression Test System

        </a>
    </li>


        </ul>

    </li>


    </ul>


      <section id="shortcuts">
        <h3></h3>
        <ul>

              <li>
                  <a class="padding" href="https://resinsight.org/about"><i class='fas fa-info-circle'></i> About</a>
              </li>

              <li>
                  <a class="padding" href="https://resinsight.org/support"><i class='far fa-question-circle'></i> Support</a>
              </li>

              <li>
                  <a class="padding" href="https://resinsight.org/getting-started/download-and-install"><i class='fas fa-download'></i> Download and Install</a>
              </li>

        </ul>
      </section>


    <section id="footer">
      <a href="https://www.ceetronsolutions.com"><img src='https://resinsight.org//images/CeeSolLogoSmallForDarkBackground.png' style='width: 140px; '></a><br>

ResInsight is developed by <br> <a href="https://www.ceetronsolutions.com">Ceetron Solutions</a>
<p>in collaboration with</p>
<a href="https://www.equinor.com">Equinor ASA</a>


<script type="application/javascript">
var doNotTrack = false;
if (!doNotTrack) {
	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
	(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
	})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
	ga('create', 'UA-79509181-1', 'auto');

	ga('send', 'pageview');
}
</script>

    </section>
  </div>
</nav>


        <section id="body">
        <div id="overlay"></div>
        <div class="padding highlightable">

              <div>
                <div id="top-bar">


                <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
                    <span id="sidebar-toggle-span">
                        <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
                          <i class="fas fa-bars"></i>
                        </a>
                    </span>

                  <span id="toc-menu"><i class="fas fa-list-alt"></i></span>

                  <span class="links">


            <a href='/'>ResInsight</a> > <a href='/scripting/'>Scripting</a> > Command Line Interface


                  </span>
                </div>

                    <div class="progress">
    <div class="wrapper">
<nav id="TableOfContents">
  <ul>
    <li>
      <ul>
        <li><a href="#command-line-options">Command line options</a>
          <ul>
            <li><a href="#general">General</a></li>
            <li><a href="#command-files">Command files</a></li>
            <li><a href="#snapshots">Snapshots</a></li>
            <li><a href="#case-handling">Case handling</a></li>
            <li><a href="#summary-plotting">Summary plotting</a></li>
            <li><a href="#testing">Testing</a></li>
          </ul>
        </li>
        <li><a href="#examples">Examples</a>
          <ul>
            <li><a href="#create-snapshots-of-all-views-for-multiple-cases">Create snapshots of all views for multiple cases</a></li>
            <li><a href="#replace-a-single-case-and-take-snapshots-of-all-views">Replace a single case and take snapshots of all views</a></li>
            <li><a href="#replace-source-cases-in-a-case-group-and-create-snapshot">Replace source cases in a case group and create snapshot</a></li>
            <li><a href="#replace-source-cases-in-multiple-case-groups-and-create-snapshots">Replace source cases in multiple case groups and create snapshots</a></li>
            <li><a href="#summary-plotting-1">Summary plotting</a></li>
          </ul>
        </li>
      </ul>
    </li>
  </ul>
</nav>
    </div>
</div>


              </div>
            </div>

        <div id="head-tags">

        </div>

        <div id="body-inner">

            <h1>

              Command Line Interface
            </h1>


<p>ResInsight supports several command line parameters that can be used to automate some tasks using shell scripts.</p>
<p>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 <a href="http://www.gnu.org/prep/standards/html_node/Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command Line Interfaces</a>.</p>
<p>Examples on how command line options are used are given <a href="/scripting/commandlineinterface/#examples">below</a></p>
<h2 id="command-line-options">Command line options</h2>
<h3 id="general">General</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>--help, --?</td>
<td>Displays help text and version info</td>
</tr>
<tr>
<td>--project &lt;filename&gt;</td>
<td>Open project file &lt;filename&gt;.</td>
</tr>
<tr>
<td>--last</td>
<td>Open last used project.</td>
</tr>
<tr>
<td>--size &lt;width&gt; &lt;height&gt;</td>
<td>Set size of the main application window.</td>
</tr>
<tr>
<td>--console</td>
<td>Launch as a console application without graphics</td>
</tr>
<tr>
<td>--server [&lt;portnumber&gt;]</td>
<td>Launch as a GRPC server. Default port is 50051</td>
</tr>
<tr>
<td>--startdir &lt;folder&gt;</td>
<td>Set startup directory.</td>
</tr>
</tbody>
</table>
<h3 id="command-files">Command files</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>--commandFile &lt;commandFile&gt;</td>
<td>Execute a command file. See <a href="/scripting/commandfile/">command file documentation.</a></td>
</tr>
<tr>
<td>--commandFileProject &lt;filename&gt;</td>
<td>Project to use if performing case looping for command file. Used in conjunction with <code>commandFileReplaceCases</code>.</td>
</tr>
</tbody>
</table>
<h3 id="snapshots">Snapshots</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>--savesnapshots all|views|plots|</td>
<td>Save snapshot of all views or plots to project file location sub folder &lsquo;snapshots&rsquo;. Option &lsquo;all&rsquo; will include both views and plots. Application closes after snapshots have been written.</td>
</tr>
<tr>
<td>--multiCaseSnapshots &lt;gridListFile&gt;</td>
<td>For each grid file listed in the &lt;gridListFile&gt; file, replace the first case in the project and save snapshot of all views.</td>
</tr>
</tbody>
</table>
<h3 id="case-handling">Case handling</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>--case &lt;casename|filename&gt; [&lt;casename|filename&gt;]</td>
<td>Imports the Eclipse cases specified by case name with or without extension.If &lt;casename&gt;, import the corresponding grid file and summary file. If &lt;filename&gt; has extension .GRRID/.EGRID, import the grid file and corresponding summary file. If &lt;filename&gt; has extension .SMSPEC, import the summary file (does not open the grid file)</td>
</tr>
<tr>
<td>--replaceCase [&lt;caseId&gt;] &lt;newGridFile&gt;</td>
<td>Replace grid in &lt;caseId&gt; or first case with &lt;newGridFile&gt;. Repeat parameter for multiple replace operations.</td>
</tr>
<tr>
<td>--replaceSourceCases [&lt;caseGroupId&gt;] &lt;gridListFile&gt;</td>
<td>Replace source cases in &lt;caseGroupId&gt; or first grid case group with the grid files listed in the &lt;gridListFile&gt; file. Repeat parameter for multiple replace operations.</td>
</tr>
<tr>
<td>--commandFileReplaceCases [&lt;caseId&gt;] &lt;caseListFile&gt;</td>
<td>Supply list of cases to replace in project, performing command file for each case. Project to replace cases must be set with <code>commandFileProject</code>. 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.</td>
</tr>
</tbody>
</table>

<div class="notices note" ><p><b>Reduce project load time using <code>&ndash;replaceSourceCases</code></b>
<br>
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:
<br></p>
<ul>
<li>Open the project file used to produce statistics
<br></li>
<li>Select the statistics object in the project tree
<br></li>
<li>Click the button <b>Edit (Will DELETE current result)</b>
<br></li>
<li>Save the project file</li>
</ul>
</div>

<h3 id="summary-plotting">Summary plotting</h3>
<p>The summary plotting command option follows the following syntax:</p>
<pre><code>resinsight --summaryplot [&lt;plotOptions&gt;] &lt;eclipsesummaryvectorfilters&gt; &lt;eclipsedatafiles&gt;

where:
&lt;plotOptions&gt;                 denote summary plot options, see table below
&lt;eclipsesummaryvectorfilters&gt; has the syntax &lt;vectorname&gt;[:&lt;item&gt;[:&lt;subitem&gt;[:i,j,k]]]
&lt;eclipsedatafiles&gt;            lists a set of Eclipse data files with or without extension
</code></pre><p>The summary plotting command option creates one summary plot for each of the the summary vectors matched by<br>
<em>&lt;eclipsesummaryvectorfilters&gt;</em> using all listed Eclipse data files in each plot.</p>
<p>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:</p>
<ul>
<li><code>WOPT:*</code>: One total oil production curve for each well.</li>
<li><code>FOPT FWPT</code>: Two curves with oil and water total production.</li>
<li><code>BPR:15,28,*</code>: Oil phase pressure for all blocks along k as separate curves. Please note no space in expression.</li>
</ul>
<p><a href="/scripting/commandlineinterface/#summary-plotting-1">Examples</a> are listed below.</p>
<p>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.</p>
<p>Specifying summary plot options is optional, c.f. table below.</p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>-help</td>
<td>Shows help text and ignores any other option.</td>
</tr>
<tr>
<td>-h</td>
<td>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.</td>
</tr>
<tr>
<td>-nl</td>
<td>Omits legend in plot.</td>
</tr>
<tr>
<td>-s</td>
<td>Creates only one plot including all the defined vectors and cases.</td>
</tr>
<tr>
<td>-n</td>
<td>Scales all curves into the range 0.0-1.0. Useful when using -s.</td>
</tr>
<tr>
<td>-e</td>
<td>Imports all the cases as an ensemble, and create ensemble curves sets instead of single curves.</td>
</tr>
<tr>
<td>-c  &lt;parametername&gt;</td>
<td>Same as <em>-e</em>, but colors the curves by the ensemble parameter <parametername> .</td>
</tr>
<tr>
<td>-cl &lt;parametername&gt;</td>
<td>Same as <em>-c</em>, but uses logarithmic legend.</td>
</tr>
</tbody>
</table>
<h3 id="testing">Testing</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>--regressiontest &lt;folder&gt;</td>
<td>System command</td>
</tr>
<tr>
<td>--updateregressiontestbase &lt;folder&gt;</td>
<td>System command</td>
</tr>
<tr>
<td>--unittest</td>
<td>Execute integration tests</td>
</tr>
<tr>
<td>--ignoreArgs</td>
<td>System command</td>
</tr>
</tbody>
</table>
<p>See also the <a href="/misc/regressiontestsystem/">Regression Test System </a> for a more in-depth explanation.</p>
<h2 id="examples">Examples</h2>
<p>Most examples are also available from the <a href="https://github.com/OPM/ResInsight/tree/master/TestModels/Case_with_10_timesteps">test section</a>.</p>
<h3 id="create-snapshots-of-all-views-for-multiple-cases">Create snapshots of all views for multiple cases</h3>
<p>A list of cases is defined in <strong>CaseList.txt</strong>, containing the following</p>
<pre><code>Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
Real30/BRUGGE_0030.EGRID
Real40/BRUGGE_0040.EGRID
</code></pre><p>The command line used to run this example is shown here:</p>
<pre><code>ResInsight --project BatchTest.rsp --multiCaseSnapshots CaseList.txt --size 500 500
</code></pre><p>This will instruct ResInsight to read the project file <strong>BatchTest.rsp</strong>. All cases will be replaced one by one in ResInsight, and snapshots of all views will be written to file.</p>
<h3 id="replace-a-single-case-and-take-snapshots-of-all-views">Replace a single case and take snapshots of all views</h3>
<p>The command line used to run this example is shown here:</p>
<pre><code>ResInsight --project BatchTest.rsp --replaceCase &quot;Real10\BRUGGE_0010.EGRID&quot; --savesnapshots
</code></pre><p>This will instruct ResInsight to read the project file <strong>BatchTest.rsp</strong>. The specified case <strong>Real10\BRUGGE_0010.EGRID</strong> will be imported into the project, and snapshots of all views will be written to file.</p>
<h3 id="replace-source-cases-in-a-case-group-and-create-snapshot">Replace source cases in a case group and create snapshot</h3>
<p>A list of cases is defined in <strong>CaseList2.txt</strong>, containing the following</p>
<pre><code>Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
</code></pre><p>The command line used to run this example is shown here:</p>
<pre><code>ResInsight --project BatchStatistics.rsp --replaceSourceCases CaseList2.txt --savesnapshots
</code></pre><p>This will instruct ResInsight to read the project file <strong>BatchStatistics.rsp</strong>. 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.</p>
<h3 id="replace-source-cases-in-multiple-case-groups-and-create-snapshots">Replace source cases in multiple case groups and create snapshots</h3>
<p>Multiple source case groups can be updated by repeating the replaceSourceCases parameter.</p>
<p>The command line used to run this example is shown here:</p>
<pre><code>ResInsight --project BatchStatistics.rsp --replaceSourceCases 0 CaseList2.txt --replaceSourceCases 1 CaseList3.txt --savesnapshots
</code></pre><p>This will instruct ResInsight to read the project file <strong>BatchStatistics.rsp</strong>. 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.</p>
<p>The possibility to replace multiple cases can also be applied for single case replace (parameter <em>replaceCase</em>).</p>
<h3 id="summary-plotting-1">Summary plotting</h3>
<p>The following command line performs a <a href="/plot-window/summaryplots/">summary plot</a> for <em>FOPT</em> based on Eclipse summary file <em>1_R001_REEK-0.SMSPEC</em>.</p>
<pre><code>ResInsight --summaryplot 1_R001_REEK-0 FOPT
</code></pre><p>Based on file <em>1_R001_REEK-0.SMSPEC</em>, the following command line performs a <a href="/plot-window/summaryplots/">summary plot</a>
for <em>FOPT</em> and any <em>WOPT</em>-vector for well <em>op_2</em>.
The trailing option <em>-s</em> gathers the vectors into a single summary plot.</p>
<pre><code>ResInsight --summaryplot 1_R001_REEK-0 FOPT WOPT*:op_2 -s
</code></pre><p>Adding to previous example, the following command line also plots the 3D grid property <code>SOIL</code> for cell (20, 21, 1).</p>
<pre><code>ResInsight --summaryplot 1_R001_REEK-0 FOPT WOPT*:op_2 SOIL:20,21,1
</code></pre>

<footer class="footline">

</footer>


        </div>


      </div>

    <div id="navigation">


			<a class="nav nav-prev" href="/scripting/pythoninterface/" title="Python interface"> <i class="fa fa-chevron-left"></i></a>


			<a class="nav nav-next" href="/scripting/commandfile/" title="Command File" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>


    </div>

    </section>

    <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
      <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
    </div>
    <script src="/js/clipboard.min.js?1588568942"></script>
    <script src="/js/perfect-scrollbar.min.js?1588568942"></script>
    <script src="/js/perfect-scrollbar.jquery.min.js?1588568942"></script>
    <script src="/js/jquery.sticky.js?1588568942"></script>
    <script src="/js/featherlight.min.js?1588568942"></script>
    <script src="/js/highlight.pack.js?1588568942"></script>
    <script>hljs.initHighlightingOnLoad();</script>
    <script src="/js/modernizr.custom-3.6.0.js?1588568942"></script>
    <script src="/js/learn.js?1588568942"></script>
    <script src="/js/hugo-learn.js?1588568942"></script>

    <link href="/mermaid/mermaid.css?1588568942" rel="stylesheet" />
    <script src="/mermaid/mermaid.js?1588568942"></script>
    <script>
        mermaid.initialize({ startOnLoad: true });
    </script>


  </body>
</html>