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

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)