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

Bulk commit of new documentation for v2016.11

Browse Source
This commit is contained in:
Jacob Støren
2016-11-29 10:53:43 +01:00
parent 32b1061a26
commit 4cb651eafb
90 changed files with 1210 additions and 295 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -8,14 +8,36 @@ ResInsight
- Open Settings
- Set gh-pages as default branch
- Enable Git Hub Pages
- Add "baseurl: /ResInsight" to _config.yml
- delete the CNAME file in the fork
- go to your_githubname.github.io/ResInsight and see your version of the site
- commit your changes, and they will appear on the site after a few seconds
# Edit of site layout
The layout of the site is mainly controlled by the css-files located in _includes/css.
## Puliblishing to main gh-pages
The history is not important, so publishing of the new site to ResInsight gh-pages is easiest done by manually copying your site changes into a single checkin on ResInsight/gh-pages.
You will then have to delete all the files in ResInsight/gh-pages **exept** the .git directory, CNAME and _config.yml.
You will then have to delete all the files in ResInsight/gh-pages **exept** the .git directory and CNAME.
Then copy all the files from the new "site" **exept** the .git directory, CNAME and _config.yml.
# MathJax
The following script can be placed in top.html to enable parsing of math formulas.
```
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
messageStyle: "none",
showProcessingMessages: "false",
"HTML-CSS": {
scale: 80
},
asciimath2jax: {
delimiters: [['$','$']]
}
});
</script>
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=AM_CHTML" type="text/javascript">
</script>
```

1
_config.yml
View File

@@ -3,4 +3,3 @@ relative_permalinks: false
permalink: /news/:year/:month/:day/:title/
repository: https://github.com/OPM/ResInsight
markdown: kramdown

22
_data/docs.yml
View File

@@ -1,7 +1,6 @@
- title: Introduction
docs:
- home
- odbsupport
- title: Getting Started
docs:
@@ -11,26 +10,33 @@
- title: Application
docs:
- gridimportexport
- reservoirviews
- modelnavigation
- linkedviews
- resultinspection
- gridimportexport
- resultcolorlegend
- simulationwells
- faults
- intersections
- filters
- formations
- wellpaths
- resultinspection
- linkedviews
- exporteclipseproperties
- summaryplots
- welllogsandplots
- derivedresults
- snapshots
- casegroupsandstatistics
- octaveinterface
- odbsupport
- derivedresults
- batchcommands
- preferences
- title: Appendix
docs:
- buildinstructions
- octaveinterfacereference
- regressiontestsystem
- commandlineparameters
- octaveinterfacereference
- buildinstructions
- regressiontestsystem

2
_includes/css/gridism.css
View File

@@ -42,7 +42,7 @@
/* Wrapping at a maximum width is optional */
.wrap .grid,
.grid.wrap {
max-width: 978px;
max-width: 1200px;
margin: 0 auto;
}

4
_includes/css/style.css
View File

@@ -7,7 +7,7 @@
}
body {
font: 300 21px Lato, 'Helvetica Neue', Helvetica, Arial, sans-serif;
font: 300 18px Lato, 'Helvetica Neue', Helvetica, Arial, sans-serif;
color: #ddd;
background-color: #333;
border-top: 5px solid #fc0;
@@ -419,7 +419,7 @@ article {
@media (min-width: 768px) {
article {
padding: 40px 40px 30px;
font-size: 21px;
font-size: 18px;
}
}

3
_includes/top.html
View File

@@ -14,6 +14,9 @@
<script src="{{ site.baseurl }}/js/html5shiv.js"></script>
<script src="{{ site.baseurl }}/js/respond.min.js"></script>
<![endif]-->
{% include google-analytics.html %}
</head>

14
_posts/2016-11-29-resinsight-2016.11-released.md Normal file
View File

@@ -0,0 +1,14 @@
---
layout: news_item
title: "ResInsight 2016.11 Released"
date: "2016-11-29 16:00:00 +0200"
author: jacobstoren
version: 2016.11
categories:
- release
---
We are happy to announce the release of ResInsight v2016.11.
### Download
Have a look at the GitHub release-page to read the release-notes or to download the new release:
[Release v2016.11 on GitHub](https://github.com/OPM/ResInsight/releases/tag/v2016.11)

4
css/style.css
View File

@@ -8,7 +8,7 @@
body {
font-family: Lato, 'Helvetica Neue', Helvetica, Arial, sans-serif;
font-size: 21px;
font-size: 18px;
font-weight: 300;
color: #ddd;
background: #333;
@@ -386,7 +386,7 @@ article {
@media (min-width: 768px){
article {
padding: 40px 40px 30px;
font-size: 21px;
font-size: 18px;
}
}

53
css/toc.css Normal file
View File

@@ -0,0 +1,53 @@
/*
* jQuery Table of Content Generator for Markdown v1.0
*
* https://github.com/dafi/tocmd-generator
* Examples and documentation at: https://github.com/dafi/tocmd-generator
*
* Requires: jQuery v1.7+
*
* Copyright (c) 2013 Davide Ficano
*
* Dual licensed under the MIT and GPL licenses:
* http://www.opensource.org/licenses/mit-license.php
* http://www.gnu.org/licenses/gpl.html
*/
#toc, .toc, .mw-warning {
background-color: #F9F9F9;
border: 1px solid #AAAAAA;
font-size: 95%;
padding: 5px;
}
#toc h2, .toc h2 {
border: medium none;
display: inline;
font-size: 100%;
font-weight: bold;
padding: 0;
}
#toc #toctitle, .toc #toctitle, #toc .toctitle, .toc .toctitle {
text-align: center;
}
#toc ul, .toc ul {
list-style-image: none;
list-style-type: none;
margin-left: 0;
padding-left: 0;
text-align: left;
}
#toc ul ul, .toc ul ul {
margin: 0 0 0 2em;
}
#toc .toctoggle, .toc .toctoggle {
font-size: 94%;
}
#toc ul li {
list-style-type: none;
padding-left: 0;
}
#toc-container {
margin-bottom: 10px;
}

69
docs/BatchCommands.md
View File

@@ -9,47 +9,70 @@ ResInsight supports several commands useful in a batch setting. These examples a
See also [Command Line Arguments]({{ site.baseurl }}/docs/commandlineparameters) for an overview of all command line arguments.
## Example 1 : Create snapshots of all views for multiple cases
### Reduce project load time
ResInsight stores data computed by statistics calculation in a cache file. When a project file is loaded, data from this cache is also imported. For large cases, the cached data can be large. When replacing source cases during batch, this data is never used and can be removed from the cache using the following workaround:
- Open the project file used to produce statistics
- Select the statistics object in the project tree
- Click the button "Edit (Will DELETE current result)"
- Save the project file
### Examples
#### Example 1 : Create snapshots of all views for multiple cases
A list of cases is defined in **CaseList.txt**, containing the following
{% highlight text %}
Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
Real30/BRUGGE_0030.EGRID
Real40/BRUGGE_0040.EGRID
{% endhighlight %}
```
Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
Real30/BRUGGE_0030.EGRID
Real40/BRUGGE_0040.EGRID
```
The command line used to run this example is shown here:
{% highlight text %}
ResInsight --project BatchTest.rsp --multiCaseSnapshots CaseList.txt --size 500 500
{% endhighlight %}
```
ResInsight --project BatchTest.rsp --multiCaseSnapshots CaseList.txt --size 500 500
```
This will instruct ResInsight to read the project file **BatchTest.rsp**. All cases will be replaced one by one in ResInsight, and snapshots of all views will be written to file.
## Example 2 : Replace a single case and take snapshots of all views
#### Example 2 : Replace a single case and take snapshots of all views
The command line used to run this example is shown here:
{% highlight text %}
ResInsight --project BatchTest.rsp --replaceCase "Real10\BRUGGE_0010.EGRID" --savesnapshots
{% endhighlight %}
```
ResInsight --project BatchTest.rsp --replaceCase "Real10\BRUGGE_0010.EGRID" --savesnapshots
```
This will instruct ResInsight to read the project file **BatchTest.rsp**. The specified case **Real10\BRUGGE_0010.EGRID** will be imported into the project, and snapshots of all views will be written to file.
## 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 list of cases is defined in **CaseList2.txt**, containing the following
{% highlight text %}
Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
{% endhighlight %}
```
Real0/BRUGGE_0000.EGRID
Real10/BRUGGE_0010.EGRID
```
The command line used to run this example is shown here:
{% highlight text %}
ResInsight --project BatchStatistics.rsp --replaceSourceCases CaseList2.txt --savesnapshots
{% endhighlight %}
```
ResInsight --project BatchStatistics.rsp --replaceSourceCases CaseList2.txt --savesnapshots
```
This will instruct ResInsight to read the project file **BatchTest.rsp**. All cases specified will be imported in the case group specified in the project file. Statistics will be computed, and snapshots for all views will be written to file.
This will instruct ResInsight to read the project file **BatchStatistics.rsp**. All cases specified will be imported in the case group specified in the project file. Statistics will be computed, and snapshots for all views will be written to file.
#### Example 4 : Replace source cases in multiple case groups and create snapshots
Multiple source case groups can be updated by repeating the replaceSourceCases parameter.
The command line used to run this example is shown here:
```
ResInsight --project BatchStatistics.rsp --replaceSourceCases 0 CaseList2.txt --replaceSourceCases 1 CaseList3.txt --savesnapshots
```
This will instruct ResInsight to read the project file **BatchStatistics.rsp**. Source cases for case group 0 is given in CaseList2.txt, and source cases for case group 1 is given in CaseList3.txt. Statistics will be computed, and snapshots for all views will be written to file.
The possibility to replace multiple cases can also be applied for single case replace (parameter *replaceCase*).

24
docs/BuildInstructions.md
View File

