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

Major blob checkin of documentation for ResInsight v1.4.0

Browse Source 
Development done on a separate fork (JacobStøren/ResInsight)
This commit is contained in:
Jacob Støren
2015-08-23 21:06:20 +02:00
parent bc7f85bb27
commit 3abce5ac13
21 changed files with 337 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -9,9 +9,9 @@ ResInsight
- Set gh-pages as default branch
- Enable Git Hub Pages
- Add baseurl: /ResInsight to _config.yml
- go to <your githubname>.github.io/ResInsight and see your version of the site
- 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
## Puliblishing to main gh-pages
The history is not importent, 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.
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.

2
_data/docs.yml
View File

@@ -1,8 +1,10 @@
- title: Getting Started
docs:
- home
- odbsupport
- gettingstarted
- installation
- installationlinux
- title: Application
docs:

95
docs/BuildInstructions.md
View File

@@ -7,60 +7,83 @@ permalink: /docs/buildinstructions/
published: true
---
ResInsight uses the CMake build system and requires CMake version 2.8 or higher. Moreover, you need version 4.7.3 of Qt or newer, look below for dependency list.
## CMAKE configuration
## CMake configuration
If you check the button 'Grouped' in the GUI, the CMake variables are grouped by prefix. This makes it easier to see all settings for ResInsight.
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).
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.
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
- Click "Configure" and select your preferred compiler
- Set the build options and click "Configure" again (see ResInsight specific options below)
- Click "Generate" to generate the makefiles or solution file and project files in the build directory
- 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.
### Linux
ResInsight has been verified to build and run on RedHat Linux 6. Typical usage is to follow the build instructions above to build the makefiles. Then go to the build directory, and run:
- make
- make install
To build from the command line without using the CMake GUI:
- mkdir ResInsight_build
- cd ResInsight_build
- ...
- (set CMake options)
- ...
- cmake < path to ResInsight source folder >
- make
- make install
You will find the ResInsight binary under the Install directory in your build directory.
### General CMake options for ResInsight
| CMake Name | Description |
|--------------|---------|
| `RESINSIGHT_BUILD_DOCUMENTATION` | Use Doxygen to create the HTML based API documentation |
| `RESINSIGHT_OCTAVE_PLUGIN_32_BIT` | Windows 64-bit: Flag used to control if Octave plugins will be compiled using 32-bit build environment |
| `RESINSIGHT_OCTAVE_PLUGIN_MKOCTFILE` | Location of Octave tool mkoctfile used to compile Octave plugins |
| `RESINSIGHT_OCTAVE_PLUGIN_QMAKE` | Location of qmake to find Qt include files and libraries used to compile Octave plugins |
| `RESINSIGHT_PRIVATE_INSTALL` | Install as an independent bundle including the necessary Qt libraries |
| `RESINSIGHT_USE_OPENMP` | Enable OpenMP multi-core parallel building |
| `RESINSIGHT_USE_OPENMP` | Enable OpenMP parallellization in the code |
### Build without Octave plugins
It is possible to compile ResInsight without compiling the Octave plugins. This can be done by specifying blank for the Octave CMake variables. The Octave plugin module will not be build, and CMake will show warnings like 'Failed to find mkoctfile'. This will not break the build or compilation of ResInsight.
### Optional - Octave plugins
To be able to compile the Octave plugins, the path to the Octave development tool `mkoctfile` must be provided.
### Build instructions Visual Studio
- Open the CMake GUI
- Set the path to the source code
- Set the path to the build directory
- Click "Configure" and select your preferred compiler, "Visual Studio 10" or "Visual Studio 10 Win64"
- Set the build variables and click "Configure" again
- Click "Generate", and one solution file and several project files will be created in the build directory
- Open the solution file in Visual Studio
It is possible to build ResInsight without compiling the Octave plugins. This can be done by specifying blank for the Octave CMake options. The Octave plugin module will not be built, and CMake will show warnings like 'Failed to find mkoctfile'. This will not break the build or compilation of ResInsight.
### Optional - build instructions Octave plugins
To be able to compile the Octave plugins, the path to the Octave development tool `mkoctfile` must be provided. In addition, if you compile x64, you must specify the location of 32-bit version of Qt, as the Octave plugins on Windows are currently only supported for x86.
See description for `RESINSIGHT_OCTAVE_PLUGIN_QMAKE` and `RESINSIGHT_OCTAVE_PLUGIN_32_BIT` above.
ResInsight has been verified to build and run with Octave versions 3.4.3, 3.8.1, and 4.0.0.
## Linux
#### Octave related CMake options for ResInsight
An out-of-tree build is typically done with
| CMake Name | Description |
|--------------|---------|
| `RESINSIGHT_OCTAVE_PLUGIN_32_BIT` | Set 32-bit MSVC compiler environment while running mkoctfile |
| `RESINSIGHT_OCTAVE_PLUGIN_MKOCTFILE` | Location of Octave tool mkoctfile used to compile Octave plugins |
| `RESINSIGHT_OCTAVE_PLUGIN_QMAKE` | Location of Qt version to use when compiling Octave plugins. Must be compatible with Octave runtime. (Use the Qt version embedded in Octave. The qmake executable itself is not used, only the path to the directory.) |
{% highlight text %}
mkdir ResInsight/build
cd ResInsight/build
cmake ..
make
make install
{% endhighlight %}
### Optional - ABAQUS ODB API
ResInsight can be built with support for ABAQUS ODB files. This requires an installation of the ABAQUS ODB API from Simulia on the build computer. The path to the ABAQUS ODB API folder containing header files and library files must be specified. Leaving this option blank gives a build without ODB support. ResInsight has been built and tested with ABAQUS ODB API version 6.14-3 on Windows 7/8 and RedHat Linux 6.
You will find the ResInsight binary under the Install directory in your build directory.
#### ABAQUS ODB API related CMake options for ResInsight
| CMake Name | Description |
|--------------|---------|
| `RESINSIGHT_ODB_API_DIR` | Optional path to the ABAQUS ODB API from Simulia |
### Dependencies for Debian based distributions
{% highlight text %}
sudo apt-get install git cmake build-essential octave octave-headers qt4-dev-tools
{% endhighlight %}
- sudo apt-get install git cmake build-essential octave octave-headers qt4-dev-tools
If you are running Ubuntu 12.10 or newer, you will need to replace octave-headers with liboctave-dev :
{% highlight text %}
sudo apt-get install git cmake build-essential octave liboctave-dev qt4-dev-tools
{% endhighlight %}
- sudo apt-get install git cmake build-essential octave liboctave-dev qt4-dev-tools

