Main checkin of new 1.5.0 documentation

This commit is contained in:
Jacob Støren
2015-11-09 09:44:37 +01:00
parent 765ac8be95
commit 25c6f47179
34 changed files with 177 additions and 66 deletions

View File

@@ -1,7 +1,10 @@
- title: Getting Started
- title: Introduction
docs:
- home
- odbsupport
- title: Getting Started
docs:
- gettingstarted
- installation
- installationlinux
@@ -9,20 +12,22 @@
- title: Application
docs:
- reservoirviews
- modelnavigation
- linkedviews
- gridimportexport
- simulationwells
- faults
- filters
- wellpaths
- welllogsandplots
- derivedresults
- casegroupsandstatistics
- octaveinterface
- batchcommands
- preferences
- title: Appendix
docs:
- modelnavigation
- preferences
- buildinstructions
- octaveinterfacereference
- regressiontestsystem

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: octaveinterface
next_section: modelnavigation
title: Batch Commands
permalink: /docs/batchcommands/
published: true
@@ -54,4 +52,4 @@ The command line used to run this example is shown here:
ResInsight --project BatchStatistics.rsp --replaceSourceCases CaseList2.txt --savesnapshots
{% endhighlight %}
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 **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.

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: preferences
next_section: octaveinterfacereference
title: Build Instructions
permalink: /docs/buildinstructions/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: derivedresults
next_section: octaveinterface
title: Grid Case Groups and Statistics
permalink: /docs/casegroupsandstatistics/
published: true
@@ -76,4 +74,4 @@ A histogram is created and the percentile is calculated based on the histogram.
When the computation is complete, you have to create a 3D View on the **Statistics Case** to view the results. Use the Context menu available by right clicking the **Statistics Case** to create it.
### Adding Statistics Cases
A new statistical calculation can be created by activating the context menu for **Derived Statistic->New Statistics Case**.
A new statistical calculation can be created by activating the context menu for **Derived Statistic->New Statistics Case**.

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: regressiontestsystem
next_section: contact
title: Command Line Parameters
permalink: /docs/commandlineparameters/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: wellpaths
next_section: casegroupsandstatistics
title: Derived Results
permalink: /docs/derivedresults/
published: true
@@ -45,13 +43,17 @@ The directional combined parameters available are:
## Derived Geomechanical results
ResInsight calculates several of the geomechanical results presented. Here we will present a brief overview.
ResInsight calculates several of the presented geomechanical results based on the native results present in the odb-files.
The calculated result fields including their components are:
The calculated result fields are:
SE, E, ST and Gamma
SE (Effective Stress) , E (Strain), ST (Total Stress) and Gamma (Stress path)
In this text the label Sa and Ea will be used to denote the unchanged stress and strain tensor respectivly from the odb file.
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.
### SE - Effective Stress

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: simulationwells
next_section: filters
title: Faults
permalink: /docs/faults/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: faults
next_section: wellpaths
title: Cell Filters
permalink: /docs/filters/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: odbsupport
next_section: installation
title: Getting Started
permalink: /docs/gettingstarted/
published: true
@@ -25,7 +23,7 @@ windows can be managed from the **Windows** menu or directly using the local men
<div class="note">
<h5>Add additional docking windows</h5>
A new project tree and property editor can be added from **Windows->New Project and Property View**.
A new project tree and property editor can be added from <b>Windows->New Project and Property View</b>.
</div>
@@ -37,9 +35,15 @@ A selected subset of actions are presented as controls in the toolbar. The diffe
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.
Management of several views is 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>Docking window management</h5>
To see views next to each other select the <b>Restore down</b> icon in the application (shown below for Windows).
<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)

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: reservoirviews
next_section: simulationwells
title: Grid Import and Property Export
permalink: /docs/gridimportexport/
published: true

View File

@@ -1,7 +1,6 @@
---
layout: docs
title: ResInsight 1.4 Users Guide
next_section: odbsupport
title: ResInsight 1.5
permalink: /docs/home/
published: true
---
@@ -20,9 +19,9 @@ Integration with GNU Octave enables powerful and flexible result manipulation an
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.
information and corresponding cell property data sets. 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.
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.

View File

@@ -1,8 +1,6 @@
---
layout: docs
prev_section: gettingstarted
next_section: installationlinux
title: Installation and Configuration (Windows)
title: Windows Installation
permalink: /docs/installation/
published: true
---

View File

@@ -1,8 +1,6 @@
---
layout: docs
prev_section: installation
next_section: reservoirviews
title: Installation and Configuration (Linux)
title: Linux Installation
permalink: /docs/installationlinux/
published: true
---

50
docs/LinkedViews.md Normal file
View File