@@ -8,15 +8,29 @@ published: true
## Source code
The source code is hosted at [GitHub](https://github.com/opm/resinsight)
## CMake configuration
## Dependencies and prerequisites
ResInsight uses the CMake build system and requires CMake version 2.8 or higher. In addition, you need Qt version 4 to build ResInsight (4.7.3 or above).
### Windows compiler
Visual Studio 2015 or later is supported.
The ResInsight build may be configured in different ways, with optional support for Octave plugins, ABAQUS ODB API, and OpenMP. This is configured through options in CMake.
### GCC compiler
GCC version 4.9 or later is supported.
### Boost
[Boost](http://www.boost.org/users/history/) version 1.58 or later is supported. Earlier versions might work, but this has not been tested.
### Qt
[Qt](http://download.qt.io/archive/qt/) version 4.7.3 or later is supported.
### CMake
[CMake](https://cmake.org/download/) version 2.8 or later is supported.
## Build instructions
The ResInsight build may be configured in different ways, with optional support for Octave plugins, ABAQUS ODB API, and OpenMP. This is configured using options in CMake.
If you check the button 'Grouped' in the CMake GUI, the CMake variables are grouped by prefix. This makes it easier to see all of the options for ResInsight.
## Build instructions
- Open the CMake GUI
- Set the path to the source code
- Set the path to the build directory
@@ -26,7 +40,7 @@ If you check the button 'Grouped' in the CMake GUI, the CMake variables are grou
- Run the compiler using the generated makefiles or solution file/project files to build ResInsight
### Windows
ResInsight has been verified to build and run on Windows 7/8 using Microsoft Visual Studio 2010. Typical usage on Windows is to follow the build instructions above, and then open the generated solution file in Visual Studio to build the application.
ResInsight has been verified to build and run on Windows 7/8/10 using Microsoft Visual Studio 2015. Typical usage on Windows is to follow the build instructions above, and then open the generated solution file in Visual Studio to build the application.
### Linux

4
docs/CaseGroupsAndStatistics.md
View File

@@ -25,9 +25,7 @@ An import dialog is opened:
3. If you want to remove some EGRID files from the list, select them and press the **Remove** button.
4. When you are ready, press the **OK** button.
ResInsight then creates a **Grid Case Group** for you, and populates its **Source Cases** with the Cases you selected. Then the first of those Cases are read completely, while the others are just scanned to verify that the Grids match and to detect changes in the Active Cells layout.
This makes it quite fast to lo ad even a quite large number of realizations.
ResInsight then creates a **Grid Case Group** for you, and populates its **Source Cases** with the Cases you selected. Then the first of those Cases are read completely, while the others are just scanned to verify that the Grids match and to detect changes in the Active Cells layout. This makes it quite fast to load even a quite large number of realizations.
### Manually
A Grid Case Group can be created from the context menu available when right clicking a Result Case, Input Case or a different Grid Case Group. **Source Cases** can then be added by using the mouse to *drag and drop* cases with equal grids into the **Grid Case Group**'s **Source Case** folder.

7
docs/CommandLineParameters.md
View File

@@ -18,13 +18,14 @@ Examples on how command line options are used are given in
| &#45;&#45;project &lt;filename&gt; | Open project file &lt;filename&gt;. |
| &#45;&#45;case &lt;casename&gt; | Import Eclipse case &lt;casename&gt; (do not include .GRID/.EGRID) |
| &#45;&#45;startdir &lt;folder&gt; | Set startup directory. |
| &#45;&#45;savesnapshots | Save snapshot of all views to **snapshots** folder in project file folder. Application closes after snapshots have been written. |
| &#45;&#45;savesnapshots all&#124;views&#124;plots&#124; | Save snapshot of all views/plots or all(both views and plots) to **snapshots** folder in project file folder. If no arugument option is given, views are exported. Application closes after snapshots have been written. |
| &#45;&#45;size &lt;width&gt; &lt;height&gt; | Set size of the main application window. |
| &#45;&#45;replaceCase [&lt;caseId&gt;] &lt;newGridFile&gt; | Replace grid in &lt;caseId&gt; or first case with &lt;newGridFile&gt;. |
| &#45;&#45;replaceSourceCases [&lt;caseGroupId&gt;] &lt;gridListFile&gt; | Replace source cases in &lt;caseGroupId&gt; or first grid case group with the grid files listed in the &lt;gridListFile&gt; file. |
| &#45;&#45;replaceCase [&lt;caseId&gt;] &lt;newGridFile&gt; | Replace grid in &lt;caseId&gt; or first case with &lt;newGridFile&gt;. Repeat parameter for multiple replace operations.|
| &#45;&#45;replaceSourceCases [&lt;caseGroupId&gt;] &lt;gridListFile&gt; | 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.|
| &#45;&#45;multiCaseSnapshots &lt;gridListFile&gt; | For each grid file listed in the &lt;gridListFile&gt; file, replace the first case in the project and save snapshot of all views. |
| &#45;&#45;help, &#45;&#45;? | Displays help text and version info |
| &#45;&#45;regressiontest &lt;folder&gt; | Run a regression test on all sub-folders starting with `TestCase*` of the given folder. **RegressionTest.rip** files in the sub-folders will be opened and snapshots of all the views is written to the sub-sub-folder **RegTestGeneratedImages**. Then difference images is generated in the sub-sub-folder **RegTestDiffImages** based on the images in sub-sub-folder **RegTestBaseImages**. The results are presented in **ResInsightRegressionTestReport.html** that is written in the given folder. |
| &#45;&#45;updateregressiontestbase &lt;folder&gt; | For all sub-folders starting with `TestCase*`, copy the images in the sub-sub-folder **RegTestGeneratedImages** to the sub-sub-folder **RegTestBaseImages** after deleting **RegTestBaseImages** completely. |
| &#45;&#45;unittest | Execute integration tests |
See also the [Regression Test System ]({{site.baseurl }}/docs/regressiontestsystem) for a more in-depth explanation.

169
docs/DerivedResults.md
View File

@@ -14,23 +14,23 @@ The derived results are listed at the bottom of the **Static** result properties
![]({{ site.baseurl }}/images/DerivedStaticResults.png)
###Transmissibility normalized by area
### Transmissibility normalized by area
The transmissibility for cells and Non-Neighbor Connections (NNCs) are dependent on both cell properties and geometry. ResInsight normalizes TRANX, TRANY and TRANZ with the overlapping flow area for both neighbor cells and NNC-cells. The results are named riTRANXbyArea, riTRANYbyArea and riTRANZbyArea respectively.
The normalized transmissibilities make it easier to compare and check the flow capacity visually. This can be useful when history matching pressure differences across a fault.
###Identification of questionable NNCs
### Identification of questionable NNCs
In the process of normalizing transmissibility by the overlapping flow area, the NNCs in the model without any shared surface between two cells are identified. These NNCs are listed in the **Faults/NNCs With No Common Area** folder. These NNCs are questionable since flow normally is associated with a flow area.
![]({{ site.baseurl }}/images/ResInsight_NNCsWithNoCommonArea.png)
###Overall transmissibility multiplyer
### Overall transmissibility multiplyer
Transmissibility can be set or adjusted with multiple keywords in an Eclipse data deck. To visualize the adjustments made, ResInsight calculates a multiplicator for the overall change. First unadjusted transmissibilities for all neighbor cells and NNCs are evaluated based on geometry and permeabilities, similar to the NEWTRAN algorithm in Eclipse. For x- and y-directions, the NTG parameter is also included. The results are named riTRANX, riTRANY and riTRANZ respectively.
The TRANX, TRANY and TRANZ used in the simulation are divided by the ResInsight calculated transmissibilities and the resulting multiplicators are named riMULTX, riMULTY and riMULTZ respectively. The derived properties are listed under **Static** properties. The riMULT-properties are useful for quality checking consistence in user input for fault seal along a fault plane.
###Directional combined results
### Directional combined results
Some static properties with directional dependency can be visualized in x-, y- and z-direction combined in **Cell Result** and **Separate Fault Result**. The face of a cell is then colored based on the value associated with that particular face. The Positive I-face of the cell gets the cell X-value, while the J-face gets the Y-value etc. The negative faces, however, get the value from the neighbor cell on that side. The negative I-face gets the X-value of the IJK-neighbor in negative I direction, and so on for the J- and K-faces.
The directional combined parameters available are:
@@ -45,29 +45,81 @@ The directional combined parameters available are:
ResInsight calculates several of the presented geomechanical results based on the native results present in the odb-files.
### Relative Results (Time Lapse Results)
ResInsight can calculate and display relative results, sometimes also reffered to as Time Lapse results.
When enabled, every result variable is calculated as :
Value'(t) = Value(t) - Value(BaseTime)
Enable the **Enable Relative Result** option in the **Relative Result Options** group, and select the appropriate **Base Time Step**.
![]({{ site.baseurl }}/images/DerivedRelativeResults.png)
Each variable is then postfixed with "_D*TimeStepIndex*" to distinguish them from the native variables.
Note: Relative Results calculated based on Gamma values are calculated slightly differently:
Gamma_D*n* = ST_D*n* / POR_D*n*
### Derived Result Fields
The calculated result fields are:
SE (Effective Stress) , E (Strain), ST (Total Stress) and Gamma (Stress path)
* Element Nodal and Integration Points
* ST (Total Stress)
* All tensor components
* Principals, with directions (S<sub>i</sub>inc, S<sub>i</sub>azi)
* STM (Mean total stress)
* Q (Deviatoric stress)
* Gamma (Stress path)
* SE (Effective Stress)
* All tensor components
* Principals, with directions
* SEM (Mean effective stress)
* SFI
* FOS
* DSM
* E (Strain)
* All tensor components
* EV (Volumetric strain)
* ED (Deviatoric strain)
* Element Nodal On Face
* Plane
* Pinc (Face inclination angle)
* Pazi (Face azimuth angle)
* Transformed Total and Effective Stress
* SN (Stress component normal to face)
* TP (Total in-plane shear)
* TPinc (Direction of TP)
* TPH ( Horizontal in-plane shear component )
* TPQV ( Quasi vertical in-plane shear component )
* FAULTMOB
* PCRIT
#### Definitions of derived results
In this text the label Sa and Ea will be used to denote the unchanged stress and strain tensor respectivly from the odb file.
Components with one subscript denotes the principal values 1, 2, and 3 which refers to the maximum, middle, and minimum principals respectively.
Components with two subscripts however, refers to the global directions 1, 2, and 3 which corresponds to X, Y, and Z and thus also Easting, Northing, and -Depth.
Components with two subscripts however, refers to the global directions 1, 2, and 3 which corresponds to X, Y, and Z and thus also easting, northing, and depth.
### SE - Effective Stress
- Inclination is measured from the downwards direction
- Azimuth is measured from the Northing (Y) Axis in Clockwise direction looking down.
SE<sub>ij</sub> = -Sa<sub>ij</sub> (Where POR is defined)
##### Case constants
SE<sub>ij</sub> = *undefined* (Were POR is not defined)
Two constants can be assigned to a Geomechanical case:
SE<sub>i</sub> = Principal value i of SE
- Cohesion
- Friction angle
### E - Strain
In the following they are denoted s0 and fa respectively. Some of the derived results use these constants, that can be changed in the property panel of the Case.
E<sub>ij</sub> = -Ea<sub>ij</sub>
![]({{ site.baseurl }}/images/GeoMechCasePropertyPanel.png)
### ST - Total stress
##### ST - Total stress
ST<sub>ii</sub> = -Sa<sub>ii</sub> + POR (i= 1,2,3)
@@ -77,10 +129,99 @@ We use a value of POR=0.0 where it is not defined.
ST<sub>i</sub> = Principal value i of ST
### Gamma - Stress path
##### STM - Total Mean Stress
STM = (ST<sub>11</sub> + ST<sub>22</sub> + ST<sub>33</sub>)/3
##### Q - Deviatoric Stress
Q = sqrt( (3/2) * ( (ST<sub>1</sub> – STM)<sup>2</sup> + (ST<sub>2</sub> – STM)<sup>2</sup> + (ST<sub>3</sub> – STM)<sup>2</sup> ))
##### Gamma - Stress path
Gamma<sub>ii</sub> = ST<sub>ii</sub>/POR (i= 1,2,3)
Gamma<sub>i</sub> = ST<sub>i</sub>/POR
In these calcualtioins we set Gamma to *undefined* if abs(POR) > 0.01 MPa.
##### SE - Effective Stress
SE<sub>ij</sub> = -Sa<sub>ij</sub> (Where POR is defined)
SE<sub>ij</sub> = *undefined* (Were POR is not defined)
SE<sub>i</sub> = Principal value i of SE
##### SEM - Effective Mean Stress
SEM = (SE<sub>11</sub> + SE<sub>22</sub> + SE<sub>33</sub>)/3
##### SFI
SFI = ( (s0/tan(fa) + 0.5*(SE<sub>1</sub> + SE<sub>3</sub>))*sin(fa) ) /(0.5*(SE<sub>1</sub>-SE<sub>3</sub>) )
##### DSM
DSM = tan(rho)/tan(fa)
where
rho = 2 * (arctan (sqrt (( SE<sub>1</sub> + a)/(SE<sub>3</sub> + a)) ) – pi/4)
a = s0/tan(fa)
##### FOS
FOS = 1/DSM
##### E - Strain
E<sub>ij</sub> = -Ea<sub>ij</sub>
##### EV - Volumetric Strain
EV = E11 + E22 + E33
##### ED - Deviatoric Strain
ED = 2*(E1-E3)/3
##### Element Nodal On Face
For each face displayed, (might be an element face or an intersection/intersection box face),
a coodinate system is established such that:
- Ez is normal to the face, named N - Normal
- Ex is horizontal and in the plane of the face, named H - Horizontal
- Ey is in the plane pointing upwards, named QV - Quasi Vertical
The stress tensors in that particular face are then transformed to that coordinate system. The following quantities are derived from the transformed tensor named TS in the following:
##### SN - Stress component normal to face
SN = TS<sub>33</sub>
##### TPH - Horizontal in-plane shear component
TPH = TS<sub>31</sub> = TS<sub>ZX</sub>
##### TNQV - Horizontal in-plane shear component
TPQV = TS<sub>32</sub> = TS<sub>ZY</sub>
##### TP - Total in-plane shear
TP = sqrt(TPH<sup>2</sup> + TPQV<sup>2</sup>)
##### TPinc - Direction of TP
Angle of the total in-plane shear relative to the Quasi Vertical direction
TPinc = acos(TPQV/TP)
##### Pinc and Pazi - Face inclination and Azimuth
These are the directional angles of the face-normal itself.

24
docs/ExportEclipseProperties.md Normal file
View File

@@ -0,0 +1,24 @@
---
layout: docs
title: Export Eclipse Properties
permalink: /docs/exporteclipseproperties/
published: true
---
Eclipse Properties can be exported to Eclipse ASCII files by activating the context
menu on a **Cell Result** item in the **Project Tree**.
![]({{ site.baseurl }}/images/ExportProperty.png)
The command will export the property that currently is active in the 3D View.
This is particularly useful when a new property is generated using Octave.
The generated property can be exported for further use in the simulator.
The exported file has the following format, that matches the Eclipse input format:
-- Exported from ResInsight
<keyword>
<One number per cell separated by spaces>
/

96
docs/Faults.md
View File

@@ -4,50 +4,51 @@ title: Faults
permalink: /docs/faults/
published: true
---
![]({{ site.baseurl }}/images/FaultsIllustration.png)
Faults are organized in a folder named **Faults**. Overall settings can be controlled from the **Faults** item in the **Project Tree**.
This section describes how Faults are detected and visualized. NNC's are a part of the Faults visualization and are thus also mentioned in this section.
## Fault Names and NNC
## Fault Detection
### Import of Fault info from `*.DATA`-files
If enabled in **Preferences**, ResInsight will import fault information from the `*.DATA` files and use this information to group the detected faces into named items. The imported faults are ordered in ascending order based on their name.
ResInsight always scans the grids for geometrical faults when they are loaded. When two opposite cell faces of I, J, K neighbor cells does not match geometrically, they are tagged.
All the tagged cell faces are then compared to the faults possibly imported from the `*.DATA` file in order to group them. If a particular face is *not* found among the fault faces defined in the `*.DATA` file (or their opposite faces), the cell face is added to one of two predefined faults:
1. **Undefined grid faults**
2. **Undefined grid faults With Inactive**
The first fault is used if both the neighbor cells are active. If one or both of the neighbor cells are inactive, the second fault is used.
These particular Faults will always be present, even when reading of fault information from the `*.DATA` file is disabled.
### Information from `*.DATA`-files
#### Fault Information
If enabled in **Preferences**, ResInsight will import fault information from the `*.DATA` files and use this information to group the cell faces into named items. The imported faults are ordered in ascending order based on their name.
<div class="note info">
<h5>Technical Functionality</h5>
The <b>DATA</b> file is parsed for the <b>FAULT</b> keyword. Also <b>INCLUDE</b> keywords are read, and included files are parsed for the <b>FAULTS</b> keyword.<br>
Currently the <b>PATH</b> keyword is NOT supported.
The <b>DATA</b> file is parsed for the <b>FAULT</b> keyword while respecting any <b>INCLUDE</b> and <b>PATH</b> keywords.<br>
As import of faults can be time consuming, reading of faults can be disabled from <b>Preferences->Import faults</b>
</div>
<div class="note info">
<h5>Reduce case loading time</h5>
As import of faults can be time consuming, reading of faults can be disabled from <b>Preferences ->Import faults</b>
</div>
#### NNC Data
If enabled in **Preferences**, ResInsight will read Non Neighbor Connections from the Eclipse output file (`*.INIT`), and create explicit visualizations of those.
The NNC's are sorted onto the Fault's and their visibility is controlled along with them.
### Undefined grid faults
All the detected cell faces are compared to the faults imported from the `*.DATA` file in order to group them. If a particular face is *not* found among the fault faces defined in the `*.DATA` file or it's opposite face, the cell face is added to a fault called **Undefined grid faults**. This particular Fault will always be present, even if reading of the `*.DATA` file is disabled.
## Fault visualization options
### Fault visibility
Faults can be hidden and shown in several ways.
- Checking or unchecking the checkbox in front of the fault will show or hide the fault.
- Visibility for multiple faults can be controlled at the same time by selecting multiple faults and use the context menu: **On**, **Off** and **Toggle**.
- Right clicking a Fault in the 3D View will enable a context menu with a command to hide the fault.
### Fault color
Each named Fault is given a color on import. This color can be controlled by selecting the fault and edit its **Fault color** in the **Property Editor.**
### Separate Fault Result
Default result mapping on faults is using the result specified in **Cell Result**. If a different result mapping is wanted, enable the checkbox at **Separate Fault Result** and select the result from the result selection dialog in the **Property Editor**. A second legend for the fault result is added to the view.
### Fault visibility
Faults can be disabled from the context menu in the 3D view. Also unchecking the checkbox in front of the fault will hide the fault. Visibility for multiple faults can be controlled from the context menu of the **Faults** tree item.
### NNC visualization
If enabled in **Preferences**, ResInsight will read Non Neighbor Connections from the Eclipse output file (`*.INIT`), and create explicit visualizations of those witch have a common surface area. These NNC's are then sorted onto the Fault's and their visibility is controlled from the **Property Editor** of the **Faults** Item in the **Project Tree**.
The color of the NNC faces are set to be a bit lighter than their corresponding named fault, and can not be controlled directly.
### Picking info
When clicking on a cell face that is member of a fault, the fault name is displayed in the **Result Info** window, along with cell, and result property info.
When clicking on a NNC, the relevant data for this NNC is displayed.
## Fault visualization options
The default result mapping used on faults are to use the same as specified in **Cell Result**. If a different result mapping is wanted, enable the checkbox at **Separate Fault Result** and select the result from the result selection dialog in the **Property Editor**. A second legend for the fault result is then added to the view.
### Toolbar control
Visualization mode and mesh lines can be controlled from the toolbar.
@@ -59,20 +60,19 @@ Visualization mode and mesh lines can be controlled from the toolbar.
<br> This is a useful method to highlight the faults in your reservoir, because the faults stands out with black outlining.
- ![]({{ site.baseurl }}/images/draw_style_faults_label_24x24.png) Shows labels for faults
### Common Fault Options
### Faults Properties
By clicking the ![]({{ site.baseurl }}/images/draw_style_faults_24x24.png) **Faults** item in the **Project Tree**, the following options common to all the faults are displayed:
![]({{ site.baseurl }}/images/FaultProperties.png)
#### Fault labels
##### Fault labels
- **Show labels**: Displays one label per fault with the name defined in the `*.DATA`-file
- **Label color**: Defines the label color
#### Fault options
##### Fault options
- **Show faults outside filters**: Turning this option on, will display faults outside the filter region, making the fault visualization completely ignore the Range and Property filters in action.
- **Show results on faults**: This toggle controls whether to show the selected result property on the faults or not. This should normally be left on.
#### Fault Face Visibility
##### Fault Face Visibility
This group of options controls the visibility of the fault faces. Since they work together, and in some cases are overridden by the system, they can be a bit confusing.
First of all. These options are only available in **Faults-only** visualization mode. ( See *Toolbar Control* above) When not in **Faults-Only** mode, ResInsight overrides the options, and the controls are inactive.
@@ -81,18 +81,28 @@ Secondly: The option you would normally want to adjust is **Dynamic Face Selecti
- **Show defined faces**: Displays the fault cell faces that are defined on the Eclipse input file (`*.DATA`)
- **Show opposite faces**: Displays the opposite fault cell faces from what is defined on the input file, based on IJK neighbors.
<br> *These two options should normally be left **On***. <br>They are useful when investigating the exact faults information provided on the `*.DATA` file.
<br>If you need to use them, it is normally wise to set the **Dynamic Face Selection** to "Show Both"
<br> *These two options should normally be left **On**. They are useful when investigating the exact faults information provided on the `*.DATA` file. If you need to use them, it is normally wise to set the **Dynamic Face Selection** to "Show Both".*
- **Dynamic Face Selection**: At one particular position on a fault there are usually two cells competing for your attention: The cell closer to you as the viewer, or the one further from you. When showing results, this becomes important because these two cell faces have different result property values, and thus color. <br>This option controls which of the two cell faces you actually can see: The one behind the fault, or the one in front of the fault. There is also an option of showing both, which will give you an undefined mixture, making it hard to be certain what you see. <br>This means that ResInsight turns on or off the faces based on your view position and this option to make sure that you always see the faces (and thus the result property) you request.
#### NNC Visibility
##### NNC Visibility
- **Show NNCs**: Toggles whether to display the Non Neighbor Connections, or not.
- **Hide NNC geometry if no NNC result is available**: Automatically hides NNC geometry if no NNC results are available
##### Dynamic Face Selection
<div class="note info">
The color of the NNC faces are set to be a bit lighter than their corresponding named fault, and can not be controlled directly.
</div>
At one particular position on a fault there are usually two cells competing for your attention: The cell closer to you as the viewer, or the one further from you. When showing results, this becomes important because these two cell faces have different result property values, and thus color.
## Fault Export
Faults can be exported to separate files in the `*grdecl` file format. This is useful for example if you need a list of the geometrically detected faults that has not been covered by entries in the eclipse FAULTS keyword.
To export some faults, select the faults you want to export in the **Project Tree**, right click them and select the command **Export Faults ...** from the context menu.
![]({{ site.baseurl }}/images/ExportFaultsMenu.png)
You are then prompted to select a destination folder. Each Fault is exported to a file named `Faults_<fault name>_<case name>.grdecl` and stored in the selected folder.
The `fault name` of **Undefined Grid Faults** is simplified to "UNDEF", while **Undefinded Grid Faults With Inactive** is simplified to "UNDEF_IA". All other faults keep their original name.
This option controls which of the two cell faces you actually can see: The one behind the fault, or the one in front of the fault. There is also an option of showing both, which will give you an undefined mixture, making it hard to be certain what you see.
This means that ResInsight turns on or off the faces based on your view position and this option to make sure that you always see the faces (and thus the result property) you request.

24
docs/Filters.md
View File

@@ -4,20 +4,20 @@ title: Cell Filters
permalink: /docs/filters/
published: true
---
![]({{ site.baseurl }}/images/FiltersOverview.png)
Cell Filters are used to control visibility of the cells in the 3D view. Three types of filters exists:
- **Range filter** : Define a IJK subset of the model.
- **Property filter** : Define a value range for a property to control cell visibility.
- **Well cell filter** : Display grid cells that has connections to a well.
### Well cell filters
Well cell filters are a special type of filters that are controlled from the **Simulation Wells** item only. They are not applicable for Geomechanical cases.
- **Range filter** : Extracts an IJK subset of the model.
- **Property filter** : Extracts cells with a property value matching a value range.
- **Well cell filter** : Extracts cells that are connected to a well.
### Common properties for Range and Property Filters
Both filter types can be turned on or off using the toggle in the **Project Tree** and controlled from their corresponding **Property Editor**.
![]({{ site.baseurl }}/images/FiltersInTreeView.png)
Range Filters and Property filters can either be set to **Include** cells or to **Exclude** them.
The **Exclude** setting is used to explicitly remove cells from the visualization, regardless of what other filters say.
@@ -55,8 +55,20 @@ Below is a snapshot of the **Property Editor** of the **Property Filter**.
![]({{ site.baseurl }}/images/PropertyFilterProperties.png)
#### Property value range
The filter is based on a property value range (Min - Max). Cells in the range are either shown or hidden depending on the **Filter Type** (*Include*/*Exclude*). Exclude-filters removes the selected cells from the **View** even if some other filter includes them.
A new property filter can be made by activating the context menu for **Property Filters**. The new property filter is based on the currently viewed cell result by default.
The name of the property filter is automatically set to *"propertyname (min .. max)"* as you edit the property filter.
#### Category selection
If the property is representing integer values or formation names, the property filter displays a list of available categories used to filter cells. The separate values can then be toggled on or off using the list in the Property Editor.
![]({{ site.baseurl }}/images/PropertyFilterWithCategories.png)
If it is more convenient to filter the values using a value range, toggle the **Category Selection** option off.
### Well cell filters
Well cell filters are a special type of filters that are controlled from the **Simulation Wells** item. See [Simulation Wells]({{ site.baseurl }}/docs/simulationwells) for more details.
They are not applicable for Geomechanical cases.

55
docs/Formations.md Normal file
View File

@@ -0,0 +1,55 @@
---
layout: docs
title: Formations
permalink: /docs/formations/
published: true
---
![]({{ site.baseurl }}/images/formations_legend.PNG)
Formation information can be utilized in ResInsight as cell colors, used in property filters and are displayed in the **Result info** panel when selecting single cells.
To use this functionality you will need to :
1. Import one or more Formation Names file(s)
2. Select the correct Formation Names file in the Case of interest
## Import of Formation Names files
Formation Names files can be imported by using the command: **File->Import->Import Formation Names**.
The user is asked to select ```*.lyr``` files for import.
The imported Formation Names files are then listed in the **Project Tree** in a folder named **Formations**.
Formation Names files consists of a list of formation names and their k-range. Below is an example of a Formation Names file:
```
-- Any text as comment
'MyFormationName' 4 - 12
'MySecondFormationName' 15 - 17
'3 k-layer thick 18,19 and 20' 3
'Last Name' 21 - 21
```
## Select the Formation file in a Case
To make the Formation information available for viewing, you have to select which of the Formation files to be used for a particular case.
![]({{ site.baseurl }}/images/formations_property_editor.PNG)
This option is available in the **Property Editor** for a case. The formation is selected in the combo box for property **Formation Names File**.
### Reload of formation data
If the formation file is modified outside ResInsight, the formation data can be imported again by the context menu **Formations->Reload**. This command will import formations for the selected formation files.
## Viewing the Formation Information
### Formations in 3D view
The formations can be visualized as a result property in **Cell Results**, **Cell Edge Result**, and **Separate Fault Result**. When selected, a special legend displaying formation names is activated.
### Property filter based on formations
Formation names are available in Property Filters as Result Type **Formation Names**. This makes it easy to filter geometry based on formation specfications.
See [ Cell Filters ]({{ site.baseurl }}/docs/filters) for details.
### Picking in 3D view
Picking on a cell being part of a formation will display the formation name in the **Result Info** windows, in addition to other pick info for the cell.

85
docs/GettingStarted.md
View File

@@ -5,17 +5,29 @@ permalink: /docs/gettingstarted/
published: true
---
### User interface overview
The application has a main area and several docking windows. The different docking
windows can be managed from the **Windows** menu or directly using the local menu bar of the docking window.
ResInsight has two main windows. One for 3D related visualization, and one for 2D graphs and plots. These ares shown in the images below.
##### 3D Main Window
![ResInsight User Interface]({{ site.baseurl }}/images/ResInsightUIMediumSize.png)
##### Plot Main Window
![ResInsight User Interface]({{ site.baseurl }}/images/ResInsightMainPlotMediumSize.png)
#### Switching between the two main windows
The two main windows has a toolbar button each, that directly opens and raises the other window.
![3D Main Window]({{ site.baseurl }}/images/3DWindow24x24.png)
![Plot Main Window]({{ site.baseurl }}/images/PlotWindow24x24.png)
Each of the windows can also be closed freely, but if both are closed, ResInsight exits.
#### Docking Windows
Each of the main windows has a central area and several docking windows surrounding it. The different docking
windows can be managed from the **Windows** menu or directly using the local menu bar of the docking window.
- **Project Tree** - contains all application objects in a tree structure.
- **Property Editor** - displays all properties for the selected object in the **Project Tree**
- **Process Monitor** - displays output from Octave when executing Octave scripts
@@ -25,36 +37,34 @@ windows can be managed from the **Windows** menu or directly using the local men
Result Info and Result Plot is described in detail in [ Result Inspection ]({{ site.baseurl }}/docs/resultinspection)
<div class="note">
<h5>Add additional docking windows</h5>
A new project tree and property editor can be added from <b>Windows->New Project and Property View</b>.
<h5>Use several Project Trees and Property Editors</h5>
If you want to pin the property editor for a certain object, you can add
a new Project Tree and Property Editor by using the command <b>Windows->New Project and Property View</b>.
</div>
### Toolbars
A selected subset of actions are presented as controls in the toolbar. The different sections in the toolbar can be dragged and positioned anywhere as small floating toolbars. Management of the toolbar is done by right-clicking on the toolbar and then manipulating the displayed menu.
#### 3D Views
#### Managing 3D Views and Plot Windows
In the main area of the application, several 3D views can be open at the same time. One of them will be active and the active view can be either maximized to use the whole main area, or normalized so that you can see all the open 3D views.
In the main area of the application, several 3D views or plot windows can be open at the same time. One of them will be active and the active view can be either maximized to use the whole main area, or restored so that you can see the open windows.
Management of several views is available from the **Windows** menu
Standard window management for applying minimized, normal and maximized state is available in the upper right corner.
![Restore Down]({{ site.baseurl }}/images/RestoreDown.PNG)
Commands to arrange the windows in the standard ways are available from the **Windows** menu
- **Tile Windows** - distribute all open view windows to fill available view widget space
- **Cascade Windows** - organize all open view windows sligthly offset on top of each other
- **Close All Windows** - close all open view windows
<div class="note">
<h5>View window management</h5>
Standard window management for applying minimized, normal and maximized state is available in the upper right corner.
</div>
![Restore Down]({{ site.baseurl }}/images/RestoreDown.PNG)
#### Editing 3D views and Plot Windows content
#### Editing the views
Most of the settings and features of ResInsight is accessible through the **Project Tree** and the **Property Editor**. Selecting an item in the **Project Tree** activates the corresponding Window, and shows the item properties in the **Property Editor** available for editing.
Most of the settings and features of ResInsight is accessible through the **Project Tree** and the **Property Editor**. Selecting an item in the **Project Tree** activates the corresponding 3D View, and shows the item properties in the **Property Editor** available for editing.
Toggling a checkbox next to an item in the **Project Tree** will toggle visibility in the 3D view. Toggling a checkbox for a collection of items will affect the visibility for all items in the collection. ![]({{ site.baseurl }}/images/TreeViewToggle.png)
Toggling a checkbox next to an item in the **Project Tree** will toggle visibility in the window. Toggling a checkbox for a collection of items will affect the visibility for all items in the collection. ![]({{ site.baseurl }}/images/TreeViewToggle.png)
Context menu commands are also available to do special operations on a selected set of items.
@@ -73,44 +83,33 @@ This is a Case based on the results of an Eclipse simulation, read from a grid f
##### Input case ![]({{ site.baseurl }}/images/EclipseInput24x24.png)
This Case type is based on a `*.GRDECL` file, or a part of an Eclipse *Input* file. This Case type supports loading single ASCII files defining Eclipse Cell Properties, and also to export modified property sets to ASCII files.
Each of the Eclipse properties is listed as separate entities in the **Project Tree**, and can be renamed and exported.
Each of the Eclipse properties are listed as separate entities in the **Project Tree**, and can be renamed and exported.
See [ Grid Import and Property Export ]({{ site.baseurl }}/docs/gridimportexport)
##### Statistics case ![]({{ site.baseurl }}/images/Histogram24x24.png)
This is a Case type that belongs to a *Grid Case Group* and makes statistical calculations based on the source cases in the Grid Case Group.
This is a Case type that belongs to a *Grid Case Group* and makes statistical calculations based on the source cases in the Grid Case Group. See [ Grid Case Groups and Statistics ]({{ site.baseurl }}/docs/casegroupsandstatistics).
##### Summary Case ![]({{ site.baseurl }}/images/SummaryCase24x24.png)
This is the case type listed in the Plot Main Window, and represents an `*.SMSPEC` file. These Cases are available for Summary Plotting. See [ Summary Plots ]({{ site.baseurl }}/docs/summaryplots).
#### Geomechanical cases ![]({{ site.baseurl }}/images/GeoMechCase24x24.png)
There are only one type of geomechanical cases, namely the ABAQUS-odb case type.
The geomechanical cases will is sorted into its own folder in the project tree named **Geomechanical Models** ![]({{ site.baseurl }}/images/GeoMechCases24x24.png) as opposed to the **Grid Models** folder where the Eclipse cases and **Grid Case Groups** resides.
There are only one type of geomechanical cases, namely the ABAQUS-odb case type. The geomechanical cases are sorted into its own folder in the project tree named **Geomechanical Models** ![]({{ site.baseurl }}/images/GeoMechCases24x24.png) as opposed to the **Grid Models** folder where the Eclipse cases and **Grid Case Groups** resides.
#### Grid Case Groups ![]({{ site.baseurl }}/images/GridCaseGroup24x24.png)
A **Grid Case Group** is a group of Eclipse **Result Cases** with identical grids, but generally different active cells, initial values and results. These cases are called *Source Cases*.
The purpose of a Grid Case group is to make it easy to calculate statistics across the source cases both for static and dynamic Eclipse Properties.
See [ Multiple realizations and statistics ]({{ site.baseurl }}/docs/casegroupsandstatistics) for more on this.
A **Grid Case Group** is a group of Eclipse **Result Cases** with identical grids, but generally different active cells, initial values and results. These cases are called *Source Cases*. The purpose of a Grid Case group is to make it easy to calculate statistics across the source cases both for static and dynamic Eclipse Properties. See [ Grid Case Groups and Statistics ]({{ site.baseurl }}/docs/casegroupsandstatistics).
### Project files and Cache directory
### The Project file and the Cache directory
ResInsight stores which cases you have imported and all the settings for each view etc. in a project file with the extension `.rsp`.
This file only contains references to the real data files, and even references to data files generated by ResInsight itself.
ResInsight stores all the views and settings in a Project File with the extension: `*.rsp`.
This file only contains *references* to the real data files, and does not in any way copy the data itself. Data files generated by ResInsight are also referenced from the Project File.
Statistics calculations, property sets you generate by using Octave, and well paths are saved to a folder in the same directory as you save the project file, and is named ProjectFileName_cache. So if you need to move your project, make sure you move this folder as well.
Statistics calculations, octave generated property sets, and SSI-hub imported well paths are saved to a folder named `<ProjectFileName>_cache` in the same directory as the project file. If you need to move your project, make sure you move this folder along. If you do not, the calculations or well path import needs to be done again.
<div class="note">
The `.rsp`-file is an XML file, and can be edited by any text editor.
The <code>*.rsp</code> -file is an XML file, and can be edited by any text editor.
</div>
### Export options
#### Snapshot images
##### Single View ![]({{ site.baseurl }}/images/SnapShot.png) ![]({{ site.baseurl }}/images/SnapShotSave.png)
Image export of current 3D view can be launched from **File -> Export -> Snapshot To File**. A snapshot can also be copied to clipboard using **Edit->Copy Snapshot To Clipboard**.
##### All Views ![]({{ site.baseurl }}/images/SnapShotSaveViews.png)
If a project contains multiple views, all views can be exported using **File -> Export -> Snapshot All Views To File**.
It is also possible to snapshot all views from the command line. See [ Command Line Arguments ]({{ site.baseurl }}/docs/commandlineparameters)

19
docs/GridImportExport.md
View File

@@ -1,12 +1,10 @@
---
layout: docs
title: Grid Import and Property Export
title: Grid Import
permalink: /docs/gridimportexport/
published: true
---
### Importing Eclipse cases
ResInsight supports the following type of Eclipse input data:
@@ -22,7 +20,7 @@ You can select several grid files in one go by multiple selection of files (Ctrl
</div>
#### Eclipse ASCII input data
1. Select **File->Import-> ![]({{ site.baseurl }}/images/EclipseInput24x24.png)Import Input Eclipse Case** and select a `*.GRDECL` file.
1. Select **File->Import-> ![]({{ site.baseurl }}/images/EclipseInput24x24.png) Import Input Eclipse Case** and select a `*.GRDECL` file.
2. The case is imported, and a view of the case is created
3. Right click the **Input Properties** in the generated **Input Case** and use the context menu to import additional Eclipse Property data files.
@@ -38,16 +36,3 @@ When ResInsight is compiled with ABAQUS-odb support, `*.odb` files can be import
**File->Import-> ![]({{ site.baseurl }}/images/GeoMechCase24x24.png) Import Geo Mechanical Model**
See [Build Instructions]({{ site.baseurl }}/docs/buildinstructions) on how to compile ResInsight with odb-support.
### Export of Eclipse Properties as ASCII data
Eclipse Properties can be exported to Eclipse ASCII files by activating the context
menu for a **Cell Result**. ![]({{ site.baseurl }}/images/ExportProperty.png)
The command will export the property set currently loaded and shown in the 3D View to a file with the following format:
-- Exported from ResInsight
<keyword>
<One number per cell separated by spaces>
/

16
docs/Home.md
View File

@@ -1,25 +1,29 @@
---
layout: docs
title: ResInsight 1.6
title: ResInsight 2016.11
permalink: /docs/home/
published: true
---
ResInsight is an open source, cross-platform 3D visualization and post processing tool for Eclipse reservoir models and simulations. It can also be configured to visualize geomechanical simulations from ABAQUS.
ResInsight is an open source, cross-platform 3D visualization, curve plotting and post processing tool for Eclipse reservoir models and simulations. It can also be configured to visualize geomechanical simulations from ABAQUS.
The system also constitutes a framework for further development and can be extended to support new data sources and visualization methods, e.g. additional solvers, seismic data, CSEM, geomechanics, and more.
The system also constitutes a framework for further development and can be extended to support new data sources and visualization methods, e.g. additional solvers, seismic data, CSEM, and more.
### Efficient User Interface
The user interface is tailored for efficient interpretation of reservoir simulation data with specialized visualizations of properties, faults and wells. It enables easy handling of a large number of realizations and calculation of statistics. To be highly responsive, ResInsight exploits multi-core CPUs and GPUs.
The user interface is tailored for efficient interpretation of reservoir simulation data with specialized visualizations of properties, faults and wells. It enables easy handling of a large number of realizations and calculation of statistics. To be highly responsive, ResInsight exploits multi-core CPUs and GPUs. Efficient plotting of well log plots and summary vectors is available through selected plotting features.
### Octave Integration
Integration with GNU Octave enables powerful and flexible result manipulation and computations. Derived results can be returned to ResInsight for further handling and visualization. Eventually, derived and computed properties can be directly exported to Eclipse input formats for further simulation cycles and parameter studies.
Integration with GNU Octave enables powerful and flexible result manipulation and computations. Derived results can be returned to ResInsight for further handling and visualization. Eventually, derived and computed properties can be directly exported to Eclipse input formats for further simulation cycles and parameter studies.
### Data support
The main input data is
`*.GRID` and `*.EGRID` files along with their `*.INIT` and restart files `*.XNNN` and `*.UNRST`.
Summary vectors can be imported from `*.SMSPEC` files.
ResInsight also supports selected parts of Eclipse input files and can read grid
information and corresponding cell property data sets. Well log data can be imported from `*.LAS` files.
information and corresponding cell property data sets from `*.GRDECL` files.
Well log data can be imported from `*.LAS` files.
ResInsight can also be built with support for Geomechanic models from ABAQUS in the `*.odb` file format.

14
docs/Installation.md
View File

@@ -14,17 +14,7 @@ published: true
2. Extract content from ZIP file
3. Start ResInsight.exe
#### Octave installation (optional)
To make ResInsight work with Octave you need to do the following two steps:
1. Install the correct version of Octave
2. Setup ResInsight to find the Octave executable.
##### ResInsight 1.4.0 and later
1. ResInsight 1.4.0 is delivered with support for Octave 4.0.0 which can be downloaded here: [Octave-4.0.0](ftp://ftp.gnu.org/gnu/octave/windows/octave-4.0.0_0-installer.exe)
### Octave installation (optional)
1. ResInsight is delivered with support for Octave 4.0.0 which can be downloaded here: [Octave-4.0.0](ftp://ftp.gnu.org/gnu/octave/windows/octave-4.0.0_0-installer.exe)
2. Launch ResInsight.exe, open **Edit->Preferences** and enter the path to the Octave command line interpreter executable, usually 'C:\Your\Path\To\Octave-x.x.x\bin\octave-cli.exe'
##### ResInsight 1.3.2-dev and earlier
1. Earlier versions of ResInsight for Windows had precompiled support for Octave 3.6.1 for VS2010 and can be downloaded here: [Octave-3.6.1 for VS 2010](https://github.com/OPM/ResInsight/releases/download/1.0.0/octave-3.6.1-vs2010-setup-1.2.exe)
- Download an [additional library file](https://github.com/OPM/ResInsight/releases/download/1.0.0/dirent.lib) and copy it into Octave lib folder, typically **c:/Octave-3.6.1/lib/dirent.lib**
2. Launch ResInsight.exe, open **Edit->Preferences** and enter the path to the Octave command line interpreter executable, usually 'C:\Your\Path\To\Octave-x.x.x\bin\octave-cli.exe'

12
docs/InstallationLinux.md
View File

@@ -19,3 +19,15 @@ The precompiled octave support is only tested for RedHat 6 (ResInsight 1.3.2-dev
1. Install Octave directly from the package manager in Linux. See the documentation for your particular distribution.
2. Launch ResInsight, open **Edit->Preferences** and enter the path to the Octave command line interpreter executable, usually just 'octave'.
### Display application icons in GNOME
By default, icons are not visible in menus in the GNOME desktop environment. ResInsight has icons for many menu items, and icons can be set visible by issuing the following commands (Tested on RHEL6) :
```
gconftool-2 --type boolean --set /desktop/gnome/interface/buttons_have_icons true
gconftool-2 --type boolean --set /desktop/gnome/interface/menus_have_icons true
```
This fix was taken from reply number 11 in this [thread](https://bbs.archlinux.org/viewtopic.php?id=117414)

74
docs/Intersections.md
View File

@@ -7,59 +7,101 @@ published: true
![]({{ site.baseurl }}/images/IntersectionOverview.png)
Intersections are cross sections of the grid model vertically or horizontally along a curve. The curve can be either a Simulation Well, a Well Path or a user defined polyline.
Intersections are cross sections of the grid model that displays the grid cell values on planes that cut through the grid in various ways.
Intersections are organized in a folder named **Intersections** in a **View** as shown below.
There are two main types of intersections. The first one which simply is called **Intersection** is defined by a picewise linear curve and an extrusion direction. The curve can be either a Simulation Well, a Well Path or a user defined polyline. The second intersection type is called an **Intersection Box** that can be used both as a box cutting the grid cells, or collapsed to a restricted axis aligned plane.
Intersections are stored in a folder named **Intersections** in a **View** as shown below.
![]({{ site.baseurl }}/images/IntersectionInTree.png)
A new general intersection can be created by activating ![]({{ site.baseurl }}/images/CrossSection16x16.png) **New Intersection** from the context menu of the **Intersections** item in the Project Tree.
### Curve Based **Intersections**
There are three types of curve based intersections: Well Path, Simulation Well, and Polyline intersections.
Any of these can be created by activating ![]({{ site.baseurl }}/images/CrossSection16x16.png) **New Intersection** from the context menu of the **Intersections** item in the Project Tree.
They can also be created from the context menu in the 3D view, as described below.
<div class="note info">
To be able to see the intersections in the 3D view, the grid cells can be hidden by disabling the <b>Grids</b> item in the Project Tree or activating the <b>Hide Grid Cells</b> toolbar button.
</div>
The property panel of an Intersection is shown below:
#### Common Curve based Intersection Options
The property panel of a Well Path based Intersection is shown below:
![]({{ site.baseurl }}/images/IntersectionWellPath.png)
#### Intersection Options
Property | Description
---------------|------------
Name | Automatically created based on the item specifying the intersection. The user can customize the name by editing, but will be updated if you change the well or well path.
Intersecting Geometry | These options controls the curve to be used for the cross section, and depends on the type of intersection you choose.
Direction | Horizontal or vertical intersection
Direction | Horizontal, vertical or Defined by two points
Extent length | Defines how far an intersection for Well Path or Simulation Well is extended at intersection ends
Inactive cells | Controls if inactive cells are visualized on the intersection geometry
Show Inactive Cells | Controls if inactive cells are included when creating the intersection geometry
**Direction**
### Well Path Intersection
The direction defined is used to extrude the curve in the defined direction, and thereby create a set of planes.
When selection the **Horizontal** option, the start and end point of the curve is used as a baseline, and the horizontal direction is thus perpendicular to that line.
When **Defined by two points** is the active option, the user can define the direction based on any two points. The direction from from the first to the second point defines the extrude direction.
- The background color of this list is set to light pink when adding points by picking in the 3D view is active.
- To finish adding points, click the button **Stop picking points** in the **Property Editor**.
- The background color of the point list is then set to white.
#### Well Path Intersection
A new **Well Path** intersection can be created by right-clicking the well path in the 3D view or in the **Project Tree**.
![]({{ site.baseurl }}/images/IntersectionWellPath.png)
When a well path intersection is created, the source well path can be changed by using the **Well Path** selection combo box in the **Property Editor**.
### Simulation Well Intersection
#### Simulation Well Intersection
A new **Simulation Well** intersection can be created by right-clicking the simulation well in the 3D view or in the **Project Tree**.
![]({{ site.baseurl }}/images/IntersectionSimulationWellProperties.png)
![]({{ site.baseurl }}/images/IntersectionSimulationWellProperties.png)
When a simulation well intersection is created, the source simulation well can be changed by using the **Simulation Well** selection combo box in the **Property Editor**.
If the well contains more than one branch, the intersection geometry will be created for the selected brach in the **Branch** combo box.
### Polyline Intersection
#### Polyline Intersection
A new **Polyline** intersection can be created from the context menu in the 3D view. Then, by left-clicking on reservoir geometry, a polyline is created. The points are added to the point list in the **Property Editor**.
![]({{ site.baseurl }}/images/IntersectionPolyline.png)
The background color of this list is set to light pink when adding points by picking in the 3D view is active. To finish adding points, click the button **Stop picking points** in the **Property Editor**. The background color
of the point list is then set to white.
- The background color of this list is set to light pink when adding points by picking in the 3D view is active.
- To finish adding points, click the button **Stop picking points** in the **Property Editor**.
- The background color of the point list is then set to white.
The points in the list can be deleted and edited using the keyboard.
To append more points by clicking in the 3D view, push the button **Start picking points** again.
The points in the list can be copied to clipboard using **CTRL-C** when keyboard focus is inside the point list. A new list of points can be pasted into the point list by using **CTRL-V**.
### Intersection Box and Intersection Planes
A new **Intersection Box** or **Intersection Plane** can be created from the context menu in the 3D view or the context menu in the **Project Tree**.
![]({{ site.baseurl }}/images/3d_view_context_menu.png)
The following table describes the properties for an **Intersection Box**:
Property | Description
---------------|------------
Name | Automatically created based on the item specifying the intersection
Box Type | Box or x-plane, y-plane or z-plane
Show Inactive Cells | Controls if inactive cells are included when creating the intersection geometry
X Coordinates | Coordinates for x range
Y Coordinates | Coordinates for y range
Depth | Coordinates for depth range
XY Slider Step Size | Defines how much the value changes when the slider for XY values is changed, default value 1.0
Depth Slider Step Size | Defines how much the value changes when the slider for depth values is changed, default value 0.5
Direct interaction in a 3D view is activated when **Show 3D manipulator** is pressed. Handles are displayed at the sides of the intersection object, and interactive modification is done by dragging a handle in the 3D view.
![]({{ site.baseurl }}/images/IntersectionBoxWithHandles.png)

8
docs/LinkedViews.md
View File

@@ -28,9 +28,7 @@ When selecting a linked view in the project tree, the different options are avai
## Toggle Linking from the **Project Tree**
A linked view can temporarily be disabled by unchecking the linked view.
To disable all linked views temporarily, uncheck the top level item **Linked Views**.
A linked view can temporarily be disabled by unchecking the linked view. To disable all linked views temporarily, uncheck the top level item **Linked Views**.
## Project Tree Context menu
@@ -41,10 +39,12 @@ Right-clicking one of the linked view entries in the **Project Tree** displays t
- **Delete** Remove an individual view from the group of linked views
## 3D view Context menu
To activate the menu items for linked views, right-click inside the 3D view anywhere outside the model.
To activate the menu items for a linked view, right-click inside the 3D view anywhere outside the model.
Depending on whether the view is a dependent-, or an unlinked view, some of the following commands are available:
- **Show Link Options** Activate the linked view item in the project tree, and show its properties.
- **Set As Master View** Use the view as Master View
- **Link View** Add the view to list of linked views
- **Unlink View** Delete the view from list of linked views
Master views have no available linking commands.

14
docs/ModelNavigation.md
View File

@@ -11,13 +11,6 @@ ResInsight comes with four navigation modes. The active mode can be selected in
Note that changing the navigation mode applies to the currently active view only, and views created after the change.
The following applies to all navigation modes:
|Mouse interaction | Action |
|------------------|---------|
|RMB single click | Context menu |
|LMB single click | Update status bar and **Result Info** |
These abbrevitations are used in the tables below:
|Abbreviation | Meaning |
@@ -26,6 +19,13 @@ These abbrevitations are used in the tables below:
|MMB | Press the middle mouse button or scroll wheel button |
|RMB | Press the right mouse button |
The following applies to all navigation modes:
|Mouse interaction | Action |
|------------------|---------|
|RMB single click | Context menu |
|LMB single click | Update status bar and **Result Info** |
#### RMS navigation mode
|Mouse interaction | Action |

97
docs/OctaveInterface.md
View File

@@ -15,7 +15,7 @@ Octave scripts are available in the **Scripts** folder in the **Project Tree**.
![]({{ site.baseurl }}/images/OctaveScriptTree.png)
This folder contains an entry for each of the directories you have added as a **Script Folder**. Each of the folder lists available `*.m` files and sub directories. The tree is continuously updated to reflect the file structure on disk.
This folder contains an entry for each of the directories you have added as a **Script Folder**. Each of the folder lists available `*.m` files and sub directories.
### Adding Script Folders
You can add directories by right clicking the **Scripts** item to access the context menu.
@@ -27,6 +27,8 @@ To enable script editing from ResInsight you need to set up the path to a text e
When done, scripts can be edited using the context menu command **Edit** on the script item in the tree.
If you add a script file directly by creating a new file, the new script can be made visible in the user interface by activating **Refresh** in the context menu of a script folder.
## Script execution
Octave scripts can be executed with or without a selection of cases as context. The [Octave Interface Reference]({{ site.baseurl }}/docs/octaveinterfacereference) highlights in more depth how to design your Octave scripts to utilize these features.
@@ -37,3 +39,96 @@ A script can be started by navigating to the script in the **Project Tree**, and
One script can be executed on many cases by first selecting a set of cases, and then activating **Execute script** from the context menu for the case selection. The script is then executed once pr selected case. Each time ResInsight's *Current Case* is updated, making it accessible from the Octave script.
![]({{ site.baseurl }}/images/ExecuteOctaveScriptOnSelectedCases.png)
## Script Examples
Here are some example-scripts that illustrates the use of the octave interface.
<div class="note info">
<b>Disclaimer:</b> The scripts are provided as illustration only. They are probably not the best way of using the octave script language, and could potentially be incorrect.
</div>
#### Example 1
```matlab
# Calculate change of oil saturation from timestep to timestep
SOIL = riGetActiveCellProperty("SOIL");
SOILDIFF = SOIL;
i = 0;
for timestep = SOIL
if (i > 0)
SOILDIFF(:,i) = timestep - SOIL(:,i);
endif
i++;
endfor
SOILDIFF(:,i) = 0;
riSetActiveCellProperty(SOILDIFF, "SOILDIFF");
```
#### Example 2
```matlab
# Set all values to "Undefined" exept k-layers from 17 to 20
CInfo = riGetActiveCellInfo();
SOIL = riGetActiveCellProperty("SOIL");
Mask = (CInfo(:,4) < 17) | (CInfo(:,4) > 20)
LGRSOIL = SOIL;
i = 0;
for i = (1:columns(LGRSOIL))
LGRSOIL(Mask,i) = nan;
endfor
riSetActiveCellProperty(LGRSOIL, "KSlice");
```
#### Example 3
```matlab
# Keep the values in the first LGR only
CInfo = riGetActiveCellInfo();
SOIL = riGetActiveCellProperty("SOIL");
Mask = (CInfo(:,1) != 1);
LGRSOIL = SOIL;
i = 0;
for i = (1:columns(LGRSOIL))
LGRSOIL(Mask,i) = nan;
endfor
riSetActiveCellProperty(LGRSOIL, "LGRSOIL");
```
#### Example 4 ( Might be slow on big models)
```matlab
# Calculate the average SOIL value across K layers
CInfo = riGetActiveCellInfo();
SOIL = riGetActiveCellProperty("SOIL");
SOIL_KAverage = SOIL;
SOIL_KAverage(:) = nan;
mini = min(CInfo(:,2))
maxi = max(CInfo(:,2))
minj = min(CInfo(:,3))
maxj = max(CInfo(:,3))
for i = mini:maxi
for j = minj:maxj
Mask = (CInfo(:,1) == 0) & (CInfo(:,2) == i) & (CInfo(:,3) == j) ;
for ts = (1:columns(SOIL))
SOIL_KAverage(Mask, ts) = mean(SOIL(Mask, ts));
endfor
endfor
endfor
riSetActiveCellProperty(SOIL_KAverage, "SOIL_KAverage");
```

64
docs/Preferences.md
View File

@@ -5,21 +5,57 @@ permalink: /docs/preferences/
published: true
---
User defined preferences are store for each user of ResInsight.
In this section the different settings that controls the default behaviour of ResInsight is described. These settings can be controlled using the **Preference** dialog available from the **Edit -> Preferences** menu.
![ResInsight User Interface]({{ site.baseurl }}/images/Preferences.png)
![]({{ site.baseurl }}/images/Preferences.png)
## Configuration
The preferences are not stored in the project files, but rather in a platform specific way for each user.
- **Navigation mode** Defines how to use the mouse to interact with with the 3D model.
- **Script configuration** Defines where scripts are stored and what text editor to use for editing scripts
- **Octave** Defines the binary file of octave. Usually without path on Linux, and including path on Windows.
- **Default settings** The user can define a set of visual settings that will be used when creating new views.
- **Behaviour when loading new case**
- **Compute when loading new case** If not present, compute DEPTH, DX, DY, DZ, TOP, BOTTOM when loading new case
- **Load and show SOIL** Control if SOIL is loaded and applied to grid
- **Reader settings** Defines entities to import in addition to grid and grid properties.
- **ssihub Address** Statoil internal web service used to import well paths.
- **Use shaders** In some settings hardware accelerated methods are not possible to use(ie. remote desktop on Windows). This setting can disable shaders to be able to test behaviour without shaders.
- **Show 3D Information** Displays resource usage from the graphics card.
## General - tab
### Default settings - option group
This group of options controls visual settings that will be used when creating new views.
- **Viewer Background**
- **Gridlines** - Controls whether to show the gridlines by default.
- **Mesh Color**
- **Mesh Color Along Faults**
- **Well Label Color**
- **Font Size** - This font size is used for all labels shown in the 3D Views
### 3D views - option group
- **Navigation mode** - Defines how to use the mouse to interact with with the 3D model.
- **Use shaders** - This option controls the use of OpenGL shaders. Should be left **On**. Available only for testing purposes.
- **Show 3D Information** - Displays graphical resource usage as text in the 3D view.
### Behaviour when loading new case - option group
- **Compute when loading new case** - If not present, compute DEPTH, DX, DY, DZ, TOP, BOTTOM when loading new case
- **Load and show SOIL** - Control if SOIL is loaded and applied to grid
- **Import faults/NNCs/advanced MSW data** - Disable import of data for a case to reduce case import time.
### SSIHUB - option group
- **ssihub Address** - Optional Url to Statoil internal web service used to import well paths.
## Octave - tab
![]({{ site.baseurl }}/images/OctavePreferences.png)
### Octave - option group
- **Octave executable location** - Defines the binary file location for Octave. Usually without path on Linux, and including path on Windows.
- **Show text header when executing scripts** - Enables the default output that octave outputs when started.
### Script files - option group
- **Shared Script Folder(s)** - Defines the search paths for octave scripts
- **Script Editor** - The text editor to invoke when editing scripts
## Summary - tab
![]({{ site.baseurl }}/images/SummaryPreferences.png)
- **Create Summary Plots When Importing Eclipse Case** - Automatically import the summary case and display a plot if a `*.SMSPEC` file exists when importing an Eclipse binary case
- **Default Vector Selection Filter** - Wildcard text defining the summary vector filter to be applied by default. Default string is `F*OPT`

33
docs/ReservoirViews.md
View File

@@ -1,25 +1,26 @@
---
layout: docs
title: Working with 3D Views
title: 3D Views
permalink: /docs/reservoirviews/
published: true
---
3D Views are the windows displaying the Grid Models. The visualization is controlled by the **Project Tree** item representing the **View** and their subitems. Each item has a set of properties that can be editied in the **Property Editor**.
![]({{ site.baseurl }}/images/3DViewOverview.png)
Several views can be added to the same case by right clicking the case or a view in the case and select **New View**. You can also **Copy** and then **Paste** a view into a Case. All the settings are then copied to the new view.
3D Views are the windows displaying the Grid Models. The visualization is controlled by the **Project Tree** item representing the **View** and their subitems.
Views of Eclipse models and Geomechanical models has a lot in common, but Eclipse views has some features that applies to eclipse simulations only.
![]({{ site.baseurl }}/images/ViewTree.png)
Each item has a set of properties that can be editied in the **Property Editor**.
Several views can be added to the same case by right clicking the case or a view and select **New View**. You can also **Copy** and then **Paste** a view into a Case. All the settings are then copied to the new view.
Views of Eclipse models and Geomechanical models has a lot in common, but Eclipse views has some features that applies to Eclipse simulations only.
## Common view features
### View properties
![]({{ site.baseurl }}/images/ViewProperties.png)
Grid appearance can be controlled from the **Property Editor** when a view is selected. This includes background color and z scaling. In addition, cell visibilty controls of inactive and invalid cells.
Grid appearance can be controlled from the **Property Editor** when a view is selected. This includes background color and z scaling. In addition, cell visibilty controls of inactive and invalid cells. ![]({{ site.baseurl }}/images/ViewProperties.png)
Visibility of the grid box with labels displaying the coordinates for the reservoir can also be controlled using **Show Grid Box**.
@@ -27,10 +28,11 @@ Visibility of the grid box with labels displaying the coordinates for the reserv
The **Cell Result** item defines which Eclipse property the 3D View uses for the main cell color. The property can be chosen in the property panel of the **Cell Result** item. The mapping between cell values and color is defined by the **Legend Definition** ![]({{ site.baseurl }}/images/Legend.png) along with some appearance settings on the Legend itself. (Number format etc.)
Please refer to [Result Color Legend]({{ site.baseurl }}/docs/resultcolorlegend) for details.
### Range Filters &nbsp;![]({{ site.baseurl }}/images/CellFilter_Range.png) and Property Filters &nbsp;![]({{ site.baseurl }}/images/CellFilter_Values.png)
In order to see different sets of cells, and cells inside the reservoir, Views uses cell filters.
Please refer to [Cell Filters]({{ site.baseurl }}/docs/filters) to read more about them.
In order to see different sets of cells, and cells inside the reservoir, Views use cell filters. Please refer to [Cell Filters]({{ site.baseurl }}/docs/filters) to read more about them.
### Info Box
@@ -65,7 +67,7 @@ Toggling **Grids** off will hide the grid cell geometry. This option is used to
Intersections are used to cut the geometry and show result values mapped onto this geometry.
Please refer to [Intersections]({{ site.baseurl }}/docs/intersections) for details.
## Activate items by clicking
### Activate items by clicking
Selected overlay items in the 3D view can activate a corresponding item in the **Property Editor**. This is implemented for Info box and result color legends. Please note that this feature is activated by clicking inside the texture/colored part of the legend.
@@ -73,15 +75,16 @@ Selected overlay items in the 3D view can activate a corresponding item in the *
### Cell Edge Results ![]({{ site.baseurl }}/images/EdgeResult_1.png)
The **Cell Edge Result** visualization mode is one of ResInsight's special features. Its main use is to show the MULT(X, Y, Z) properties at the same time.
This will show the MULT property values *different from 1.0* along the correct edges of the cells. In effect this highlights the faults and makes it easy to verify all the MULT values in one go.
![]({{ site.baseurl }}/images/CellEdgeExample.png)
The **Cell Edge Result** visualization mode is one of ResInsight's special features. Its main use is to show the MULT(X, Y, Z) properties at the same time. This will show the MULT property values *different from 1.0* along the correct edges of the cells. In effect this highlights the faults and makes it easy to verify all the MULT values in one go.
ResInsight supports all properties ending with X, Y, Z and X-, Y-, Z-. However, it is only the MULT property that ignores values of 1.0.
When selecting a result variable for cell edge, a second legend shows up in the 3D view showing the variation in values for this second property. Color legend management is available when selecting the **Legend Definition** item belonging to the **Cell Edge Result** item.
Select **Custom Edge Result** to specify one cell result to be mapped onto all cell edges. This way two cell results can easily be compared and visualized in the same view. The **Custom Edge Result** can either be a static or dynamic result.
### Separate Fault Result
Default result mapping on faults is using the result specified in **Cell Result**. If a different result mapping is wanted, enable the checkbox and select the result from the result selection dialog in the **Property Editor**. A second legend for the fault result is added to the view.

31
docs/ResultColorLegend.md Normal file
View File

@@ -0,0 +1,31 @@
---
layout: docs
title: Result Color Legend
permalink: /docs/resultcolorlegend/
published: true
---
The color mapping of the displayed cell result is controlled by the **Legend Definition** located below a result node in the **Project Tree**
![Legend Configuration]({{ site.baseurl }}/images/legend_configuration.PNG)
Item | Description
-------------------|------------
Number of levels | Defines the number of tickmarks displayed next to the color legend
Significant digits | Defines the number of significant digits in the number formatting
Number format | Defines how the numbers are formatted
Colors | Defines the color palette
## Mapping
- **Discrete Linear** - Legend divided into levels defined by **Number of levels**
- **Continuous Linear** - Continuous legend with tickmark count defined by **Number of levels**
- **Continuous Logarithmic** - Continuous logarithmic legend with tickmark count defined by **Number of levels**
- **Discrete Logarithmic** - Logarithmic legend divided into levels defined by **Number of levels**
- **Category** - Special legend with one level for each category, either integer values or formation names. Only available for result names ending with ```NUM``` or formation names.
## Range type
- **All Timesteps** - values for all time steps are used to find min and max value of the result values represented by the color legend
- **Current Time Step** - use current (one) time step to find min and max values
- **User Defined Range** - user specifies numeric values for min and max

12
docs/ResultInspection.md
View File

@@ -4,17 +4,18 @@ title: Result Inspection
permalink: /docs/resultinspection/
published: true
---
![]({{ site.baseurl }}/images/ResultInspectionOverview.png)
The results mapped on the 3D model can be inspected in detail by left clicking the interesting cells in the 3D view.
The selected cells will be highlighted and text information extracted from the intersection point will be displayed in the docking window **Result Info**.
![]({{ site.baseurl }}/images/ResultInfoWithSelectedCell.png)
{% comment %} ![]({{ site.baseurl }}/images/ResultInfoWithSelectedCell.png) {% endcomment %}
If a dynamic result is active, the result values of the selected cells for all time steps are displayed in the docking window **Result Plot** as one curve for each cell.
Additional curves can be added to the plot if CTRL-key is pressed during picking. The different cells are highlighted in different colors, and the corresponding curve is colored using the same color.
![]({{ site.baseurl }}/images/ResultPlotWithSelectedCell.png)
{% comment %} ![]({{ site.baseurl }}/images/ResultPlotWithSelectedCell.png) {% endcomment %}
To clear the cell-selection, left-click outside the visible geometry.
@@ -25,13 +26,14 @@ Visibility of the docking widows can be controlled from the <b>Windows</b> menu.
## Result Info information
Clicking on different type of geometry will display slightly different information as described in the following tables:
### Reservoir model
### Eclipse model
Geometry | Description
--------------|------------
Reservoir cell| Displays grid cell result value, cell face, grid index and IJK coordinates for the cell. The intersection point coordinates is also displayed. Additional result details are listed in the section **-- Grid cell result details --**
Fault face | Displays the same info as for a *Reservoir cell*. In addition the section **-- Fault result details --** containing Fault Name and Fault Face information.
Fault face with NNC | Displays the same info as *Fault face*, except the Non Neighbor Connections (NNC) result value is displayed instead of grid cell value. Information added in section **-- NNC details --** is geometry information of the two cells connected by the NNC
Fault face with NNC | Displays the same info as *Fault face*, except the Non Neighbor Connections (NNC) result value is displayed instead of grid cell value. Information added in section **-- NNC details --** is geometry information of the two cells connected by the NNC.
Formation names| Displays name of formation the cell is part of
### Geomechanical model
@@ -43,4 +45,4 @@ Closest result | Closest node ID and result value
Element | Element ID and IJK coordinate for the element
Intersection point | Location of left-click intersection of the geometry
Element result details | Lists all integration point IDs and results with associated node IDs and node coordinates
Formation names | Displays name of formation the cell is part of

29
docs/Snapshots.md Normal file
View File

@@ -0,0 +1,29 @@
---
layout: docs
title: Snapshots
permalink: /docs/snapshots/
published: true
---
ResInsight can take screen shots of your different 3D Views and Plot Windows directly. These commands are available from the toolbar and the menues in the respective main window.
![]({{ site.baseurl }}/images/SnapShotToolBar.png)
### Snapshot to Clipboard ![]({{ site.baseurl }}/images/SnapShot.png)
A snapshot of the active view is copied to the clipboard using **Edit -> Copy Snapshot To Clipboard**.
### Snapshot to File ![]({{ site.baseurl }}/images/SnapShotSave.png)
Image export of the currently active 3D View or Plot Window can be launched from **File -> Export -> Snapshot To File**.
### Snapshot All Views/Plots to File ![]({{ site.baseurl }}/images/SnapShotSaveViews.png)
If a project contains multiple 3D Views or Plot Windows, all of them can be exported in one go using **File -> Export -> Snapshot All Views To File**. This will either export all the 3D Views or all the Plot Windows, depending on whether you invoke the command in the 3D Main Window or the Plot Main Window.
The files generated are stored in a folder named `snapshots` within the folder where the Project File resides.
<div class="note">
Snapshots can also be created and saved from the command line.
(See <a href="{{ site.baseurl }}/docs/commandlineparameters">Command Line Arguments</a> )
</div>

149
docs/SummaryPlots.md Normal file
View File

@@ -0,0 +1,149 @@
---
layout: docs
title: Summary Plots
permalink: /docs/summaryplots/
published: true
---
![]({{ site.baseurl }}/images/ResInsightMainPlotMediumSize.png)
ResInsight can create summary plots based on vectors from SUMMARY files (`*.SMSPEC`).
When opening an Eclipse case in the 3D view, the associated summary file is opened automatically by default, and made available as a **Summary Case**.
Summary files can also be imported directly using the command: **File->Import->Import Summary Case**.
When a summary case has been imported, a Summary Plot with a default **Curve Filter** is created.
The default behaviours can be configured in the [ Preferences ]({{ site.baseurl }}/docs/preferences).
## Summary Plots
A Summary Plot is a window displaying a graph in the main area of the Plot Mian Window. It can contain **Summary Curve Filters** and **Summary Curves** (See below) in addition to a title, left and right Y-Axis, and the Time-axis.
A new plot can be created by using the context menu of a plot selecting ![]({{ site.baseurl }}/images/SummaryPlot16x16.png) **New Summary Plot**.
![]({{ site.baseurl }}/images/SummaryPlotTree.png)
Most of the settings for the Plot itself is controlled by its sub items in the Property Tree:
- **Time Axis** - Controls the properties for the time axis (font size, title text, time range)
- **Left Y-axis** - Controls the properties for the left Y-axis
- **Right Y-axis** - Controls the properties for the right Y-axis
### Y-axis properties
![]({{ site.baseurl }}/images/summary_plot_yaxis_properties.png)
| Parameter | Description |
|-----------|-------------|
| **Auto Title** | If enabled, the y-axis title is derived from the vectors associated with the axis. Names and unit are used. |
| **Title** | If **Auto Title** is disabled, the plot title is set using this field |
| **Title Position** | Controls the position of the title. Center or At End |
| **Font Size** | Defines the font size used by the axis title |
| **Max and Min** | Defines the visible y range |
| **Number Format** | Defines how the legend numbers are formatted |
| **Logarithmic Scale** | Draw plot curves using a logarithmic scale |
#### Number Format
- **Auto** - Legend numbers are either using a scientific or decimal notation based on the number of digits of the value
- **Decimal** - Legend numbers are displayed using decimal notation
- **Scientific** - Legend numbers are displayed using scientific notation (ie. 1.2e+6)
### Time Axis Properties
![]({{ site.baseurl }}/images/SummaryTimeAxisProperties.png)
| Parameter | Description |
|-----------|-------------|
| **Show Title** | Toggles wheter to show the axis title |
| **Title** | A user defined name for the axis |
| **Title Position** | Either *Center* or *At End* |
| **Font Size** | The font Size used for the date/times shown at the ticks of the axis |
| **Time Mode** | Option to show the time from Simulation Start, or as real date-times. |
| | When activated, The **Time Unit** Option will appear, with options to show the relative time in different units|
| **Max**/**Min** | The range of the visible time in the Plot in the appropriate time unit. The format of dates is yyyy-mm-ddThh:mm:ssZ |
### Plot mouse interaction
- **Value Tracking** - When the mouse cursor is close to a curve, the closest curve sample is highlighted and the curve sample value at this location is displayed in a tooltip.
- **Selection** - Left mouse button click can be used to select several of the parts in the plot, and display them in the Property Editor:
- The closest curve
- Each of the Plot Axes
- The Plot itself if none of the above is hit and the Plot window is activated by the mouse click.
- **Window Zoom** - Window zoom is available by dragging the mouse when the left mouse button is pressed. Use ![]({{ site.baseurl }}/images/ZoomAll16x16.png) **Zoom All** to restore default zoom level.
## Summary Curve Filter
A Summary Curve filter is a simplified way of creating and controlling many related curves at the same time. It enables efficient search options to select a sensible subset of vectors and controls the appearance and naming of the resulting curves.
A new curve filter can be created by using the context menu of a plot selecting ![]({{ site.baseurl }}/images/SummaryCurveFilter16x16.png) **New Summary Curve Filter**.
![]({{ site.baseurl }}/images/summary_curve_filter_properties.PNG)
The property panel is divided in three main groups of options:
- **Summary Vectors** - Selecting what vectors to create curves from
- **Appearance Settings** - Options controlling how colors, symbols etc are assigned to the curves
- **Curve Name Configuration** - Control how the curves are named
In the following sections these groups of options are described in more detail.
In addition to the option groups there are three general items in the property panel:
| Name | Description |
|-----------|-------------|
| **Axis** | Controls wether the curves are to be associated with the left or right Y-Axis |
| **Auto Apply Changes** | When toggled, the changes in the property panel is instanly reflected in the generated and controlled curves |
| **Apply** | Applies the settings, and thus generates and updates the controlled curves |
### *Summary Vectors* - option group
This group of options is used to define the selection of summary vectors of interest. Several filtering tools are available to make this as convenient as possible.
| Name | Description |
|-----------|-------------|
| **Cases** | Selects the cases to be used when searching for data vectors. Several Cases can be selected at the same time. If a particular case is not selected, unique vectors defined in this case will not appear in the filter. |
| **Search** | This option controls the filtering mode. Several are available and controls witch search fields that are made available. This is described in more detail below.|
| *unnamed list of vectors* | This list displays the set of vectors filtered by the search options. Use this to select which of the vectors you want as curves. **Ctrl-A** selects them all.|
In the following, all the search fields are wildcard based text filters. An empty search string will match anything: any value or no value at all. A single `*` however, will only match something: There has to be some value for that particular quantity to make the filter match.
|**Search** mode | Description |
|----------------|--------------|
| **All** | A wildcard search filter applied to the colon-separated string that describes the complete vector. Eg `"*:*, 55, *"` or `"WBHP:*"`. This mode is the default. |
| **Field**, **Well**, **Group**, **Completion**, **Segment** ,**Block**, **Region**, **Region-Region**, **Lgr-Well**, **Lgr-Completion**, **Lgr-Block**, **Misc**, **Aquifer**, **Network** | These filter modes will only match vectors of the corresponding Eclipse output. The **Vector Name** field will match the name of the quantity itself, while the additional mode specific fields will match the item(s) beeing addressed. |
| **All (Advanced)** | This is a complete combined search mode with all the different search options available to create advanced cross item type searches.|
### *Appearance Settings* - option group
Curves created by a curve filter are assigned individual visual properties like colors and symbols in a systematic manner to make the plots easy to read. Different aspects of the vectors are assigned to different curve appearances. Eg. using symbols to distinguish cases, while using colors to distinguish quantity.
These assignments can be controlled using the options in the **Appearance Settings** group.
![]({{ site.baseurl }}/images/SummaryCurveFilterAppearance.png)
When set to **Auto** ResInsight assigns visual properties based on the present vector categories and the number of different values in each category.
When disabling the **Auto** option, you can select which of the visual curve properties to use for which vector category. The vector Category that currently can be used is Case, Vector, Well, Group and Region. The visual properties supported types are Color, Symbols, Line Style, Gradient and Line Thickness.
### *Curve Name Configuration* - option group
The user can control the curve names by toggeling what part of the summary vector information to use in the name.
## Summary Curve
A new curve can be created by using the context menu of a plot selecting ![]({{ site.baseurl }}/images/SummaryCurve16x16.png) **New Summary Curve**.
![]({{ site.baseurl }}/images/summary_curve_properties.png)
Many of the properties of a single curve is similar to the properties described for a curve filter. The appearance however, is controlled directly.
<div class="note">
The appearance set on a curve in a curve filter will override the settings in the curvefilter until the curvefilter settings are applied again. Then the clocal changes on the curve are overwritten.
</div>
## Copy and Paste
Copy and Paste of selections of Summary Plots, Curves, or Curve Filter is possible using the Project Tree Context menu and standard keyboard shortcuts (CTRL-C/CTRL-V).

76
docs/WellLogsAndPlots.md
View File

@@ -5,22 +5,11 @@ permalink: /docs/welllogsandplots/
published: true
---
ResInsight can display well logs from imported LAS-files and by extracting data from a simulation model along a well trajectory. Extracted simulation data can be exported to LAS-files for further processing.
![]({{ site.baseurl }}/images/WellLogPlotOverview.png)
## Importing LAS-files
LAS-files can be imported using the command: **File->Import->Import Well Logs from File**.
ResInsight can display well logs by extracting data from a simulation model along a well trajectory and from imported LAS-files. Extracted simulation data can be exported to LAS-files for further processing.
ResInsight will search for the the well name in the imported LAS-files among your existing **Well Trajectories**.
If a match is found, the LAS-file is placed as a child of that trajectory. If not, a new empty trajectory entry is created with the imported LAS-file under it.
![]({{ site.baseurl }}/images/LasFilesInTree.png)
If the LAS-file does not contain a well name, the file name is used instead.
## Plots, Tracks and Curves
### Creating Well Log Plots
## Well Log Plots
Well log plots can be created in several ways:
@@ -28,26 +17,25 @@ Well log plots can be created in several ways:
2. Right click a wellpath, either in the **Project Tree** or in the 3D-view, and select either **New Well Log Extraction Curve**. A new plot with a single **Track** and a **Curve** is created. The curve is setup to match your selection (Well trajectory, active case and result)
3. Right click a LAS-file channel in the **Project Tree** and select **Add to New Plot**. A new plot with a single **Track** and a **Curve** is created. The curve is setup to plot the selected LAS-file channel.
Each **Well Log Plot** can contain several *Tracks*, and each **Track** can contain several **Curves**.
![]({{ site.baseurl }}/images/WellLogPlotWindow.png)
Tracks and Curves can be organized using drag and drop functionality in the **Project Tree**. Tracks can be moved from one plot to another, and you can alter the order in which they appear in the **Plot**. **Curves** can be moved from one **Track** to another.
### Plots
All the **Tracks** in the same plot always display the same depth range, and share the *True Veritcal Depth (TVD)* or *Measured Depth (MD)* setting. In the property panel of the plot, the exact depth range can be adjusted along with the depth type setting (TVD/MD).
#### Depth unit
The unit for depth can be set using **Depth unit**, and currently supported units are *Meter* and *Feet*. The first curve added to a plot will set the plot unit based on the curve unit. Additional curves added to a plot will be converted to the plot unit if needed.
### Depth unit
#### Depth zoom and pan
The depth unit can be set using the **Depth unit** option. Currently ResInsight supports *Meter* and *Feet*. The first curve added to a plot will set the plot unit based on the curve unit. Additional curves added to a plot will be converted to the plot unit if needed.
### Depth zoom and pan
The visible depth range can be panned using the mouse wheel while the mouse pointer hovers over the plot.
Pressing and holding **CTRL** while using the mouse wheel will allow you to zoom in or out depth-wise, towards the mouse position.
### Track
## Tracks
Tracks can be created by right clicking a **Well Log Plot** and select **New Track**
![]({{ site.baseurl }}/images/TrackProperties.png)
@@ -55,9 +43,8 @@ Tracks can be created by right clicking a **Well Log Plot** and select **New Tra
A track controls the x-axis range of the display, and can be edited from the property panel of the **Track**.
Logarithmic display is controlled using the **Logarithmic Scale** option.
## Curves
### Curves
Curves can be created by right clicking a **Track** in the **Project Tree**, or by the commands mentioned above.
There are two types of curves: *Well Log Extraction Curves* and *Well Log LAS Curves*.
@@ -68,7 +55,7 @@ Curve visual appearance is controlled in the **Appearance** section:
- **Point style** - Defines the style used to draw the result points of the curve, select *None* to disable drawing of points
- **Line style** - Defines the the style used to draw the curve, select *None* to disable line drawing
#### Well Log Extraction Curves
### Well Log Extraction Curves
Ectraction curves acts as an artifical well log curve. Instead of probing the real well, a simulation model is probed instead.
@@ -85,24 +72,49 @@ Placing keyboard focus in the <b>Time Step</b> drop-downbox will allow you to us
The disply name of a curve is normally generated automatically. The options grouped below **Auto Name** can be used to tailor the length and content of the curve name.
##### Curve extraction calculation
#### Curve extraction calculation
This section describes how the values are extracted from the grid when creating a Well log Extraction Curve.
Ectraction curves are calculated by finding the intersections between a well trajectory and the cell-faces in a particular grid model. Usually there are two intersections at nearly the same spot; the one leaving the previous cell, and the one entering the next one. At each intersection point the measured depth along the trajectory is interpolated from the trajectory data. The result value is retreived from the corresponding cell in different ways depending on the nature of the underlying result.
For Eclipse results the cell face value is used directly. This is normally the same as the corresponding cell value, but if a **Directional combined results** is used, (See [ Derived Results ]({{ site.baseurl }}/docs/derivedresults) ) it will be that particular face's value.
Abaqus results are interpolated across the intersected cell-face from the result values associated with the nodes of that face. This is also the case for integration point results, as they are directly associated with their corresponding element node in ResInsight.
#### Well Log LAS Curves
### Well Log LAS Curves
LAS-curves shows the values in a particular channel in a LAS-file.
<div class="note">
You can also create a LAS-curve by a simple drag-drop operation in the <b>Project Tree</b>: Drag one of the LAS channels and drop it onto a <b>Track</b>. A new curve will be created with the correct setting.
</div>
The property panel of a LAS-curve is shown below:
![]({{ site.baseurl }}/images/WellLogLasCurveProperties.png)
## Exporting LAS-files
A well log curve can be exported to a separate LAS file by right clicking the curve, and select **Export To LAS-File ...**. The proposed file name is the same as the curve name, but adjusted to be file name compatible. The name of the well trajectory used to create the curve (Extraction Curve) is written into the WELL section of the LAS file.
<div class="note">
You can also create a LAS-curve by a simple drag-drop operation in the <b>Project Tree</b>: Drag one of the LAS channels and drop it onto a <b>Track</b>. A new curve will be created with the correct setting.
</div>
## LAS-file Support
ResInsight has some support for reading and writing LAS files. In the following two sections this support is described.
### Importing LAS-files
LAS-files can be imported using the command: **File->Import->Import Well Logs from File**.
ResInsight will search for the the well name in the imported LAS-files among your existing **Well Trajectories**.
If a match is found, the LAS-file is placed as a child of that trajectory. If not, a new empty trajectory entry is created with the imported LAS-file under it.
![]({{ site.baseurl }}/images/LasFilesInTree.png)
If the LAS-file does not contain a well name, the file name is used instead.
### Exporting LAS-files
A set of curves can be exported to LAS files by right clicking the curves, well log track, or well log plots and select **Export To LAS Files ...**. An export dialog is diplayed, allowing the user to configure how to export curve data.
![]({{ site.baseurl }}/images/export_to_las_files.png)
- **Export Folder** - Location of the exported LAS files, one file per unique triplet of well path, case and time step
- **Resample Curve Data** - If enabled, all curves are resampled at the given resample interval before export
- **TVDRKB** - If enabled, TVDRKB for all curves based on the listed well paths are exported. If the difference field is blank, no TVDRKB values are exported.

3
docs/WellPaths.md
View File

@@ -4,12 +4,11 @@ title: Well Trajectories
permalink: /docs/wellpaths/
published: true
---
![]({{ site.baseurl }}/images/ResInsight_WellPathWithSimulationWell.png)
ResInsight can import Well trajectories from simple Ascii files.
In addition, a Statoil specific solution to retrieve Well Trajectories from their internal web service is implemented.
![]({{ site.baseurl }}/images/ResInsight_WellPathWithSimulationWell.png)
## Ascii Well Trajectories
The command **File -> Import -> Import Well Paths From File** will read the well paths in the selected file, and create one entry for each trajectory under the ![]({{ site.baseurl }}/images/WellCollection.png) **Wells** item in the **Project Tree**.

BIN
images/3DViewOverview.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 133 KiB

After

Width:  |  Height:  |  Size: 178 KiB

BIN
images/3DWindow24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
images/3d_view_context_menu.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB

BIN
images/AnimationProgress.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 496 B

After

Width:  |  Height:  |  Size: 920 B

BIN
images/CaseInfoText.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

BIN
images/CaseProperties.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.9 KiB

After

Width:  |  Height:  |  Size: 7.1 KiB

BIN
images/DerivedRelativeResults.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.2 KiB

BIN
images/EclipseInput24x24.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

BIN
images/ExecuteOctaveScriptOnSelectedCases.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 30 KiB

BIN
images/ExportFaultsMenu.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
images/FaultsIllustration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 97 KiB

BIN
images/FiltersInTreeView.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.4 KiB

BIN
images/FiltersOverview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 75 KiB

BIN
images/GeoMechCasePropertyPanel.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.6 KiB

BIN
images/HistogramExample.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 639 B

After

Width:  |  Height:  |  Size: 1.0 KiB

BIN
images/IntersectionBoxWithHandles.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
images/IntersectionOverview.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 191 KiB

After

Width:  |  Height:  |  Size: 93 KiB

BIN
images/IntersectionWellPath.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

BIN
images/OctavePreferences.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
images/Perspective24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 633 B

BIN
images/PlotWindow24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
images/Preferences.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 17 KiB

BIN
images/PropertyFilterWithCategories.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
images/ResInsightMainPlotMediumSize.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 116 KiB

BIN
images/ResInsightUIMediumSize.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 337 KiB

After

Width:  |  Height:  |  Size: 296 KiB

BIN
images/ResultInspectionOverview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 95 KiB

BIN
images/SnapShotToolBar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.0 KiB

BIN
images/SummaryCase24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
images/SummaryCase48x48.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
images/SummaryCurve16x16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 289 B

BIN
images/SummaryCurveFilter16x16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 436 B

BIN
images/SummaryCurveFilterAppearance.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
images/SummaryPlot16x16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 505 B

BIN
images/SummaryPlotTree.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
images/SummaryPlots16x16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 879 B

BIN
images/SummaryPreferences.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.9 KiB

BIN
images/SummaryTimeAxisProperties.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.7 KiB

BIN
images/TileWindows24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.0 KiB

BIN
images/TreeViewToggle.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.4 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

BIN
images/ViewProperties.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
images/ViewTree.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
images/WellLogPlotOverview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 116 KiB

BIN
images/ZoomAll16x16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 899 B

BIN
images/export_to_las_files.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
images/formations_legend.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 75 KiB

BIN
images/formations_property_editor.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
images/legend_configuration.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
images/summary_curve_filter_properties.PNG
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 20 KiB

BIN
images/summary_curve_properties.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 26 KiB

BIN
images/summary_plot_yaxis_properties.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.9 KiB

After

Width:  |  Height:  |  Size: 12 KiB

BIN
images/summary_plots_overview.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 114 KiB

15
index.html
View File

@@ -7,7 +7,7 @@ overview: true
<section class="intro">
<div class="grid">
<div class="unit whole center-on-mobiles">
<p class="first">Fast and Free 3D Visualization of Reservoir Simulations</p>
<p class="first">Post Processing of Reservoir Simulations</p>
</div>
<div class="post-content">
<img src="{{ site.baseurl }}/images/FrontPageImage.png" alt="Reservoir" />
@@ -17,11 +17,12 @@ overview: true
<section class="features">
<div class="grid">
<div class="unit one-third">
<h2>Fast</h2>
<h2>Fast and Free</h2>
<p>
&#x2713; Hazzle free<br>
&#x2713; Starts in an instant<br>
&#x2713; Efficient handling of large Eclipse cases<br>
&#x2713; Open source<br>
&#x2713; Efficient user interface<br>
&#x2713; Plotting of summary vectors<br>
&#x2713; Handles large Eclipse cases<br>
</p>
</div>
<div class="unit one-third">
@@ -30,14 +31,14 @@ overview: true
&#x2713; NNC visualization<br>
&#x2713; Cell Edge Coloring<br>
&#x2713; Detailed MSW visualization<br>
&#x2713; Seemless <a href="http://www.gnu.org/software/octave/"> Octave</a> integration<br>
&#x2713; Seamless <a href="http://www.gnu.org/software/octave/"> Octave</a> integration<br>
&#x2713; Supports geomechanical ABAQUS simulations<br>
</p>
</div>
<div class="unit one-third">
<h2>Getting started</h2>
<p>
It's easy, both on Linux and Windows:
It's easy and free, both on Linux and Windows:
</p>
<a href="{{ site.baseurl }}/docs/installation/">Installation &rarr;</a><br>
<a href="{{ site.baseurl }}/docs/gettingstarted/">Getting Started &rarr;</a>

146
js/jquery.toc.js Normal file
View File

@@ -0,0 +1,146 @@
/*
* jQuery Table of Content Generator for Markdown v1.0
*
* https://github.com/dafi/tocmd-generator
* Examples and documentation at: https://github.com/dafi/tocmd-generator
*
* Requires: jQuery v1.7+
*
* Copyright (c) 2013 Davide Ficano
*
* Dual licensed under the MIT and GPL licenses:
* http://www.opensource.org/licenses/mit-license.php
* http://www.gnu.org/licenses/gpl.html
*/
(function($) {
var toggleHTML = '<div id="toctitle"><h2>%1</h2> <span class="toctoggle">[<a id="toctogglelink" class="internal" href="#">%2</a>]</span></div>';
var tocContainerHTML = '<div id="toc-container"><table class="toc" id="toc"><tbody><tr><td>%1<ul>%2</ul></td></tr></tbody></table></div>';
function createLevelHTML(anchorId, tocLevel, tocSection, tocNumber, tocText, tocInner) {
var link = '<a href="#%1"><span class="tocnumber">%2</span> <span class="toctext">%3</span></a>%4'
.replace('%1', anchorId)
.replace('%2', tocNumber)
.replace('%3', tocText)
.replace('%4', tocInner ? tocInner : '');
return '<li class="toclevel-%1 tocsection-%2">%3</li>\n'
.replace('%1', tocLevel)
.replace('%2', tocSection)
.replace('%3', link);
}
$.fn.toc = function(settings) {
var config = {
renderIn: 'self',
anchorPrefix: 'tocAnchor-',
showAlways: false,
minItemsToShowToc: 2,
saveShowStatus: true,
contentsText: 'Contents',
hideText: 'hide',
showText: 'show',
showCollapsed: false};
if (settings) {
$.extend(config, settings);
}
var tocHTML = '';
var tocLevel = 1;
var tocSection = 1;
var itemNumber = 1;
var tocContainer = $(this);
tocContainer.find('h1').each(function() {
var levelHTML = '';
var innerSection = 0;
var h1 = $(this);
h1.nextUntil('h1').filter('h2').each(function() {
++innerSection;
var anchorId = config.anchorPrefix + tocLevel + '-' + tocSection + '-' + + innerSection;
$(this).attr('id', anchorId);
levelHTML += createLevelHTML(anchorId,
tocLevel + 1,
tocSection + innerSection,
itemNumber + '.' + innerSection,
$(this).text());
});
if (levelHTML) {
levelHTML = '<ul>' + levelHTML + '</ul>\n';
}
var anchorId = config.anchorPrefix + tocLevel + '-' + tocSection;
h1.attr('id', anchorId);
tocHTML += createLevelHTML(anchorId,
tocLevel,
tocSection,
itemNumber,
h1.text(),
levelHTML);
tocSection += 1 + innerSection;
++itemNumber;
});
// for convenience itemNumber starts from 1
// so we decrement it to obtain the index count
var tocIndexCount = itemNumber - 1;
var show = config.showAlways ? true : config.minItemsToShowToc <= tocIndexCount;
// check if cookie plugin is present otherwise doesn't try to save
if (config.saveShowStatus && typeof($.cookie) == "undefined") {
config.saveShowStatus = false;
}
if (show && tocHTML) {
var replacedToggleHTML = toggleHTML
.replace('%1', config.contentsText)
.replace('%2', config.hideText);
var replacedTocContainer = tocContainerHTML
.replace('%1', replacedToggleHTML)
.replace('%2', tocHTML);
// Renders in default or specificed path
if (config.renderIn != 'self') {
$(config.renderIn).html(replacedTocContainer);
} else {
tocContainer.prepend(replacedTocContainer);
}
$('#toctogglelink').click(function() {
var ul = $($('#toc ul')[0]);
if (ul.is(':visible')) {
ul.hide();
$(this).text(config.showText);
if (config.saveShowStatus) {
$.cookie('toc-hide', '1', { expires: 365, path: '/' });
}
$('#toc').addClass('tochidden');
} else {
ul.show();
$(this).text(config.hideText);
if (config.saveShowStatus) {
$.removeCookie('toc-hide', { path: '/' });
}
$('#toc').removeClass('tochidden');
}
return false;
});
if (config.saveShowStatus && $.cookie('toc-hide')) {
var ul = $($('#toc ul')[0]);
ul.hide();
$('#toctogglelink').text(config.showText);
$('#toc').addClass('tochidden');
}
if (config.showCollapsed) {
$('#toctogglelink').click();
}
}
return this;
}
})(jQuery);

3
project/about.md
View File

@@ -13,7 +13,8 @@ ResInsight is part of the [Open Porous Media](http://opm-project.org/) project.
### Licensing
The software is copyrighted by Statoil ASA, Ceetron Solutions AS and Ceetron AS. The software is licensed under GPL 3+, see [Licensing details](https://github.com/OPM/ResInsight/blob/master/COPYING).
The software is licensed under GPL 3+, see [Licensing details](https://github.com/OPM/ResInsight/blob/master/COPYING).
### Project hosting
The software is hosted at [GitHub](https://github.com/OPM/ResInsight)

4
project/testimonials.md
View File

@@ -14,3 +14,7 @@ Senior Petroleum Engineering Advisor, RPS Energy**
**Tor Harald Sandve<br>
Researcher, International Research Institute of Stavanger (IRIS)**
<div class="note">
Statoil ASA has initiated, financed and supervised the development of ResInsight and is using it on a daily basis.
</div>