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

Updated OctaveInterface.md

Browse Source
This commit is contained in:
Magne Sjaastad
2014-07-03 01:27:36 +02:00
parent 1ee0e52caf
commit 3a67c2efca
1 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/OctaveInterface.md
View File

@@ -4,43 +4,38 @@ prev_section: casegroupsandstatistics
next_section: wellpaths
title: Octave Interface
permalink: /docs/octaveinterface/
published: true
---
## Octave Interface
ResInsight provides a flexible interface to [Octave](http://www.gnu.org/software/octave/ "Octave").
This includes a set of Octave functions that communicates with a running ResInsight session, features in ResInsight that makes it easy to manage and edit Octave scripts, and their execution using Octave.
The Octave functions are documented in [ Octave Interface Reference](OctaveInterfaceReference.md).
The Octave functions are documented in [Octave Interface Reference]({{ site.baseurl }}/docs/octaveinterface).
### Script management
## Script management
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.
#### Adding Script Folders
### Adding Script Folders
You can add directories by right clicking the **Scripts** item to access the context menu.
Multiple standard script folder locations can also be defined in the field **Shared Script Folder(s)** in the **Preferences Dialog** (**Edit -> Preferences**).
#### Editing scripts
### Editing scripts
To enable script editing from ResInsight you need to set up the path to a text editor in the **Script Editor** field in the **Preferences Dialog** (**Edit -> Preferences**)
When done, scripts can be edited using the context menu command **Edit** on the script item in the tree.
### Script execution
Octave scripts can be executed with or without a selection of cases as context. The [ Octave Interface Reference](OctaveInterfaceReference.md) highlights in more depth how to design your Octave scripts to utilize these features.
## Script execution
Octave scripts can be executed with or without a selection of cases as context. The [Octave Interface Reference]({{ site.baseurl }}/docs/octaveinterface) highlights in more depth how to design your Octave scripts to utilize these features.
#### Without a case selection
### Without a case selection
A script can be started by navigating to the script in the **Project Tree**, and selecting **Execute** from the context menu. The currently active case (The one with the active 3D View) will then be set as ResInsight's *Current Case*.
#### With a case selection
### 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)