47
docs/DerivedResults.md
View File

@@ -7,8 +7,11 @@ permalink: /docs/derivedresults/
published: true
---
ResInsight computes several derived results. In this section we will explain what they are, and briefly how they are calculated.
ResInsight is able to compute derived results listed at the bottom **Static** properties.
## Derived results for Eclipse cases
The derived results are listed at the bottom of the **Static** result properties, as shown below.
![]({{ site.baseurl }}/images/DerivedStaticResults.png)
@@ -38,4 +41,44 @@ The directional combined parameters available are:
- **MULTXYZ**
- **riTRANXYZ** (inluding NNCs)
- **riMULTXYZ** (inluding NNCs)
- **riTRANXYZbyArea** (inluding NNCs)
- **riTRANXYZbyArea** (inluding NNCs)
## Derived Geomechanical results
ResInsight calculates several of the geomechanical results presented. Here we will present a brief overview.
The calculated result fields including their components are:
SE, E, ST and Gamma
In this text the label Sa and Ea will be used to denote the unchanged stress and strain tensor respectivly from the odb file.
### 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
### E - Strain
E<sub>ij</sub> = -Ea<sub>ij</sub>
### ST - Total stress
ST<sub>ii</sub> = -Sa<sub>ii</sub> + POR (i= 1,2,3)
ST<sub>ij</sub> = -Sa<sub>ij</sub> (i,j = 1,2,3 and i not equal j)
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
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.

37
docs/Filters.md
View File

