OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updates for 2019.12

Browse Source
This commit is contained in:
Magne Sjaastad
2019-12-19 13:19:47 +01:00
parent 2b1ea27534
commit 7d789f7c91
142 changed files with 38041 additions and 2482 deletions
Download Patch File Download Diff File Expand all files Collapse all files

229
scripting/commandfile/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Command File :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -3186,6 +3284,11 @@ computeCaseGroupStatistics(caseIds=[2,4,8])
@@ -3470,6 +3573,22 @@ computeCaseGroupStatistics(caseIds=[2,4,8])
@@ -3694,6 +3813,38 @@ computeCaseGroupStatistics(caseIds=[2,4,8])
@@ -3918,6 +4069,22 @@ computeCaseGroupStatistics(caseIds=[2,4,8])
@@ -4030,6 +4197,22 @@ computeCaseGroupStatistics(caseIds=[2,4,8])
@@ -4271,20 +4454,20 @@ computeCaseGroupStatistics(caseIds=[2,4,8])
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

426
scripting/commandlineinterface/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Command Line Interface :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -1654,12 +1752,22 @@ if (!doNotTrack) {
<ul>
<li>
<ul>
<li><a href="#usage-examples">Usage Examples</a>
<li><a href="#command-line-options">Command line options</a>
<ul>
<li><a href="#example-1-create-snapshots-of-all-views-for-multiple-cases">Example 1 : Create snapshots of all views for multiple cases</a></li>
<li><a href="#example-2-replace-a-single-case-and-take-snapshots-of-all-views">Example 2 : Replace a single case and take snapshots of all views</a></li>
<li><a href="#example-3-replace-source-cases-in-a-case-group-and-create-snapshot">Example 3 : Replace source cases in a case group and create snapshot</a></li>
<li><a href="#example-4-replace-source-cases-in-multiple-case-groups-and-create-snapshots">Example 4 : Replace source cases in multiple case groups and create snapshots</a></li>
<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>
@@ -1693,7 +1801,11 @@ if (!doNotTrack) {
<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/#usage-examples">below</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>
@@ -1719,11 +1831,6 @@ if (!doNotTrack) {
<td>Open last used project.</td>
</tr>
<tr>
<td>&#45;&#45;case &lt;casename&#124;filename&gt; [&lt;casename&#124;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>&#45;&#45;size &lt;width&gt; &lt;height&gt;</td>
<td>Set size of the main application window.</td>
@@ -1746,6 +1853,8 @@ if (!doNotTrack) {
</tbody>
</table>
<h3 id="command-files">Command files</h3>
<table>
<thead>
<tr>
@@ -1760,11 +1869,6 @@ if (!doNotTrack) {
<td>Execute a command file. See <a href="/scripting/commandfile/">command file documentation.</a></td>
</tr>
<tr>
<td>&#45;&#45;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 in 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>
<tr>
<td>&#45;&#45;commandFileProject &lt;filename&gt;</td>
<td>Project to use if performing case looping for command file. Used in conjunction with <code>commandFileReplaceCases</code>.</td>
@@ -1772,6 +1876,8 @@ if (!doNotTrack) {
</tbody>
</table>
<h3 id="snapshots">Snapshots</h3>
<table>
<thead>
<tr>
@@ -1793,6 +1899,8 @@ if (!doNotTrack) {
</tbody>
</table>
<h3 id="case-handling">Case handling</h3>
<table>
<thead>
<tr>
@@ -1802,6 +1910,11 @@ if (!doNotTrack) {
</thead>
<tbody>
<tr>
<td>&#45;&#45;case &lt;casename&#124;filename&gt; [&lt;casename&#124;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>&#45;&#45;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>
@@ -1811,9 +1924,113 @@ if (!doNotTrack) {
<td>&#45;&#45;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>&#45;&#45;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>
- Open the project file used to produce statistics
<br>
- Select the statistics object in the project tree
<br>
- Click the button <b>Edit (Will DELETE current result)</b>
<br>
- Save the project file</p>
</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>&#45;help</td>
<td>Shows help text and ignores any other option.</td>
</tr>
<tr>
<td>&#45;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>&#45;nl</td>
<td>Omits legend in plot.</td>
</tr>
<tr>
<td>&#45;s</td>
<td>Creates only one plot including all the defined vectors and cases.</td>
</tr>
<tr>
<td>&#45;n</td>
<td>Scales all curves into the range 0.0-1.0. Useful when using -s.</td>
</tr>
<tr>
<td>&#45;e</td>
<td>Imports all the cases as an ensemble, and create ensemble curves sets instead of single curves.</td>
</tr>
<tr>
<td>&#45;c &lt;parametername&gt;</td>
<td>Same as <em>-e</em>, but colors the curves by the ensemble parameter <parametername> .</td>
</tr>
<tr>
<td>&#45;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>
@@ -1847,26 +2064,11 @@ if (!doNotTrack) {
<p>See also the <a href="/misc/regressiontestsystem/">Regression Test System </a> for a more in-depth explanation.</p>
<h2 id="examples">Examples</h2>
<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>
- Open the project file used to produce statistics
<br>
- Select the statistics object in the project tree
<br>
- Click the button <b>Edit (Will DELETE current result)</b>
<br>
- Save the project file</p>
</div>
<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>
<h2 id="usage-examples">Usage Examples</h2>
<p>These 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="example-1-create-snapshots-of-all-views-for-multiple-cases">Example 1 : Create snapshots of all views for multiple cases</h3>
<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>
@@ -1883,7 +2085,7 @@ Real40/BRUGGE_0040.EGRID
<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="example-2-replace-a-single-case-and-take-snapshots-of-all-views">Example 2 : Replace a single case and take snapshots of all views</h3>
<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>
@@ -1892,7 +2094,7 @@ Real40/BRUGGE_0040.EGRID
<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="example-3-replace-source-cases-in-a-case-group-and-create-snapshot">Example 3 : Replace source cases in a case group and create snapshot</h3>
<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>
@@ -1907,7 +2109,7 @@ Real10/BRUGGE_0010.EGRID
<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="example-4-replace-source-cases-in-multiple-case-groups-and-create-snapshots">Example 4 : Replace source cases in multiple case groups and create snapshots</h3>
<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>
@@ -1920,6 +2122,25 @@ Real10/BRUGGE_0010.EGRID
<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" >
@@ -2068,6 +2289,11 @@ Real10/BRUGGE_0010.EGRID
@@ -2352,6 +2578,22 @@ Real10/BRUGGE_0010.EGRID
@@ -2576,6 +2818,38 @@ Real10/BRUGGE_0010.EGRID
@@ -2800,6 +3074,22 @@ Real10/BRUGGE_0010.EGRID
@@ -2912,6 +3202,22 @@ Real10/BRUGGE_0010.EGRID
@@ -3150,20 +3456,20 @@ Real10/BRUGGE_0010.EGRID
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

231
scripting/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Scripting :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -1866,6 +1964,11 @@ This allows using the powerful Python language, numerical libraries, and other s
@@ -2150,6 +2253,22 @@ This allows using the powerful Python language, numerical libraries, and other s
@@ -2374,6 +2493,38 @@ This allows using the powerful Python language, numerical libraries, and other s
@@ -2598,6 +2749,22 @@ This allows using the powerful Python language, numerical libraries, and other s
@@ -2710,6 +2877,22 @@ This allows using the powerful Python language, numerical libraries, and other s
@@ -2934,7 +3117,7 @@ This allows using the powerful Python language, numerical libraries, and other s
<a class="nav nav-prev" href="/export/sectormodel/" title="Sector Model"> <i class="fa fa-chevron-left"></i></a>
<a class="nav nav-prev" href="/export/contourmapexport/" title="Contour Map Export"> <i class="fa fa-chevron-left"></i></a>
<a class="nav nav-next" href="/scripting/commandlineinterface/" title="Command Line Interface" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
@@ -2947,20 +3130,20 @@ This allows using the powerful Python language, numerical libraries, and other s
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

2
scripting/index.xml
View File

@@ -19,7 +19,7 @@
<description>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
Parameter Description &amp;#45;&amp;#45;help, &amp;#45;&amp;#45;?</description>
Command line options General Parameter Description &amp;#45;&amp;#45;help, &amp;#45;&amp;#45;?</description>
</item>
<item>

237
scripting/octaveinterface/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Octave Interface :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -1779,10 +1877,10 @@ SOILDIFF = SOIL;
i = 0;
for timestep = SOIL
if (i &gt; 0)
SOILDIFF(:,i) = timestep - SOIL(:,i);
endif
i++;
if (i &gt; 0)
SOILDIFF(:,i) = timestep - SOIL(:,i);
endif
i++;
endfor
SOILDIFF(:,i) = 0;
@@ -2000,6 +2098,11 @@ riSetActiveCellProperty(SOIL_KAverage, &quot;SOIL_KAverage&quot;);
@@ -2284,6 +2387,22 @@ riSetActiveCellProperty(SOIL_KAverage, &quot;SOIL_KAverage&quot;);
@@ -2508,6 +2627,38 @@ riSetActiveCellProperty(SOIL_KAverage, &quot;SOIL_KAverage&quot;);
@@ -2732,6 +2883,22 @@ riSetActiveCellProperty(SOIL_KAverage, &quot;SOIL_KAverage&quot;);
@@ -2844,6 +3011,22 @@ riSetActiveCellProperty(SOIL_KAverage, &quot;SOIL_KAverage&quot;);
@@ -3085,20 +3268,20 @@ riSetActiveCellProperty(SOIL_KAverage, &quot;SOIL_KAverage&quot;);
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

229
scripting/octaveinterfacereference/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Octave Interface Reference :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -2230,6 +2328,11 @@ The time step data will then be put into ResInsight at the time steps requested.
@@ -2514,6 +2617,22 @@ The time step data will then be put into ResInsight at the time steps requested.
@@ -2738,6 +2857,38 @@ The time step data will then be put into ResInsight at the time steps requested.
@@ -2962,6 +3113,22 @@ The time step data will then be put into ResInsight at the time steps requested.
@@ -3074,6 +3241,22 @@ The time step data will then be put into ResInsight at the time steps requested.
@@ -3315,20 +3498,20 @@ The time step data will then be put into ResInsight at the time steps requested.
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

229
scripting/pythonconfiguration/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Python Configuration :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -1838,6 +1936,11 @@ if (!doNotTrack) {
@@ -2122,6 +2225,22 @@ if (!doNotTrack) {
@@ -2346,6 +2465,38 @@ if (!doNotTrack) {
@@ -2570,6 +2721,22 @@ if (!doNotTrack) {
@@ -2682,6 +2849,22 @@ if (!doNotTrack) {
@@ -2923,20 +3106,20 @@ if (!doNotTrack) {
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

441
scripting/pythonexamples/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Python Examples :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -1653,13 +1751,16 @@ if (!doNotTrack) {
<nav id="TableOfContents">
<ul>
<li><a href="#allcases">AllCases</a></li>
<li><a href="#appinfo">AppInfo</a></li>
<li><a href="#casegridgroup">CaseGridGroup</a></li>
<li><a href="#caseinfostreamingexample">CaseInfoStreamingExample</a></li>
<li><a href="#commandexample">CommandExample</a></li>
<li><a href="#create-wbs-plot">Create WBS Plot</a></li>
<li><a href="#errorhandling">ErrorHandling</a></li>
<li><a href="#exportcontourmaps">ExportContourMaps</a></li>
<li><a href="#exportplots">ExportPlots</a></li>
<li><a href="#exportsnapshots">ExportSnapshots</a></li>
<li><a href="#gridinformation">GridInformation</a></li>
<li><a href="#import-well-paths">Import Well Paths</a></li>
<li><a href="#inputproptestasync">InputPropTestAsync</a></li>
<li><a href="#inputproptestsync">InputPropTestSync</a></li>
<li><a href="#instanceexample">InstanceExample</a></li>
@@ -1722,7 +1823,9 @@ if resinsight is not None:
print (&quot;Got &quot; + str(len(cases)) + &quot; cases: &quot;)
for case in cases:
print(&quot;Case id: &quot; + str(case.case_id))
print(&quot;Case name: &quot; + case.name)
print(&quot;Case type: &quot; + case.type)
print(&quot;Case grid path: &quot; + case.grid_path())
timesteps = case.time_steps()
@@ -1734,16 +1837,6 @@ if resinsight is not None:
</code></pre>
<h1 id="appinfo">AppInfo</h1>
<pre><code>import rips
resinsight = rips.Instance.find()
if resinsight is not None:
print(resinsight.version_string())
print(&quot;Is this a console run?&quot;, resinsight.is_console())
</code></pre>
<h1 id="casegridgroup">CaseGridGroup</h1>
<pre><code>import os
@@ -1789,8 +1882,8 @@ import rips
# Connect to ResInsight
resinsight = rips.Instance.find()
# Get the case with id == 0. This will fail if your project doesn't have a case with id == 0
case = resinsight.project.case(id=0)
# Get the first case. This will fail if you haven't loaded any cases
case = resinsight.project.cases()[0]
# Get the cell count object
cell_counts = case.cell_count()
@@ -1820,14 +1913,16 @@ import rips
# Load instance
resinsight = rips.Instance.find()
# Set window size
# Set window sizes
resinsight.set_main_window_size(width=800, height=500)
resinsight.set_plot_window_size(width=1000, height=1000)
# Retrieve first case
case = resinsight.project.cases()[0]
# Get a view
view1 = case.view(view_id=0)
view1 = case.views()[0]
# Clone the view
view2 = view1.clone()
@@ -1867,6 +1962,40 @@ with tempfile.TemporaryDirectory(prefix=&quot;rips&quot;) as tmpdirname:
</code></pre>
<h1 id="create-wbs-plot">Create WBS Plot</h1>
<pre><code>import os
# Load ResInsight Processing Server Client Library
import rips
# Connect to ResInsight instance
resInsight = rips.Instance.find()
cases = resInsight.project.cases()
well_paths = resInsight.project.import_well_paths(well_path_folder='D:/Projects/ResInsight-regression-test/ModelData/Norne_LessWellPaths')
well_log_files = resInsight.project.import_well_log_files(well_log_folder='D:/Projects/ResInsight-regression-test/ModelData/Norne_PLT_LAS')
if len(well_paths) &lt; 1:
print(&quot;No well paths in project&quot;)
exit(1)
print(well_paths)
for case in cases:
if case.type == &quot;GeoMechCase&quot;:
print (case.case_id)
case_path = case.grid_path()
folder_name = os.path.dirname(case_path)
case.import_formation_names(formation_files=['D:/Projects/ResInsight-regression-test/ModelData/norne/Norne_ATW2013.lyr'])
# create a folder to hold the snapshots
dirname = os.path.join(folder_name, 'snapshots')
print(&quot;Exporting to: &quot; + dirname)
for well_path in well_paths:
wbsplot = case.create_well_bore_stability_plot(well_path=well_path, time_step=0)
wbsplot.export_snapshot(export_folder=dirname)
</code></pre>
<h1 id="errorhandling">ErrorHandling</h1>
<pre><code>###################################################################
@@ -1876,6 +2005,7 @@ with tempfile.TemporaryDirectory(prefix=&quot;rips&quot;) as tmpdirname:
import rips
import grpc
import tempfile
resinsight = rips.Instance.find()
@@ -1885,7 +2015,25 @@ case = None
try:
case = resinsight.project.load_case(&quot;Nonsense&quot;)
except grpc.RpcError as e:
print(&quot;Expected Server Exception Received: &quot;, e)
print(&quot;Expected Server Exception Received while loading case: &quot;, e)
# Try loading well paths from a non-existing folder. We should get a grpc.RpcError exception from the server
try:
well_path_files = resinsight.project.import_well_paths(well_path_folder=&quot;NONSENSE/NONSENSE&quot;)
except grpc.RpcError as e:
print(&quot;Expected Server Exception Received while loading wellpaths: &quot;, e)
# Try loading well paths from an existing but empty folder. We should get a warning.
try:
with tempfile.TemporaryDirectory() as tmpdirname:
well_path_files = resinsight.project.import_well_paths(well_path_folder=tmpdirname)
assert(len(well_path_files) == 0)
assert(resinsight.project.has_warnings())
print(&quot;Should get warnings below&quot;)
for warning in resinsight.project.warnings():
print (warning)
except grpc.RpcError as e:
print(&quot;Unexpected Server Exception caught!!!&quot;, e)
case = resinsight.project.case(case_id=0)
if case is not None:
@@ -1924,8 +2072,66 @@ if case is not None:
except IndexError:
print (&quot;Got expected index out of bounds error on client side&quot;)
</code></pre>
<h1 id="exportcontourmaps">ExportContourMaps</h1>
<pre><code># Load ResInsight Processing Server Client Library
import rips
import tempfile
import pathlib
# Connect to ResInsight instance
resInsight = rips.Instance.find()
# Data will be written to temp
tmpdir = pathlib.Path(tempfile.gettempdir())
# Find all eclipse contour maps of the project
contour_maps = resInsight.project.contour_maps(rips.ContourMapType.ECLIPSE)
print(&quot;Number of eclipse contour maps:&quot;, len(contour_maps))
# Export the contour maps to a text file
for (index, contour_map) in enumerate(contour_maps):
filename = &quot;eclipse_contour_map&quot; + str(index) + &quot;.txt&quot;
filepath = tmpdir / filename
print(&quot;Exporting to:&quot;, filepath)
contour_map.export_to_text(str(filepath))
# The contour maps is also available for a Case
cases = resInsight.project.cases()
for case in cases:
contour_maps = case.contour_maps(rips.ContourMapType.GEO_MECH)
# Export the contour maps to a text file
for (index, contour_map) in enumerate(contour_maps):
filename = &quot;geomech_contour_map&quot; + str(index) + &quot;.txt&quot;
filepath = tmpdir / filename
print(&quot;Exporting to:&quot;, filepath)
contour_map.export_to_text(str(filepath))
</code></pre>
<h1 id="exportplots">ExportPlots</h1>
<pre><code># Import the tempfile module
import tempfile
# Load ResInsight Processing Server Client Library
import rips
# Connect to ResInsight instance
resInsight = rips.Instance.find()
# Get a list of all plots
plots = resInsight.project.plots()
export_folder = tempfile.mkdtemp()
print(&quot;Exporting to: &quot; + export_folder)
for plot in plots:
plot.export_snapshot(export_folder=export_folder)
plot.export_data_as_las(export_folder=export_folder)
plot.export_data_as_ascii(export_folder=export_folder)
</code></pre>
<h1 id="exportsnapshots">ExportSnapshots</h1>
@@ -1998,6 +2204,42 @@ for case in cases:
</code></pre>
<h1 id="import-well-paths">Import Well Paths</h1>
<pre><code># Load ResInsight Processing Server Client Library
import rips
# Connect to ResInsight instance
resInsight = rips.Instance.find()
well_path_names = resInsight.project.import_well_paths(well_path_folder='D:/Projects/ResInsight-regression-test/ModelData/norne/wellpaths')
if resInsight.project.has_warnings():
for warning in resInsight.project.warnings():
print(warning)
for well_path_name in well_path_names:
print(&quot;Imported from folder: &quot; + well_path_name)
well_path_names = resInsight.project.import_well_paths(well_path_files=['D:/Projects/ResInsight-regression-test/ModelData/Norne_WellPaths/E-3H.json',
'D:/Projects/ResInsight-regression-test/ModelData/Norne_WellPaths/C-1H.json'])
if resInsight.project.has_warnings():
for warning in resInsight.project.warnings():
print(warning)
for well_path_name in well_path_names:
print(&quot;Imported from indivdual files: &quot; + well_path_name)
well_path_names = resInsight.project.import_well_log_files(well_log_folder='D:/Projects/ResInsight-regression-test/ModelData/Norne_PLT_LAS')
if resInsight.project.has_warnings():
for warning in resInsight.project.warnings():
print(warning)
for well_path_name in well_path_names:
print(&quot;Imported well log file for: &quot; + well_path_name)
</code></pre>
<h1 id="inputproptestasync">InputPropTestAsync</h1>
<pre><code>########################################################################################
@@ -2021,7 +2263,7 @@ def create_result(poro_chunks, permx_chunks):
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.case(case_id=0)
case = resinsight.project.cases()[0]
# Get a generator for the poro results. The generator will provide a chunk each time it is iterated
poro_chunks = case.active_cell_property_async('STATIC_NATIVE', 'PORO', 0)
@@ -2053,7 +2295,7 @@ import grpc
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.case(case_id=0)
case = resinsight.project.cases()[0]
# Read poro result into list
poro_results = case.active_cell_property('STATIC_NATIVE', 'PORO', 0)
@@ -2091,7 +2333,7 @@ resinsight = rips.Instance.find()
if resinsight is None:
print('ERROR: could not find ResInsight')
else:
print('Successfully connected to ResInsight')
print('Successfully connected to ResInsight')
</code></pre>
<h1 id="launchwithcommandlineoptions">LaunchWithCommandLineOptions</h1>
@@ -2142,7 +2384,7 @@ import rips
resinsight = rips.Instance.find()
view = resinsight.project.view(view_id=0)
view = resinsight.project.views()[0]
view.apply_cell_result(result_type='STATIC_NATIVE', result_variable='DX')
</code></pre>
@@ -2157,7 +2399,7 @@ import rips
# Connect to ResInsight instance
resinsight = rips.Instance.find()
view = resinsight.project.view(view_id=0)
view = resinsight.project.view(view_id=1)
#view.apply_flow_diagnostics_cell_result(result_variable='Fraction',
# selection_mode='FLOW_TR_INJ_AND_PROD')
@@ -2213,17 +2455,17 @@ averages = []
for i in range(0, len(timeSteps)):
# Get the results from time step i asynchronously
# It actually returns a generator object almost immediately
result_chunks = case.active_cell_property_async('DYNAMIC_NATIVE', 'SOIL', i)
mysum = 0.0
count = 0
result_chunks = case.active_cell_property_async('DYNAMIC_NATIVE', 'SOIL', i)
mysum = 0.0
count = 0
# Loop through and append the average. each time we loop resultChunks
# We will trigger a read of the input data, meaning the script will start
# Calculating averages before the whole resultValue for this time step has been received
for chunk in result_chunks:
mysum += sum(chunk.values)
count += len(chunk.values)
for chunk in result_chunks:
mysum += sum(chunk.values)
count += len(chunk.values)
averages.append(mysum/count)
averages.append(mysum/count)
end = time.time()
print(&quot;Time elapsed: &quot;, end - start)
@@ -2252,9 +2494,9 @@ time_steps = case.time_steps()
averages = []
for i in range(0, len(time_steps)):
# Get a list of all the results for time step i
results = case.active_cell_property('DYNAMIC_NATIVE', 'SOIL', i)
mysum = sum(results)
averages.append(mysum/len(results))
results = case.active_cell_property('DYNAMIC_NATIVE', 'SOIL', i)
mysum = sum(results)
averages.append(mysum/len(results))
end = time.time()
print(&quot;Time elapsed: &quot;, end - start)
@@ -2283,7 +2525,7 @@ def create_result(soil_chunks, porv_chunks):
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.case(case_id=0)
case = resinsight.project.cases()[0]
timeStepInfo = case.time_steps()
# Get a generator for the porv results. The generator will provide a chunk each time it is iterated
@@ -2323,7 +2565,7 @@ import time
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.case(case_id=0)
case = resinsight.project.cases()[0]
# Read the full porv result
porv_results = case.active_cell_property('STATIC_NATIVE', 'PORV', 0)
@@ -2528,6 +2770,11 @@ if resinsight is not None:
@@ -2812,6 +3059,22 @@ if resinsight is not None:
@@ -3036,6 +3299,38 @@ if resinsight is not None:
@@ -3260,6 +3555,22 @@ if resinsight is not None:
@@ -3372,6 +3683,22 @@ if resinsight is not None:
@@ -3613,20 +3940,20 @@ if resinsight is not None:
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>

551
scripting/pythonrips/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.56.3" />
<meta name="generator" content="Hugo 0.55.6" />
<meta name="description" content="">
@@ -12,18 +12,18 @@
<title>Python API - rips :: ResInsight</title>
<link href="/css/nucleus.css?1569932070" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1569932070" rel="stylesheet">
<link href="/css/hybrid.css?1569932070" rel="stylesheet">
<link href="/css/featherlight.min.css?1569932070" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1569932070" rel="stylesheet">
<link href="/css/auto-complete.css?1569932070" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1569932070" rel="stylesheet">
<link href="/css/theme.css?1569932070" rel="stylesheet">
<link href="/css/hugo-theme.css?1569932070" rel="stylesheet">
<link href="/css/nucleus.css?1576757743" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1576757743" rel="stylesheet">
<link href="/css/hybrid.css?1576757743" rel="stylesheet">
<link href="/css/featherlight.min.css?1576757743" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1576757743" rel="stylesheet">
<link href="/css/auto-complete.css?1576757743" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1576757743" rel="stylesheet">
<link href="/css/theme.css?1576757743" rel="stylesheet">
<link href="/css/hugo-theme.css?1576757743" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1569932070"></script>
<script src="/js/jquery-3.3.1.min.js?1576757743"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -208,6 +208,9 @@
@@ -332,6 +335,25 @@
<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
@@ -668,6 +690,25 @@
<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/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
@@ -763,6 +804,25 @@
<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
@@ -1036,6 +1096,25 @@
<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
@@ -1270,6 +1349,25 @@
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
@@ -1676,6 +1774,7 @@ if (!doNotTrack) {
<li><a href="#enum-export-type">Enum export_type</a></li>
</ul></li>
<li><a href="#set-main-window-size-width-height">set_main_window_size(width, height)</a></li>
<li><a href="#set-plot-window-size-width-height">set_plot_window_size(width, height)</a></li>
<li><a href="#set-start-dir-path">set_start_dir(path)</a></li>
<li><a href="#version-string">version_string()</a></li>
</ul></li>
@@ -1688,7 +1787,7 @@ if (!doNotTrack) {
<ul>
<li>
<ul>
<li><a href="#class-rips-case-case-channel-case-id">class rips.case.Case(channel, case_id)</a></li>
<li><a href="#class-rips-case-case-channel-case-id-project">class rips.case.Case(channel, case_id, project)</a></li>
<li><a href="#id">id()</a></li>
<li><a href="#name">name()</a></li>
<li><a href="#group-id">group_id()</a></li>
@@ -1703,6 +1802,7 @@ if (!doNotTrack) {
<li><a href="#vec3i-class-description">Vec3i class description</a>
<ul>
<li><a href="#cell-info-for-active-cells-async-porosity-model-matrix-model">cell_info_for_active_cells_async(porosity_model=&lsquo;MATRIX_MODEL&rsquo;)</a></li>
<li><a href="#contour-maps-map-type-contourmaptype-eclipse-1">contour_maps(map_type=<ContourMapType.ECLIPSE: 1>)</a></li>
<li><a href="#create-lgr-for-completion-time-step-well-path-names-refinement-i-refinement-j-refinement-k-split-type">create_lgr_for_completion(time_step, well_path_names, refinement_i, refinement_j, refinement_k, split_type)</a>
<ul>
<li><a href="#enum-split-type">Enum split_type</a></li>
@@ -1710,11 +1810,12 @@ if (!doNotTrack) {
<li><a href="#create-multiple-fractures-template-id-well-path-names-min-dist-from-well-td-max-fractures-per-well-top-layer-base-layer-spacing-action">create_multiple_fractures(template_id, well_path_names, min_dist_from_well_td, max_fractures_per_well, top_layer, base_layer, spacing, action)</a></li>
<li><a href="#create-saturation-pressure-plots">create_saturation_pressure_plots()</a></li>
<li><a href="#create-view">create_view()</a></li>
<li><a href="#create-well-bore-stability-plot-well-path-time-step">create_well_bore_stability_plot(well_path, time_step)</a></li>
<li><a href="#days-since-start">days_since_start()</a></li>
<li><a href="#export-flow-characteristics-time-steps-injectors-producers-file-name-minimum-communication-0-0-aquifer-cell-threshold-0-1">export_flow_characteristics(time_steps, injectors, producers, file_name, minimum_communication=0.0, aquifer_cell_threshold=0.1)</a></li>
<li><a href="#export-msw-well-path">export_msw(well_path)</a></li>
<li><a href="#export-property-time-step-property-name-eclipse-keyword-class-property-undefined-value-0-0-export-file-class-property">export_property(time_step, property_name, eclipse_keyword=<class 'property'>, undefined_value=0.0, export_file=<class 'property'>)</a></li>
<li><a href="#export-snapshots-of-all-views-prefix">export_snapshots_of_all_views(prefix=&ldquo;)</a></li>
<li><a href="#export-snapshots-of-all-views-prefix-export-folder">export_snapshots_of_all_views(prefix=&ldquo;, export_folder=&ldquo;)</a></li>
<li><a href="#export-well-path-completions-time-step-well-path-names-file-split-compdat-export-transmissibilities-include-perforations-true-include-fishbones-true-fishbones-exclude-main-bore-true-combination-mode-individually">export_well_path_completions(time_step, well_path_names, file_split, compdat_export=&lsquo;TRANSMISSIBILITIES&rsquo;, include_perforations=True, include_fishbones=True, fishbones_exclude_main_bore=True, combination_mode=&lsquo;INDIVIDUALLY&rsquo;)</a>
<ul>
<li><a href="#enum-file-split">Enum file_split</a></li>
@@ -1726,6 +1827,7 @@ if (!doNotTrack) {
<li><a href="#grid-property-property-type-property-name-time-step-grid-index-0-porosity-model-matrix-model">grid_property(property_type, property_name, time_step, grid_index=0, porosity_model=&lsquo;MATRIX_MODEL&rsquo;)</a></li>
<li><a href="#grid-property-async-property-type-property-name-time-step-grid-index-0-porosity-model-matrix-model">grid_property_async(property_type, property_name, time_step, grid_index=0, porosity_model=&lsquo;MATRIX_MODEL&rsquo;)</a></li>
<li><a href="#grids">grids()</a></li>
<li><a href="#import-formation-names-formation-files-none">import_formation_names(formation_files=None)</a></li>
<li><a href="#replace-new-grid-file">replace(new_grid_file)</a></li>
<li><a href="#set-active-cell-property-values-property-type-property-name-time-step-porosity-model-matrix-model">set_active_cell_property(values, property_type, property_name, time_step, porosity_model=&lsquo;MATRIX_MODEL&rsquo;)</a></li>
<li><a href="#set-active-cell-property-async-values-iterator-property-type-property-name-time-step-porosity-model-matrix-model">set_active_cell_property_async(values_iterator, property_type, property_name, time_step, porosity_model=&lsquo;MATRIX_MODEL&rsquo;)</a></li>
@@ -1737,6 +1839,18 @@ if (!doNotTrack) {
</ul></li>
<li><a href="#example-1">Example</a></li>
</ul></li>
<li><a href="#contour-map-module">Contour Map Module</a>
<ul>
<li>
<ul>
<li>
<ul>
<li><a href="#class-rips-contour-map-contourmap-pdm-object-project-map-type">class rips.contour_map.ContourMap(pdm_object, project, map_type)</a></li>
<li><a href="#view-id">view_id()</a></li>
<li><a href="#export-to-text-export-file-name-export-local-coordinates-false-undefined-value-label-nan-exclude-undefined-values-false">export_to_text(export_file_name=&ldquo;, export_local_coordinates=False, undefined_value_label=&lsquo;NaN&rsquo;, exclude_undefined_values=False)</a></li>
</ul></li>
</ul></li>
</ul></li>
<li><a href="#grid-module">Grid Module</a>
<ul>
<li>
@@ -1775,20 +1889,28 @@ if (!doNotTrack) {
<li><a href="#case-case-id">case(case_id)</a></li>
<li><a href="#cases">cases()</a></li>
<li><a href="#close">close()</a></li>
<li><a href="#contour-maps-map-type-contourmaptype-eclipse-1-1">contour_maps(map_type=<ContourMapType.ECLIPSE: 1>)</a></li>
<li><a href="#create-grid-case-group-case-paths">create_grid_case_group(case_paths)</a></li>
<li><a href="#export-multi-case-snapshots-grid-list-file">export_multi_case_snapshots(grid_list_file)</a></li>
<li><a href="#export-snapshots-snapshot-type-all-prefix">export_snapshots(snapshot_type=&lsquo;ALL&rsquo;, prefix=&ldquo;)</a></li>
<li><a href="#export-well-paths-well-paths-none-md-step-size-5-0">export_well_paths(well_paths=None, md_step_size=5.0)</a></li>
<li><a href="#grid-case-group-group-id">grid_case_group(group_id)</a></li>
<li><a href="#grid-case-groups">grid_case_groups()</a></li>
<li><a href="#import-formation-names-formation-files-none-1">import_formation_names(formation_files=None)</a></li>
<li><a href="#import-well-log-files-well-log-files-none-well-log-folder">import_well_log_files(well_log_files=None, well_log_folder=&ldquo;)</a></li>
<li><a href="#import-well-paths-well-path-files-none-well-path-folder">import_well_paths(well_path_files=None, well_path_folder=&ldquo;)</a></li>
<li><a href="#load-case-path">load_case(path)</a></li>
<li><a href="#open-path">open(path)</a></li>
<li><a href="#plot-view-id">plot(view_id)</a></li>
<li><a href="#plots">plots()</a></li>
<li><a href="#replace-source-cases-grid-list-file-case-group-id-0">replace_source_cases(grid_list_file, case_group_id=0)</a></li>
<li><a href="#save-path">save(path=&ldquo;)</a></li>
<li><a href="#scale-fracture-template-template-id-half-length-height-d-factor-conductivity">scale_fracture_template(template_id, half_length, height, d_factor, conductivity)</a></li>
<li><a href="#selected-cases">selected_cases()</a></li>
<li><a href="#set-fracture-containment-template-id-top-layer-base-layer">set_fracture_containment(template_id, top_layer, base_layer)</a></li>
<li><a href="#view-view-id-2">view(view_id)</a></li>
<li><a href="#views-2">views()</a></li>
<li><a href="#well-paths">well_paths()</a></li>
</ul></li>
</ul></li>
</ul></li>
@@ -1798,8 +1920,8 @@ if (!doNotTrack) {
<ul>
<li>
<ul>
<li><a href="#class-rips-view-view-pdm-object">class rips.view.View(pdm_object)</a></li>
<li><a href="#id-1">id()</a></li>
<li><a href="#class-rips-view-view-pdm-object-project">class rips.view.View(pdm_object, project)</a></li>
<li><a href="#view-id-1">view_id()</a></li>
<li><a href="#apply-cell-result-result-type-result-variable">apply_cell_result(result_type, result_variable)</a></li>
<li><a href="#apply-flow-diagnostics-cell-result-result-variable-tof-selection-mode-flow-tr-by-selection-injectors-none-producers-none">apply_flow_diagnostics_cell_result(result_variable=&lsquo;TOF&rsquo;, selection_mode=&lsquo;FLOW_TR_BY_SELECTION&rsquo;, injectors=None, producers=None)</a>
<ul>
@@ -1814,7 +1936,7 @@ if (!doNotTrack) {
<li><a href="#enum-file-split-1">Enum file_split</a></li>
<li><a href="#enum-compdat-export-2">Enum compdat_export</a></li>
</ul></li>
<li><a href="#export-snapshot-prefix">export_snapshot(prefix=&ldquo;)</a></li>
<li><a href="#export-snapshot-prefix-export-folder">export_snapshot(prefix=&ldquo;, export_folder=&ldquo;)</a></li>
<li><a href="#export-visible-cells-export-keyword-fluxnum-visible-active-cells-value-1-hidden-active-cells-value-0-inactive-cells-value-0">export_visible_cells(export_keyword=&lsquo;FLUXNUM&rsquo;, visible_active_cells_value=1, hidden_active_cells_value=0, inactive_cells_value=0)</a></li>
<li><a href="#set-background-color-bgcolor">set_background_color(bgcolor)</a></li>
<li><a href="#set-cell-result">set_cell_result()</a></li>
@@ -2065,6 +2187,34 @@ if anything else, ResInsight will try to launch with this port</p></li>
</tbody>
</table>
<h4 id="set-plot-window-size-width-height">set_plot_window_size(width, height)</h4>
<p>Set the plot window size in pixels</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>width</td>
<td>Width in pixels</td>
<td>Integer</td>
</tr>
<tr>
<td>height</td>
<td>Height in pixels</td>
<td>Integer</td>
</tr>
</tbody>
</table>
<h4 id="set-start-dir-path">set_start_dir(path)</h4>
<p>Set current start directory</p>
@@ -2087,18 +2237,18 @@ resinsight = rips.Instance.find()
if resinsight is None:
print('ERROR: could not find ResInsight')
else:
print('Successfully connected to ResInsight')
print('Successfully connected to ResInsight')
</code></pre>
<h1 id="case-module">Case Module</h1>
<h4 id="class-rips-case-case-channel-case-id">class rips.case.Case(channel, case_id)</h4>
<h4 id="class-rips-case-case-channel-case-id-project">class rips.case.Case(channel, case_id, project)</h4>
<p>ResInsight case class</p>
<p>Operate on a ResInsight case specified by a Case Id integer.
Not meant to be constructed separately but created by one of the following
methods in Project: loadCase, case, allCases, selectedCasesq</p>
methods in Project: loadCase, case, allCases, selectedCases</p>
<h4 id="id">id()</h4>
@@ -2344,6 +2494,16 @@ must be &lsquo;MATRIX_MODEL&rsquo; or &lsquo;FRACTURE_MODEL&rsquo;.</p></li>
<p>See cell_info_for_active_cells() for detalis on the <strong>CellInfo</strong> class.</p>
<h4 id="contour-maps-map-type-contourmaptype-eclipse-1">contour_maps(map_type=<ContourMapType.ECLIPSE: 1>)</h4>
<p>Get a list of all contour maps belonging to a project</p>
<ul>
<li><p><strong>Parameters</strong></p>
<p><strong>map_type</strong> (<em>enum</em>) &ndash; ContourMapType.ECLIPSE or ContourMapType.GEO_MECH</p></li>
</ul>
<h4 id="create-lgr-for-completion-time-step-well-path-names-refinement-i-refinement-j-refinement-k-split-type">create_lgr_for_completion(time_step, well_path_names, refinement_i, refinement_j, refinement_k, split_type)</h4>
<p>Create a local grid refinement for the completions on the given well paths</p>
@@ -2496,6 +2656,24 @@ must be &lsquo;MATRIX_MODEL&rsquo; or &lsquo;FRACTURE_MODEL&rsquo;.</p></li>
<p>Create a new view in the current case</p>
<h4 id="create-well-bore-stability-plot-well-path-time-step">create_well_bore_stability_plot(well_path, time_step)</h4>
<p>Create a new well bore stability plot</p>
<ul>
<li><p><strong>Parameters</strong></p>
<ul>
<li><p><strong>well_path</strong> (<em>str</em>) &ndash; well path name</p></li>
<li><p><strong>time_step</strong> (<em>int</em>) &ndash; time step</p></li>
</ul></li>
<li><p><strong>Returns</strong></p>
<p>A new plot object</p></li>
</ul>
<h4 id="days-since-start">days_since_start()</h4>
<p>Get a list of decimal values representing days since the start of the simulation</p>
@@ -2582,14 +2760,18 @@ must be &lsquo;MATRIX_MODEL&rsquo; or &lsquo;FRACTURE_MODEL&rsquo;.</p></li>
</ul></li>
</ul>
<h4 id="export-snapshots-of-all-views-prefix">export_snapshots_of_all_views(prefix=&ldquo;)</h4>
<h4 id="export-snapshots-of-all-views-prefix-export-folder">export_snapshots_of_all_views(prefix=&ldquo;, export_folder=&ldquo;)</h4>
<p>Export snapshots for all views in the case</p>
<ul>
<li><p><strong>Parameters</strong></p>
<p><strong>prefix</strong> (<em>str</em>) &ndash; Exported file name prefix</p></li>
<ul>
<li><p><strong>prefix</strong> (<em>str</em>) &ndash; Exported file name prefix</p></li>
<li><p><strong>export_folder</strong> (<em>str</em>) &ndash; The path to export to. By default will use the global export folder</p></li>
</ul></li>
</ul>
<h4 id="export-well-path-completions-time-step-well-path-names-file-split-compdat-export-transmissibilities-include-perforations-true-include-fishbones-true-fishbones-exclude-main-bore-true-combination-mode-individually">export_well_path_completions(time_step, well_path_names, file_split, compdat_export=&lsquo;TRANSMISSIBILITIES&rsquo;, include_perforations=True, include_fishbones=True, fishbones_exclude_main_bore=True, combination_mode=&lsquo;INDIVIDUALLY&rsquo;)</h4>
@@ -2801,6 +2983,16 @@ Loop through the chunks and then the values within the chunk to get all values.<
<p>Get a list of all rips Grid objects in the case</p>
<h4 id="import-formation-names-formation-files-none">import_formation_names(formation_files=None)</h4>
<p>Import formation names into project and apply it to the current case</p>
<ul>
<li><p><strong>Parameters</strong></p>
<p><strong>formation_files</strong> (<em>list</em>) &ndash; list of files to import</p></li>
</ul>
<h4 id="replace-new-grid-file">replace(new_grid_file)</h4>
<p>Replace the current case grid with a new grid loaded from file</p>
@@ -2946,7 +3138,9 @@ if resinsight is not None:
print (&quot;Got &quot; + str(len(cases)) + &quot; cases: &quot;)
for case in cases:
print(&quot;Case id: &quot; + str(case.case_id))
print(&quot;Case name: &quot; + case.name)
print(&quot;Case type: &quot; + case.type)
print(&quot;Case grid path: &quot; + case.grid_path())
timesteps = case.time_steps()
@@ -2958,6 +3152,40 @@ if resinsight is not None:
</code></pre>
<h1 id="contour-map-module">Contour Map Module</h1>
<h4 id="class-rips-contour-map-contourmap-pdm-object-project-map-type">class rips.contour_map.ContourMap(pdm_object, project, map_type)</h4>
<p>ResInsight contour map class</p>
<h4 id="view-id">view_id()</h4>
<p>View Id corresponding to the View Id in ResInsight project.</p>
<ul>
<li><p><strong>Type</strong></p>
<p>int</p></li>
</ul>
<h4 id="export-to-text-export-file-name-export-local-coordinates-false-undefined-value-label-nan-exclude-undefined-values-false">export_to_text(export_file_name=&ldquo;, export_local_coordinates=False, undefined_value_label=&lsquo;NaN&rsquo;, exclude_undefined_values=False)</h4>
<p>Export snapshot for the current view</p>
<ul>
<li><p><strong>Parameters</strong></p>
<ul>
<li><p><strong>export_file_name</strong> (<em>str</em>) &ndash; The file location to store results in.</p></li>
<li><p><strong>export_local_coordinates</strong> (<em>bool</em>) &ndash; Should we export local coordinates, or UTM.</p></li>
<li><p><strong>undefined_value_label</strong> (<em>str</em>) &ndash; Replace undefined values with this label.</p></li>
<li><p><strong>exclude_undefined_values</strong> (<em>bool</em>) &ndash; Skip undefined values.</p></li>
</ul></li>
</ul>
<h1 id="grid-module">Grid Module</h1>
<h4 id="class-rips-grid-grid-index-case-channel">class rips.grid.Grid(index, case, channel)</h4>
@@ -3086,6 +3314,10 @@ print (case.gridCount())
<p>Close the current project (and open new blank project)</p>
<h4 id="contour-maps-map-type-contourmaptype-eclipse-1-1">contour_maps(map_type=<ContourMapType.ECLIPSE: 1>)</h4>
<p>Get a list of all contour maps belonging to a project</p>
<h4 id="create-grid-case-group-case-paths">create_grid_case_group(case_paths)</h4>
<p>Create a Grid Case Group from a list of cases</p>
@@ -3154,6 +3386,52 @@ print (case.gridCount())
<p>Get a list of all grid case groups in the project</p>
<h4 id="import-formation-names-formation-files-none-1">import_formation_names(formation_files=None)</h4>
<p>Import formation names into project</p>
<ul>
<li><p><strong>Parameters</strong></p>
<p><strong>formation_files</strong> (<em>list</em>) &ndash; list of files to import</p></li>
</ul>
<h4 id="import-well-log-files-well-log-files-none-well-log-folder">import_well_log_files(well_log_files=None, well_log_folder=&ldquo;)</h4>
<p>Import well log files into project</p>
<ul>
<li><p><strong>Parameters</strong></p>
<ul>
<li><p><strong>well_log_files</strong> (<em>list</em>) &ndash; List of file paths to import</p></li>
<li><p><strong>well_log_folder</strong> (<em>str</em>) &ndash; A folder path containing files to import</p></li>
</ul></li>
<li><p><strong>Returns</strong></p>
<p>A list of well path names (strings) that had logs imported</p></li>
</ul>
<h4 id="import-well-paths-well-path-files-none-well-path-folder">import_well_paths(well_path_files=None, well_path_folder=&ldquo;)</h4>
<p>Import well paths into project</p>
<ul>
<li><p><strong>Parameters</strong></p>
<ul>
<li><p><strong>well_path_files</strong> (<em>list</em>) &ndash; List of file paths to import</p></li>
<li><p><strong>well_path_folder</strong> (<em>str</em>) &ndash; A folder path containing files to import</p></li>
</ul></li>
<li><p><strong>Returns</strong></p>
<p>A list of well path names (strings)</p></li>
</ul>
<h4 id="load-case-path">load_case(path)</h4>
<p>Load a new case from the given file path</p>
@@ -3178,6 +3456,18 @@ print (case.gridCount())
<p><strong>path</strong> (<em>str</em>) &ndash; path to project file</p></li>
</ul>
<h4 id="plot-view-id">plot(view_id)</h4>
<p>Get a particular plot by providing view id
:param view_id: view id
:type view_id: int</p>
<p>Returns: a plot object</p>
<h4 id="plots">plots()</h4>
<p>Get a list of all plots belonging to a project</p>
<h4 id="replace-source-cases-grid-list-file-case-group-id-0">replace_source_cases(grid_list_file, case_group_id=0)</h4>
<p>Replace all source cases within a case group</p>
@@ -3192,6 +3482,12 @@ print (case.gridCount())
</ul></li>
</ul>
<h4 id="save-path">save(path=&ldquo;)</h4>
<p>Save the project to the existing project file, or to a new file
:param path: File path to the file to save the project to. If empty, saves to the active project file
:type path: str</p>
<h4 id="scale-fracture-template-template-id-half-length-height-d-factor-conductivity">scale_fracture_template(template_id, half_length, height, d_factor, conductivity)</h4>
<p>Scale fracture template parameters</p>
@@ -3245,7 +3541,7 @@ print (case.gridCount())
<ul>
<li><p><strong>Parameters</strong></p>
<p><strong>id</strong> (<em>int</em>) &ndash; view id</p></li>
<p><strong>view_id</strong> (<em>int</em>) &ndash; view id</p></li>
</ul>
<p>Returns: a view object</p>
@@ -3254,13 +3550,17 @@ print (case.gridCount())
<p>Get a list of views belonging to a project</p>
<h4 id="well-paths">well_paths()</h4>
<p>Get a list of all the well path names in the project</p>
<h1 id="view-module">View Module</h1>
<h4 id="class-rips-view-view-pdm-object">class rips.view.View(pdm_object)</h4>
<h4 id="class-rips-view-view-pdm-object-project">class rips.view.View(pdm_object, project)</h4>
<p>ResInsight view class</p>
<h4 id="id-1">id()</h4>
<h4 id="view-id-1">view_id()</h4>
<p>View Id corresponding to the View Id in ResInsight project.</p>
@@ -3481,14 +3781,18 @@ print (case.gridCount())
</tbody>
</table>
<h4 id="export-snapshot-prefix">export_snapshot(prefix=&ldquo;)</h4>
<h4 id="export-snapshot-prefix-export-folder">export_snapshot(prefix=&ldquo;, export_folder=&ldquo;)</h4>
<p>Export snapshot for the current view</p>
<ul>
<li><p><strong>Parameters</strong></p>
<p><strong>prefix</strong> (<em>str</em>) &ndash; Exported file name prefix</p></li>
<ul>
<li><p><strong>prefix</strong> (<em>str</em>) &ndash; Exported file name prefix</p></li>
<li><p><strong>export_folder</strong> (<em>str</em>) &ndash; The path to export to. By default will use the global export folder</p></li>
</ul></li>
</ul>
<h4 id="export-visible-cells-export-keyword-fluxnum-visible-active-cells-value-1-hidden-active-cells-value-0-inactive-cells-value-0">export_visible_cells(export_keyword=&lsquo;FLUXNUM&rsquo;, visible_active_cells_value=1, hidden_active_cells_value=0, inactive_cells_value=0)</h4>
@@ -3537,6 +3841,48 @@ print (case.gridCount())
<p>This is slow and inefficient, but works.</p>
<pre><code>import rips
import time
# Internal function for creating a result from a small chunk of poro and permx results
# The return value of the function is a generator for the results rather than the result itself.
def create_result(poro_chunks, permx_chunks):
# Loop through all the chunks of poro and permx in order
for (poroChunk, permxChunk) in zip(poro_chunks, permx_chunks):
resultChunk = []
# Loop through all the values inside the chunks, in order
for (poro, permx) in zip(poroChunk.values, permxChunk.values):
resultChunk.append(poro * permx)
# Return a generator object that behaves like a Python iterator
yield resultChunk
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.cases()[0]
# Get a generator for the poro results. The generator will provide a chunk each time it is iterated
poro_chunks = case.active_cell_property_async('STATIC_NATIVE', 'PORO', 0)
# Get a generator for the permx results. The generator will provide a chunk each time it is iterated
permx_chunks = case.active_cell_property_async('STATIC_NATIVE', 'PERMX', 0)
# Send back the result with the result provided by a generator object.
# Iterating the result generator will cause the script to read from the poro and permx generators
# And return the result of each iteration
case.set_active_cell_property_async(create_result(poro_chunks, permx_chunks),
'GENERATED', 'POROPERMXAS', 0)
end = time.time()
print(&quot;Time elapsed: &quot;, end - start)
print(&quot;Transferred all results back&quot;)
view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
</code></pre>
<h2 id="asynchronous-example">Asynchronous Example</h2>
<p>Read two properties at the same time chunk by chunk, multiply each chunk together and start transferring the result back to ResInsight as soon as the chunk is finished.</p>
<p>This is far more efficient.</p>
<pre><code>########################################################################################
import rips
import time
@@ -3544,7 +3890,7 @@ import grpc
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.case(case_id=0)
case = resinsight.project.cases()[0]
# Read poro result into list
poro_results = case.active_cell_property('STATIC_NATIVE', 'PORO', 0)
@@ -3570,48 +3916,6 @@ print(&quot;Transferred all results back&quot;)
view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXSY')
</code></pre>
<h2 id="asynchronous-example">Asynchronous Example</h2>
<p>Read two properties at the same time chunk by chunk, multiply each chunk together and start transferring the result back to ResInsight as soon as the chunk is finished.</p>
<p>This is far more efficient.</p>
<pre><code>import rips
import time
# Internal function for creating a result from a small chunk of poro and permx results
# The return value of the function is a generator for the results rather than the result itself.
def create_result(poro_chunks, permx_chunks):
# Loop through all the chunks of poro and permx in order
for (poroChunk, permxChunk) in zip(poro_chunks, permx_chunks):
resultChunk = []
# Loop through all the values inside the chunks, in order
for (poro, permx) in zip(poroChunk.values, permxChunk.values):
resultChunk.append(poro * permx)
# Return a generator object that behaves like a Python iterator
yield resultChunk
resinsight = rips.Instance.find()
start = time.time()
case = resinsight.project.case(case_id=0)
# Get a generator for the poro results. The generator will provide a chunk each time it is iterated
poro_chunks = case.active_cell_property_async('STATIC_NATIVE', 'PORO', 0)
# Get a generator for the permx results. The generator will provide a chunk each time it is iterated
permx_chunks = case.active_cell_property_async('STATIC_NATIVE', 'PERMX', 0)
# Send back the result with the result provided by a generator object.
# Iterating the result generator will cause the script to read from the poro and permx generators
# And return the result of each iteration
case.set_active_cell_property_async(create_result(poro_chunks, permx_chunks),
'GENERATED', 'POROPERMXAS', 0)
end = time.time()
print(&quot;Time elapsed: &quot;, end - start)
print(&quot;Transferred all results back&quot;)
view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
</code></pre>
<footer class=" footline" >
@@ -3760,6 +4064,11 @@ view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
@@ -4044,6 +4353,22 @@ view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
@@ -4268,6 +4593,38 @@ view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
@@ -4492,6 +4849,22 @@ view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
@@ -4604,6 +4977,22 @@ view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
@@ -4845,20 +5234,20 @@ view = case.views()[0].apply_cell_result('GENERATED', 'POROPERMXAS')
<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?1569932070"></script>
<script src="/js/perfect-scrollbar.min.js?1569932070"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1569932070"></script>
<script src="/js/jquery.sticky.js?1569932070"></script>
<script src="/js/featherlight.min.js?1569932070"></script>
<script src="/js/html5shiv-printshiv.min.js?1569932070"></script>
<script src="/js/highlight.pack.js?1569932070"></script>
<script src="/js/clipboard.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.min.js?1576757743"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1576757743"></script>
<script src="/js/jquery.sticky.js?1576757743"></script>
<script src="/js/featherlight.min.js?1576757743"></script>
<script src="/js/html5shiv-printshiv.min.js?1576757743"></script>
<script src="/js/highlight.pack.js?1576757743"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1569932070"></script>
<script src="/js/learn.js?1569932070"></script>
<script src="/js/hugo-learn.js?1569932070"></script>
<script src="/js/modernizr.custom-3.6.0.js?1576757743"></script>
<script src="/js/learn.js?1576757743"></script>
<script src="/js/hugo-learn.js?1576757743"></script>
<link href="/mermaid/mermaid.css?1569932070" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1569932070"></script>
<link href="/mermaid/mermaid.css?1576757743" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1576757743"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>