@@ -0,0 +1,50 @@
---
layout: docs
title: Linked Views
permalink: /docs/linkedviews/
published: true
---
One or more views can be linked together to allow some settings like camera position and range filters, propagate from one view to another.
## Establish Linked Views
To establish a link between views, select ![]({{ site.baseurl }}/images/chain.png) **Link Visible Views** from the View toolbar. This will open a dialog where the Master View is selected. When pressing Ok in this dialog, the **Linked Views** items are displayed in the top of the **Project Tree**.
![]({{ site.baseurl }}/images/LinkedViewsInProjectTree.png)
## Linked view Options
When selecting a linked view in the project tree, the different options are available in the **Property Editor**.
![]({{ site.baseurl }}/images/LinkedViewsProperties.png)
#### Link Options
- **Camera** Navigation in any of the views where this option is active will be applied to the other linked views with this option set.
- **Time Step** Change of time step in any of the views where this option is active will be applied to the other linked views with this option set.
- **Cell Color Result** Change of cell result in the master view will be applied to all dependent views where this option is active. **Cell Color Result** is only supported between views of the *same type*.
#### Link Cell Filters
- **Range Filters** Range filters in master view will be applied to all dependent views where this option is active. Normally this is done by a direct copy, but if the master and dependent view is of different types (Eclipse and Geomechanical views) and the Eclipse case is within the bounds of the Geomechanical case, ResInsight tries to map the range filters to the corresponding cells in the other case.
- **Property Filters** Property filters in master view will be applied to all dependent views where this option is active. This option is only enabled between views of the *same case*.
## 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**.
## Project Tree Context menu
Right-clicking one of the linked view entries in the **Project Tree** displays the following menu entries:
- **Open All Linked Views** Open all the views which is part of the linked view group
- **Delete All Linked Views** Delete the linked views group, and thereby unlink all the views.
- **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.
- **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

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: batchcommands
next_section: preferences
title: Model Navigation
permalink: /docs/modelnavigation/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: casegroupsandstatistics
next_section: batchcommands
title: Octave Interface
permalink: /docs/octaveinterface/
published: true
@@ -38,4 +36,4 @@ A script can be started by navigating to the script in the **Project Tree**, and
### With a case selection
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)
![]({{ site.baseurl }}/images/ExecuteOctaveScriptOnSelectedCases.png)

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: buildinstructions
next_section: regressiontestsystem
title: Octave Interface Reference
permalink: /docs/octaveinterfacereference/
published: true
@@ -220,4 +218,4 @@ This function returns the status information for a specified well for each reque
# or open respectively
}
If the CaseId is not defined, ResInsight's Current Case is used.
If the CaseId is not defined, ResInsight's Current Case is used.

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: modelnavigation
next_section: buildinstructions
title: Preferences
permalink: /docs/preferences/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: octaveinterfacereference
next_section: commandlineparameters
title: Regression Test System
permalink: /docs/regressiontestsystem/
published: true
@@ -45,4 +43,4 @@ To create regression tests you need to do the following:
3. Run the regression test for the first time, and thereby creating images that can be used as Base images.
4. Rename the generated RegTestGeneratedImages/ folder to RegTestBaseImages/
Now you are all set to test new releases of ResInsight towards your own Regression tests.
Now you are all set to test new releases of ResInsight towards your own Regression tests.

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: installationlinux
next_section: gridimportexport
title: Working with 3D Views
permalink: /docs/reservoirviews/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: gridimportexport
next_section: faults
title: Simulation Wells
permalink: /docs/simulationwells/
published: true

89
docs/WellLogsAndPlots.md Normal file
View File

@@ -0,0 +1,89 @@
---
layout: docs
title: Well Log Plots
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.
## 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.
## Plots, Tracks and Curves
### Creating Well Log Plots
Well log plots can be created in several ways:
1. Right click the empty area below all the items in the **Project Tree** and select **New Well Log Plot**. A plot is created with one **Track** and an empty **Curve**.
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 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 can be created by right clicking a **Well Log Plot** and select **New Track**
A track controls the x-axis range of the display, and can be edited from the property panel of the **Track**.
![]({{ site.baseurl }}/images/TrackProperties.png)
### 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*.
#### 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.
They are calculated by intersecting a well trajectory with the cells in a particular grid model. At each intersection point the measured depth along the trajectory is deduced and the corresponding result value is read.
The property panel for a geomechanical model is shown below:
![]({{ site.baseurl }}/images/WellLogExtractionCurveProperties.png)
The first group of options controls all the input needed to setup the data extraction for the curve - Well Path, Case, and result value. The selection of result value is somewhat different between geomechanical cases and Eclipse cases. In addition you can select what timestep to address if the selected property is a dynamic one.
<div class="note">
Placing keyboard focus in the <b>Time Step</b> drop-downbox will allow you to use the arrow keys to quickly step through the timesteps while watching the changes in the curve.
</div>
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.
#### 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.

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: filters
next_section: derivedresults
title: Well Trajectories
permalink: /docs/wellpaths/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: contact
#next_section: home
title: About
permalink: /docs/about/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: commandlineparameters
next_section: about
title: Contact
permalink: /docs/contact/
published: true

View File

@@ -1,7 +1,5 @@
---
layout: docs
prev_section: home
next_section: gettingstarted
title: ABAQUS Odb Support
permalink: /docs/odbsupport/
published: true
@@ -16,7 +14,9 @@ ResInsight supports the elements C3D8R, C3D8 and C3D8P which are all HEX8 cells.
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.
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.
Pressure and stress are always displayed using the *Bar* unit.
Other derived results are also calculated, and are described in [ Derived Results ]({{ site.baseurl }}/docs/derivedresults)

BIN
images/LasFilesInTree.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

BIN
images/TrackProperties.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
images/chain.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 734 B