@@ -11,16 +11,31 @@ Cell Filters are used to control visibility of the cells in the 3D view. Three t
- **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. Controlled from the **Simulation Wells** item.
- **Well cell filter** : Display grid cells that has connections to a well.
All filters can be turned on or off using the toggle in the **Project Tree** and controlled from their corresponding **Property Editor**.
### 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 filters
### Common properties for Range and Property Filters
Using range filters enables the user to define a set of IJK visible regions in the 3D view.
A new range filter can be added by activating the context menu for the **Range Filters** collection in the **Project Tree**.
Both filter types can be turned on or off using the toggle in the **Project Tree** and controlled from their corresponding **Property Editor**.
*TIP:* An I,J or K-slice range filter can be added directly from a Cell in the **3D View** by rightclicking the cell and using the context menu.
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.
The **Include** setting behaves differently for Range filters and Property Filters but marks the cells as visible.
The icon in front of the filters show a + or - sign to indicate the setting ![]({{ site.baseurl }}/images/FilterIncEx.png)
### Range filters
Range filters enables the user to define a set of visible regions in the 3D view based on IJK boxes.
Each *Include* range filter will *add more cells* to the visualization. The view will show the union of all the *Include* range filters.
A new range filter can be added by activating the context menu for the **Range Filters** collection in the **Project Tree**.
<div class="note">
An I,J or K-slice range filter can be added directly from a Cell in the <b>3D View</b> by rightclicking the cell and using the context menu.
</div>
Below is a snapshot of the **Property Editor** of the **Range Filter** :
@@ -34,12 +49,16 @@ The **Start** and **Width** labels in front of the sliders features a number in
The **Start** labels shows the index of the start of the active cells.<br>
The **Width** labels shows the number of active cells from the start of the active cells.
## Property filters
### Property filters
**Property filters** apply to the results of the **Range filters**. Below is a snapshot of the **Property Editor** of the **Property Filter**.
**Property filters** applies to the results of the **Range filters** and limits the visible cells to the ones approved by the filter. For a cell to be visible it must be accepted by all the property filters.
Below is a snapshot of the **Property Editor** of the **Property Filter**.
![]({{ site.baseurl }}/images/PropertyFilterProperties.png)
This filter filters the cells 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.
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.

19
docs/GettingStarted.md
View File

