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

Added build instructions document

Browse Source
This commit is contained in:
Magne Sjaastad 2013-10-25 10:04:55 +02:00
parent 026dbc3c0f
commit ed3a8db67d
2 changed files with 58 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
BuildInstructions.md Normal file
View File

@ -0,0 +1,54 @@
## Build instructions
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
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.
| CMake Name | Description |
|--------------|---------|
| `RESINSIGHT_USE_OPENMP` | Enable OpenMP multi-core parallel building |
| `RESINSIGHT_PRIVATE_INSTALL` | Install as an independent bundle including the necessary Qt libraries |
| `RESINSIGHT_BUILD_DOCUMENTATION` | Use Doxygen to create the HTML based API documentation |
| `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_OCTAVE_PLUGIN_32_BIT` | Windows 64-bit: Flag used to control if Octave plugins will be compiled using 32-bit build environment |
#### 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
- 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
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.
### Linux
An out-of-tree build is typically done with
mkdir ResInsight/build
cd ResInsight/build
cmake ..
make
make install
You will find the ResInsight binary under the Install directory in your build directory.
#### Dependencies for Debian based distributions
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 :
sudo apt-get install git cmake build-essential octave liboctave-dev qt4-dev-tools

33
README.md
View File

@ -17,9 +17,9 @@ Octave : [http://www.gnu.org/software/octave/](http://www.gnu.org/software/octav
Ensembles/ert : [https://github.com/Ensembles/ert](https://github.com/Ensembles/ert)
### Supported Platforms
ResInsight is designed cross-platform from the start. Efforts have been made to ensure that code will compile and run on linux and windows platforms, but the tested platforms are currently 64 bit RHE 5, RHE 6 and Windows 7.
ResInsight is designed cross-platform from the start. Efforts have been made to ensure that code will compile and run on Linux and Windows platforms, but the tested platforms are currently 64 bit RHEL5, RHEL6 and Windows 7.
There has been attemts to make ResInsight build and run on OSX as well, but the tweaks needed (submitted by Roland Kaufmann) is not yet incorporated.
There has been attempts to make ResInsight build and run on OSX as well, but the tweaks needed (submitted by Roland Kaufmann) is not yet incorporated.
### Documentation
@ -39,31 +39,6 @@ The master branch is supposed to be stable, and is updated when we want to publi
Release branches that might pop up are dedicated bug fix branches for the release in question.
### Building Resinsight
#### Linux ###
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 dependecy list. An out-of-tree build is typically done with
mkdir ResInsight/build
cd ResInsight/build
cmake ..
make
make install
You will find the ResInsight binary under the Install directory in your build directory.
#### Windows ###
Open the CMake GUI.
Set the path to the source code: <ResInsight-sourcecode-folder>
Set the path to the build directory: <ResInsight-build-folder>
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 a project file will be created in the build directory <ResInsight-build-folder>
### Dependencies for Debian based distributions
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 :
sudo apt-get install git cmake build-essential octave liboctave-dev qt4-dev-tools
### Building ResInsight
See [ Build Instructions ] (BuildInstructions.md)