Skip to content

Commit

Permalink
Added Octave installation description
Browse files Browse the repository at this point in the history
  • Loading branch information
magnesj committed Oct 25, 2013
1 parent ed3a8db commit 82ab7e6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
11 changes: 9 additions & 2 deletions BuildInstructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you check the button 'Grouped' in the GUI, the CMake variables are grouped by
#### 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.

#### Build using Visual Studio
#### Build instructions Visual Studio
- Open the CMake GUI
- Set the path to the source code
- Set the path to the build directory
Expand All @@ -28,9 +28,16 @@ It is possible to compile ResInsight without compiling the Octave plugins. This
- Click "Generate", and one solution file and several project files will be created in the build directory
- Open the solution file in Visual Studio

#### 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.


##### Octave installation
Currently tested and verified version on Windows is Octave 3.6.1. NB! Version 3.6.2 has compile issues using VS2010, this version will not be able to compile the Octave plugins.

- Download and install Octave 3.6.1 for VS2010 from [SourceForge](http://sourceforge.net/projects/octave/files/Octave%20Windows%20binaries/Octave%203.6.1%20for%20Windows%20Microsoft%20Visual%20Studio/octave-3.6.1-vs2010-setup-1.exe/download)
- Download a [missing library file](http://dl.dropbox.com/u/45539519/dirent-vs2010.lib), rename to **dirent.lib** and copy it into Octave lib folder, typically **c:/Octave-3.6.1/lib/dirent.lib** See details on [SourceForge](http://sourceforge.net/mailarchive/message.php?msg_id=28933804)


### Linux

Expand Down
15 changes: 10 additions & 5 deletions Documentation/UsersGuide/Installation.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
[ Contents ](UsersGuide.md#contents)

-----
#Installation and configuration#
## Installation and configuration

## Windows ##
### Windows

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'

## Linux ##
#### Optional - Octave installation
Currently tested and verified version on Windows is Octave 3.6.1. NB! Version 3.6.2 has compile issues using VS2010, this version will not be able to compile the Octave plugins.

- Download and install Octave 3.6.1 for VS2010 from [SourceForge](http://sourceforge.net/projects/octave/files/Octave%20Windows%20binaries/Octave%203.6.1%20for%20Windows%20Microsoft%20Visual%20Studio/octave-3.6.1-vs2010-setup-1.exe/download)
- Download a [missing library file](http://dl.dropbox.com/u/45539519/dirent-vs2010.lib), rename to **dirent.lib** and copy it into Octave lib folder, typically **c:/Octave-3.6.1/lib/dirent.lib** See details on [SourceForge](http://sourceforge.net/mailarchive/message.php?msg_id=28933804)


## 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'


## Script execution using Octave ##
ResInsight is able to execute custom made [Octave](http://www.gnu.org/software/octave/ "Octave") scripts. Octave scripts are available in the **Scripts** folder in the **Project Tree**. Multiple script folder locations can be defined in the field **Shared Script Folder(s)** in **Edit -> Preferences**. These scripts can be edited by a text editor defined in **Script Editor** in **Edit -> Preferences**

------
[ Contents ](UsersGuide.md#contents)
Expand Down

0 comments on commit 82ab7e6

Please sign in to comment.