@@ -1,6 +1,6 @@
---
layout: docs
prev_section: home
prev_section: odbsupport
next_section: installation
title: Getting Started
permalink: /docs/gettingstarted/
@@ -56,8 +56,10 @@ How to interact and manipulate the 3D model is described in [Model Navigation]({
### Cases and their types
A *Case* in ResInsight means a Grid model with a particular set of results or property data. There are
three different Case types:
A *Case* in ResInsight means a Grid model with a particular set of results or property data. There are three different types of Eclipse cases and one type of Geomechanical cases.
#### Eclipse Cases
There are three different Eclipse Case types:
##### Result case ![]({{ site.baseurl }}/images/Case24x24.png)
This is a Case based on the results of an Eclipse simulation, read from a grid file together with static and restart data. Multiple Cases can be selected and read from a folder.
@@ -69,9 +71,14 @@ Each of the Eclipse properties is listed as separate entities in the **Project T
##### 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.
#### 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.
#### Grid Case Groups ![]({{ site.baseurl }}/images/GridCaseGroup24x24.png)
A **Grid Case Group** is a group of **Result Cases** with identical grids, but generally different active cells, initial values and results. These cases are called *Source Cases*.
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.
@@ -85,7 +92,9 @@ This file only contains references to the real data files, and even references t
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.
*TIP:* The `.rsp`-file is an XML file, and can be edited by any text editor.
<div class="note">
The `.rsp`-file is an XML file, and can be edited by any text editor.
</div>
### Export options

32
docs/GridImportExport.md
View File

@@ -2,42 +2,54 @@
layout: docs
prev_section: reservoirviews
next_section: simulationwells
title: Grid Import
title: Grid Import and Property Export
permalink: /docs/gridimportexport/
published: true
---
### Importing Eclipse cases
ResInsight supports the following type of Eclipse input data:
- `*.GRID` and `*.EGRID` files along with their `*.INIT` and restart files `*.XNNN` and `*.UNRST`.
- Grid and Property data from `*.GRDECL` files.
### Importing Eclipse cases
#### Eclipse Results
1. Select **File->Import->Import Eclipse Case** and select an `*.EGRID` or `*.GRID` Eclipse file for import.
1. Select **File->Import-> ![]({{ site.baseurl }}/images/Case24x24.png) Import Eclipse Case** and select an `*.EGRID` or `*.GRID` Eclipse file for import.
2. The case is imported, and a view of the case is created
*TIP:* You can select several grid files in one go by multiple selection of files( Ctrl + left mouse button, Shift + left mouse button).
<div class="note">
You can select several grid files in one go by multiple selection of files (Ctrl + left mouse button, Shift + left mouse button).
</div>
#### Eclipse ASCII input data
1. Select **File->Import->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.
#### Handling missing or wrong MAPAXES
The X and Y grid data can be negated in order to make the Grid model appear correctly in ResInsight. This functionality is accessible in the **Property Editor** for all Case types as the toggle buttons **Flip X Axis** and **Flip Y Axis** as shown in the example below.
The X and Y grid data can be negated in order to make the Grid model appear correctly in ResInsight. This functionality is accessible in the **Property Editor** for all Eclipse Case types as the toggle buttons **Flip X Axis** and **Flip Y Axis** as shown in the example below.
![]({{ site.baseurl }}/images/CaseProperties.png)
### Importing ABAQUS odb cases
When ResInsight is compiled with ABAQUS-odb support, `*.odb` files can be imported by selecting the command:
## 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)
**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>
/
/

20
docs/Home.md
View File

@@ -1,18 +1,28 @@
---
layout: docs
title: ResInsight 1.3 Users Guide
next_section: gettingstarted
title: ResInsight 1.4 Users Guide
next_section: odbsupport
permalink: /docs/home/
published: true
---
ResInsight is an open source, cross-platform 3D visualization and post processing tool for reservoir models and simulations. The system also constitutes a framework for further development and support for new data sources and visualization methods, e.g. additional solvers, seismic data, CSEM, geomechanics, and more.
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.
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. 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.
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.
### 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.
### 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.
### Data support
The main input data is
`*.GRID` and `*.EGRID` files along with their `*.INIT` and restart files `*.XNNN` and `*.UNRST`.
ResInsight also supports selected parts of Eclipse input files and can read grid
information and corresponding cell property data sets.
ResInsight has been co-developed by [Statoil ASA](http://www.statoil.com/), [Ceetron Solutions AS](http://www.ceetronsolutions.com/), and [Ceetron AS](http://ceetron.com/) with the aim to provide a versatile tool for professionals who need to visualize and process reservoir models.
ResInsight can also be built with support for Geomechanic models from ABAQUS in the `*.odb` file format.
### About
ResInsight has been co-developed by [Statoil ASA](http://www.statoil.com/), [Ceetron Solutions AS](http://www.ceetronsolutions.com/), and [Ceetron AS](http://ceetron.com/) with the aim to provide a versatile tool for professionals who need to visualize and process reservoir models.

34
docs/Installation.md
View File

@@ -1,28 +1,32 @@
---
layout: docs
prev_section: gettingstarted
next_section: reservoirviews
title: Installation and Configuration
next_section: installationlinux
title: Installation and Configuration (Windows)
permalink: /docs/installation/
published: true
---
### Windows
<small>Note: None of the binary distributions includes support for ABAQUS odb files.</small>
### ResInsight installation
1. Download ZIP binary distribution from [https://github.com/OPM/ResInsight/releases](https://github.com/OPM/ResInsight/releases "release section on GitHub")
2. Extract content from ZIP file
3. (OPTIONAL) Launch ResInsight.exe, open **Edit->Preferences** and define location of Octave, usually 'ResInsightRoot/octave/bin/octave.exe'
3. Start ResInsight.exe
#### Optional - Octave installation
Currently tested and verified version on Windows is Octave 3.6.1.
#### Octave installation (optional)
To make ResInsight work with Octave you need to do the following two steps:
- Download and install Octave 3.6.1 for VS2010 from [release section on GitHub](https://github.com/OPM/ResInsight/releases/download/1.0.0/octave-3.6.1-vs2010-setup-1.2.exe)
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)
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**
## Linux
1. Download TAR.GZ binary distribution from [https://github.com/OPM/ResInsight/releases](https://github.com/OPM/ResInsight/releases "release section on GitHub")
2. Extract content from TAR file
3. (OPTIONAL) Launch ResInsight, open **Edit -> Preferences** and define location of Octave in the field **Octave**, usually 'ResInsightRoot/octave/bin/octave-cli'
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'

23
docs/InstallationLinux.md Normal file
View File

@@ -0,0 +1,23 @@
---
layout: docs
prev_section: installation
next_section: reservoirviews
title: Installation and Configuration (Linux)
permalink: /docs/installationlinux/
published: true
---
<small>Note: None of the binary distributions includes support for ABAQUS odb files.</small>
### ResInsight installation
1. Download TAR.GZ binary distribution from [https://github.com/OPM/ResInsight/releases](https://github.com/OPM/ResInsight/releases "release section on GitHub")
2. Extract content from TAR file
3. Start ./ResInsight
#### Octave installation (optional)
The precompiled octave support is only tested for RedHat 6 (ResInsight 1.3.2-dev and earlier, was also tested on RedHat 5) and is not expected to work for other configurations, unless you build ResInsight yourself. See [Build Instructions]({{ site.baseurl }}/docs/buildinstructions)
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'.

54
docs/ModelNavigation.md
View File

@@ -9,36 +9,56 @@ published: true
ResInsight comes with two navigation modes. The active mode can be selected in the **Preferences** dialog (**Edit -> Preferences**).
ResInsight comes with four navigation modes. The active mode can be selected in the **Preferences** dialog (**Edit -> Preferences**).
|Abbreviation | Meaning |
|-------------|---------|
|LMB | Pressing left mouse button |
|MMB | Pressing Middle mouse button or scroll wheel button |
|RMB | Pressing Right mouse button |
Note that changing the navigation mode applies to the currently active view only, and views created after the change.
#### Ceetron navigation mode
The following applies to all navigation modes:
|Mouse interaction | Action |
|------------------|---------|
|LMB | Pan model |
|MMB | Zoom to mouse pointer location |
|Scroll wheel | Zoom to mouse pointer location |
|RMB | Rotate model |
| | |
|RMB single click | Context menu |
|LMB single click | Update status bar and **Result Info** |
These abbrevitations are used in the tables below:
|Abbreviation | Meaning |
|-------------|---------|
|LMB | Press the left mouse button |
|MMB | Press the middle mouse button or scroll wheel button |
|RMB | Press the right mouse button |
#### RMS navigation mode
|Mouse interaction | Action |
|------------------|---------|
|LMB + drag | Zoom model |
|MMB + drag | Rotate model |
|Scroll wheel | Zoom to mouse pointer location |
|RMB + drag | Pan model |
#### CAD navigation mode
|Mouse interaction | Action |
|------------------|--------|
|MMB | Rotate model |
|LMB + drag | Pan model |
|MMB + drag | Rotate model |
|MMB + Shift | Pan model |
|Scroll wheel | Zoom to mouse pointer location |
| | |
|RMB single click | Context menu |
|LMB single click | Update status bar and **Result Info** |
#### GeoQuest navigation mode
|Mouse interaction | Action |
|------------------|---------|
|LMB + drag | Rotate model |
|MMB + drag | Pan model |
|Scroll wheel | Zoom to mouse pointer location |
#### Ceetron navigation mode
|Mouse interaction | Action |
|------------------|---------|
|LMB + drag | Pan model |
|MMB + drag | Zoom to mouse pointer location |
|Scroll wheel | Zoom to mouse pointer location |
|RMB + drag | Rotate model |

56
docs/ReservoirViews.md
View File

@@ -1,22 +1,52 @@
---
layout: docs
prev_section: installation
prev_section: installationlinux
next_section: gridimportexport
title: Working with 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 proerties that can be editied in the **Property Editor**.
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)
Below is a description of the most important View settings and their properties.
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.
### Cell Result ![]({{ site.baseurl }}/images/CellResult.png)
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
### Cell Result &nbsp;![]({{ site.baseurl }}/images/CellResult.png)
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.)
### 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.
### Info Box
The **Info Box** controls the visibility of the animation progress, the Case description box, and the results histogram displayed in the top right corner of the view.
The **Animation Progress** shows which time step you are viewing.
![]({{ site.baseurl }}/images/AnimationProgress.png)
The **Info Text** shows general info about the case, the selected results, and some statistics.
![]({{ site.baseurl }}/images/CaseInfoText.png)
The **Histogram** shows a histogram of the complete time series of the currently loaded **Cell Result** together with:
- The mean value ( a blue line )
- P10 and P90 ( red lines )
![]({{ site.baseurl }}/images/HistogramExample.png)
## Eclipse-only features
### 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.
@@ -32,16 +62,10 @@ When selecting a result variable for cell edge, a second legend shows up in the
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.
### Info Box
The **Info Box** controls the visibility of the animation progress, the Case description box, and the results histogram.
The **Histogram** shows a histogram of the complete time series of the currently loaded **Cell Result** together with:
- The mean value ( a blue line )
- P10 and P90 ( red lines )
![]({{ site.baseurl }}/images/HistogramExample.png)
### Simulation Wells
This item controls the visualization of the Eclipse simulation wells.
Please refer to [Simulation Wells]({{ site.baseurl }}/docs/simulationwells) to read more.
### Faults
Visualization of the faults in the model is controlled by this item.
Please refer to [Faults]({{ site.baseurl }}/docs/faults) to read more.

26
docs/odbSupport.md Normal file
View File

@@ -0,0 +1,26 @@
---
layout: docs
prev_section: home
next_section: gettingstarted
title: ABAQUS Odb Support
permalink: /docs/odbsupport/
published: true
---
ResInsight can be built with support for reading and displaying geomechanical analysis models produced by ABAQUS in the '*.odb' format. This is only possible if you or your organization has a copy of the ODB-Api from Simulia, and a valid license to use it.
If you have, and would like to a use these features, please see [ Build Instructions ]({{ site.baseurl }}/docs/buildinstructions) for a description on how to build ResInsight and how to include the support for odb-files.
### Odb Support
ResInsight supports the elements C3D8R, C3D8 and C3D8P which are all HEX8 cells. It is also assumed that there are *no other element topologies* present in the odb file, and that there are only one part. For IJK-based range filters to work, it is also assumed that the elements in the part is topologically arranged as a complete box.
ResInsight loads the second frame within each odb-step, and present those as the timeseries for each result.
All the result fields in the odb-file is then available for post processing in ResInsight, but stresses and strains are converted to pressure-positive tensors as normally used in geomechanics, instead of the normal tension-positive tensors that ABAQUS stores.
Other derived results are also calculated, and are described in [ Derived Results ]({{ site.baseurl }}/docs/derivedresults)
### ResInsight features
Most of the central features of ResInsight visualization setup also applies to ABAQUS Odb models, like range filters and property filters. Well Paths will also show up along with the odb models.
The Octave interface, however, does not support the odb-data yet.

BIN
images/AnimationProgress.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 496 B

BIN
images/CaseInfoText.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.8 KiB

BIN
images/FilterIncEx.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 856 B

BIN
images/GeoMechCase24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
images/GeoMechCases24x24.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.6 KiB

BIN
images/HistogramExample.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 578 B

After

Width:  |  Height:  |  Size: 639 B

BIN
images/PropertyFilterProperties.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.9 KiB

After

Width:  |  Height:  |  Size: 10 KiB

7
index.html
View File

@@ -1,13 +1,13 @@
---
layout: default
title: ResInsight &bull; Fast and Free 3D Visualization of ECLIPSE Reservoir Simulations
title: ResInsight &bull; Fast and Free 3D Visualization of ECLIPSE and ABAQUS Reservoir Simulations
overview: true
---
<section class="intro">
<div class="grid">
<div class="unit whole center-on-mobiles">
<p class="first">Fast and Free 3D Visualization of ECLIPSE Reservoir Simulations</p>
<p class="first">Fast and Free 3D Visualization of ECLIPSE and ABAQUS<sup>[1]</sup> Reservoir Simulations</p>
</div>
<div class="post-content">
<img src="{{ site.baseurl }}/images/FrontPageImage.png" alt="Reservoir" />
@@ -47,6 +47,9 @@ overview: true
</div>
<div class="clear"></div>
<small>[1] Support for ABAQUS ODB-files is not included by default. See <a href="{{ site.baseurl }}/docs/odbsupport/">Odb-support</a> for more information.
</small>
</div>
</section>