Files
ResInsight/getting-started/download-and-install/buildinstructions/index.html
2020-05-04 07:11:37 +02:00

3666 lines
63 KiB
HTML

<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.65.3" />
<meta name="description" content="">
<link rel="icon" href="/images/favicon.png" type="image/png">
<title>Build Instructions :: ResInsight</title>
<link href="/css/nucleus.css?1588568942" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1588568942" rel="stylesheet">
<link href="/css/hybrid.css?1588568942" rel="stylesheet">
<link href="/css/featherlight.min.css?1588568942" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1588568942" rel="stylesheet">
<link href="/css/auto-complete.css?1588568942" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1588568942" rel="stylesheet">
<link href="/css/theme.css?1588568942" rel="stylesheet">
<link href="/css/hugo-theme.css?1588568942" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1588568942"></script>
<style>
:root #header + #content > #left > #rlblock_left{
display:none !important;
}
</style>
<script type="text/javascript" async
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']],
displayMath: [['$$','$$'], ['\\[','\\]']],
processEscapes: true,
processEnvironments: true,
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
TeX: { equationNumbers: { autoNumber: "AMS" },
extensions: ["AMSmath.js", "AMSsymbols.js"] }
}
});
MathJax.Hub.Queue(function() {
var all = MathJax.Hub.getAllJax();
while(jax = all.pop()) {
jax.SourceElement().parentNode.className += ' has-jax';
}
});
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
</head>
<body class="" data-url="/getting-started/download-and-install/buildinstructions/">
<nav id="sidebar" class="">
<div id="header-wrapper">
<div id="header">
<a id="logo" href="https://resinsight.org/">
<img src="https://resinsight.org//images/ResInsightCroppedIconPicture.png">
</a>
</div>
<div class="searchbox">
<label for="searchbox"><i class="fas fa-search"></i></label>
<form action="/search/" method="GET" id="search-form">
<input type="search" name="q" id="searchbox" placeholder="Search">
</form>
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
</div>
<div class="highlightable">
<ul class="topics">
<li data-nav-id="/getting-started/" title="Getting Started" class="dd-item
parent
">
<a href="/getting-started/">
Getting Started
</a>
<ul>
<li data-nav-id="/getting-started/overview/" title="Overview" class="dd-item ">
<a href="/getting-started/overview/">
Overview
</a>
</li>
<li data-nav-id="/getting-started/download-and-install/" title="Download and Install" class="dd-item
parent
">
<a href="/getting-started/download-and-install/">
Download and Install
</a>
<ul>
<li data-nav-id="/getting-started/download-and-install/linux-installation/" title="Linux Installation" class="dd-item ">
<a href="/getting-started/download-and-install/linux-installation/">
Linux Installation
</a>
</li>
<li data-nav-id="/getting-started/download-and-install/windows-installation/" title="Windows Installation" class="dd-item ">
<a href="/getting-started/download-and-install/windows-installation/">
Windows Installation
</a>
</li>
<li data-nav-id="/getting-started/download-and-install/buildinstructions/" title="Build Instructions" class="dd-item active">
<a href="/getting-started/download-and-install/buildinstructions/">
Build Instructions
</a>
</li>
</ul>
</li>
<li data-nav-id="/getting-started/helpmenuanddocumentation/" title="Help Menu and Documentation" class="dd-item ">
<a href="/getting-started/helpmenuanddocumentation/">
Help Menu and Documentation
</a>
</li>
<li data-nav-id="/getting-started/modelnavigation/" title="Model Navigation" class="dd-item ">
<a href="/getting-started/modelnavigation/">
Model Navigation
</a>
</li>
<li data-nav-id="/getting-started/other/" title="Other" class="dd-item
">
<a href="/getting-started/other/">
Other
</a>
<ul>
<li data-nav-id="/getting-started/other/releasenotification/" title="Release Notification Subscription" class="dd-item ">
<a href="/getting-started/other/releasenotification/">
Release Notification Subscription
</a>
</li>
<li data-nav-id="/getting-started/other/testimonials/" title="Testimonials" class="dd-item ">
<a href="/getting-started/other/testimonials/">
Testimonials
</a>
</li>
</ul>
</li>
</ul>
</li>
<li data-nav-id="/3d-main-window/" title="3D Main Window" class="dd-item
">
<a href="/3d-main-window/">
3D Main Window
</a>
<ul>
<li data-nav-id="/3d-main-window/3dviews/" title="3D Views" class="dd-item ">
<a href="/3d-main-window/3dviews/">
3D Views
</a>
</li>
<li data-nav-id="/3d-main-window/cellresults/" title="Cell Results" class="dd-item ">
<a href="/3d-main-window/cellresults/">
Cell Results
</a>
</li>
<li data-nav-id="/3d-main-window/resultcolorlegend/" title="Result Color Legend" class="dd-item ">
<a href="/3d-main-window/resultcolorlegend/">
Result Color Legend
</a>
</li>
<li data-nav-id="/3d-main-window/comparisonview/" title="Comparison View" class="dd-item ">
<a href="/3d-main-window/comparisonview/">
Comparison View
</a>
</li>
<li data-nav-id="/3d-main-window/contourmaps/" title="Contour Maps" class="dd-item ">
<a href="/3d-main-window/contourmaps/">
Contour Maps
</a>
</li>
<li data-nav-id="/3d-main-window/tensors/" title="Tensor Results" class="dd-item ">
<a href="/3d-main-window/tensors/">
Tensor Results
</a>
</li>
<li data-nav-id="/3d-main-window/resultinspection/" title="Result Inspection" class="dd-item ">
<a href="/3d-main-window/resultinspection/">
Result Inspection
</a>
</li>
<li data-nav-id="/3d-main-window/filters/" title="Cell Filters" class="dd-item ">
<a href="/3d-main-window/filters/">
Cell Filters
</a>
</li>
<li data-nav-id="/3d-main-window/intersections/" title="Intersections" class="dd-item ">
<a href="/3d-main-window/intersections/">
Intersections
</a>
</li>
<li data-nav-id="/3d-main-window/surfaces/" title="Surfaces" class="dd-item ">
<a href="/3d-main-window/surfaces/">
Surfaces
</a>
</li>
<li data-nav-id="/3d-main-window/allandiagrams/" title="Allan Diagram" class="dd-item ">
<a href="/3d-main-window/allandiagrams/">
Allan Diagram
</a>
</li>
<li data-nav-id="/3d-main-window/faults/" title="Faults" class="dd-item ">
<a href="/3d-main-window/faults/">
Faults
</a>
</li>
<li data-nav-id="/3d-main-window/formations/" title=" Zonations/Formations" class="dd-item ">
<a href="/3d-main-window/formations/">
Zonations/Formations
</a>
</li>
<li data-nav-id="/3d-main-window/gridstatisticsdialog/" title="Grid Statistics Dialog" class="dd-item ">
<a href="/3d-main-window/gridstatisticsdialog/">
Grid Statistics Dialog
</a>
</li>
<li data-nav-id="/3d-main-window/casegroupsandstatistics/" title="Grid Case Groups and Statistics" class="dd-item ">
<a href="/3d-main-window/casegroupsandstatistics/">
Grid Case Groups and Statistics
</a>
</li>
<li data-nav-id="/3d-main-window/linkedviews/" title="Linked Views" class="dd-item ">
<a href="/3d-main-window/linkedviews/">
Linked Views
</a>
</li>
<li data-nav-id="/3d-main-window/measurement/" title="Measurement" class="dd-item ">
<a href="/3d-main-window/measurement/">
Measurement
</a>
</li>
<li data-nav-id="/3d-main-window/annotations/" title="Annotations" class="dd-item ">
<a href="/3d-main-window/annotations/">
Annotations
</a>
</li>
<li data-nav-id="/3d-main-window/derivedresults/" title="Derived Results" class="dd-item ">
<a href="/3d-main-window/derivedresults/">
Derived Results
</a>
</li>
</ul>
</li>
<li data-nav-id="/plot-window/" title="Plot Main Window" class="dd-item
">
<a href="/plot-window/">
Plot Main Window
</a>
<ul>
<li data-nav-id="/plot-window/summaryplots/" title="Summary Plots" class="dd-item ">
<a href="/plot-window/summaryplots/">
Summary Plots
</a>
</li>
<li data-nav-id="/plot-window/summarysourcestepping/" title="Summary Plot Source Stepping" class="dd-item ">
<a href="/plot-window/summarysourcestepping/">
Summary Plot Source Stepping
</a>
</li>
<li data-nav-id="/plot-window/summaryploteditor/" title="Summary Plot Editor" class="dd-item ">
<a href="/plot-window/summaryploteditor/">
Summary Plot Editor
</a>
</li>
<li data-nav-id="/plot-window/summarycrossplots/" title="Summary Cross Plot" class="dd-item ">
<a href="/plot-window/summarycrossplots/">
Summary Cross Plot
</a>
</li>
<li data-nav-id="/plot-window/summaryplottemplate/" title="Summary Plot Template" class="dd-item ">
<a href="/plot-window/summaryplottemplate/">
Summary Plot Template
</a>
</li>
<li data-nav-id="/plot-window/multiplots/" title="Multi Plots" class="dd-item ">
<a href="/plot-window/multiplots/">
Multi Plots
</a>
</li>
<li data-nav-id="/plot-window/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
</a>
</li>
<li data-nav-id="/plot-window/curvecalculator/" title="Curve Calculator" class="dd-item ">
<a href="/plot-window/curvecalculator/">
Curve Calculator
</a>
</li>
<li data-nav-id="/plot-window/welllogsandplots/" title="Well Log Plots" class="dd-item ">
<a href="/plot-window/welllogsandplots/">
Well Log Plots
</a>
</li>
<li data-nav-id="/plot-window/wellborestabilityplots/" title="Well Bore Stability Plots" class="dd-item ">
<a href="/plot-window/wellborestabilityplots/">
Well Bore Stability Plots
</a>
</li>
<li data-nav-id="/plot-window/rftplot/" title="RFT Plot" class="dd-item ">
<a href="/plot-window/rftplot/">
RFT Plot
</a>
</li>
<li data-nav-id="/plot-window/ensemblerftplot/" title="Ensemble RFT Plot" class="dd-item ">
<a href="/plot-window/ensemblerftplot/">
Ensemble RFT Plot
</a>
</li>
<li data-nav-id="/plot-window/pltplot/" title="PLT Plot" class="dd-item ">
<a href="/plot-window/pltplot/">
PLT Plot
</a>
</li>
<li data-nav-id="/plot-window/flowdiagnosticsplots/" title="Flow Diagnostics Plots" class="dd-item ">
<a href="/plot-window/flowdiagnosticsplots/">
Flow Diagnostics Plots
</a>
</li>
<li data-nav-id="/plot-window/gridcrossplots/" title="Grid Cross Plots" class="dd-item ">
<a href="/plot-window/gridcrossplots/">
Grid Cross Plots
</a>
</li>
<li data-nav-id="/plot-window/saturationpressureplots/" title="Saturation Pressure Plots" class="dd-item ">
<a href="/plot-window/saturationpressureplots/">
Saturation Pressure Plots
</a>
</li>
</ul>
</li>
<li data-nav-id="/wells-and-completions/" title="Wells and Completions" class="dd-item
">
<a href="/wells-and-completions/">
Wells and Completions
</a>
<ul>
<li data-nav-id="/wells-and-completions/simulationwells/" title="Simulation Wells" class="dd-item ">
<a href="/wells-and-completions/simulationwells/">
Simulation Wells
</a>
</li>
<li data-nav-id="/wells-and-completions/wellpaths/" title="Well Paths" class="dd-item ">
<a href="/wells-and-completions/wellpaths/">
Well Paths
</a>
</li>
<li data-nav-id="/wells-and-completions/createnewwellpaths/" title="Create Well Paths" class="dd-item ">
<a href="/wells-and-completions/createnewwellpaths/">
Create Well Paths
</a>
</li>
<li data-nav-id="/wells-and-completions/3dwelllogcurves/" title="3D Well Log Plots" class="dd-item ">
<a href="/wells-and-completions/3dwelllogcurves/">
3D Well Log Plots
</a>
</li>
<li data-nav-id="/wells-and-completions/completions/" title="Completions" class="dd-item ">
<a href="/wells-and-completions/completions/">
Completions
</a>
</li>
<li data-nav-id="/wells-and-completions/completionslgr/" title="Completions LGR" class="dd-item ">
<a href="/wells-and-completions/completionslgr/">
Completions LGR
</a>
</li>
<li data-nav-id="/wells-and-completions/wellmeasurements/" title="Well Measurements" class="dd-item ">
<a href="/wells-and-completions/wellmeasurements/">
Well Measurements
</a>
</li>
</ul>
</li>
<li data-nav-id="/import/" title="Import" class="dd-item
">
<a href="/import/">
Import
</a>
<ul>
<li data-nav-id="/import/eclipsecases/" title="Eclipse Cases" class="dd-item ">
<a href="/import/eclipsecases/">
Eclipse Cases
</a>
</li>
<li data-nav-id="/import/lasfile/" title="Log ASCII Standard File" class="dd-item ">
<a href="/import/lasfile/">
Log ASCII Standard File
</a>
</li>
<li data-nav-id="/import/geomechanicaldata/" title="Geomechanical Data" class="dd-item ">
<a href="/import/geomechanicaldata/">
Geomechanical Data
</a>
</li>
<li data-nav-id="/import/soursimrlresults/" title="SourSimRL Results" class="dd-item ">
<a href="/import/soursimrlresults/">
SourSimRL Results
</a>
</li>
<li data-nav-id="/import/elementpropertytable/" title="Element Property Table" class="dd-item ">
<a href="/import/elementpropertytable/">
Element Property Table
</a>
</li>
<li data-nav-id="/import/observeddata/" title="Observed Time History Data" class="dd-item ">
<a href="/import/observeddata/">
Observed Time History Data
</a>
</li>
<li data-nav-id="/import/pasteexceltimedata/" title="Paste Excel Time History Data" class="dd-item ">
<a href="/import/pasteexceltimedata/">
Paste Excel Time History Data
</a>
</li>
</ul>
</li>
<li data-nav-id="/export/" title="Export" class="dd-item
">
<a href="/export/">
Export
</a>
<ul>
<li data-nav-id="/export/snapshots/" title="Snapshots" class="dd-item ">
<a href="/export/snapshots/">
Snapshots
</a>
</li>
<li data-nav-id="/export/eclipseproperties/" title="Eclipse Properties" class="dd-item ">
<a href="/export/eclipseproperties/">
Eclipse Properties
</a>
</li>
<li data-nav-id="/export/fluxnummultnum/" title="FLUXNUM/MULTNUM" class="dd-item ">
<a href="/export/fluxnummultnum/">
FLUXNUM/MULTNUM
</a>
</li>
<li data-nav-id="/export/completionexport/" title="Completions" class="dd-item ">
<a href="/export/completionexport/">
Completions
</a>
</li>
<li data-nav-id="/export/exportwellpaths/" title="Well Paths" class="dd-item ">
<a href="/export/exportwellpaths/">
Well Paths
</a>
</li>
<li data-nav-id="/export/sectormodel/" title="Sector Model" class="dd-item ">
<a href="/export/sectormodel/">
Sector Model
</a>
</li>
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
</li>
<li data-nav-id="/scripting/" title="Scripting" class="dd-item
">
<a href="/scripting/">
Scripting
</a>
<ul>
<li data-nav-id="/scripting/pythoninterface/" title="Python interface" class="dd-item ">
<a href="/scripting/pythoninterface/">
Python interface
</a>
</li>
<li data-nav-id="/scripting/commandlineinterface/" title="Command Line Interface" class="dd-item ">
<a href="/scripting/commandlineinterface/">
Command Line Interface
</a>
</li>
<li data-nav-id="/scripting/commandfile/" title="Command File" class="dd-item ">
<a href="/scripting/commandfile/">
Command File
</a>
</li>
<li data-nav-id="/scripting/octaveinterface/" title="Octave Interface" class="dd-item ">
<a href="/scripting/octaveinterface/">
Octave Interface
</a>
</li>
<li data-nav-id="/scripting/octaveinterfacereference/" title="Octave Interface Reference" class="dd-item ">
<a href="/scripting/octaveinterfacereference/">
Octave Interface Reference
</a>
</li>
</ul>
</li>
<li data-nav-id="/misc/" title="Miscellaneous" class="dd-item
">
<a href="/misc/">
Miscellaneous
</a>
<ul>
<li data-nav-id="/misc/preferences/" title="Preferences" class="dd-item ">
<a href="/misc/preferences/">
Preferences
</a>
</li>
<li data-nav-id="/misc/projectfile/" title="Project File and Caching" class="dd-item ">
<a href="/misc/projectfile/">
Project File and Caching
</a>
</li>
<li data-nav-id="/misc/memorymanagement/" title="Memory Management" class="dd-item ">
<a href="/misc/memorymanagement/">
Memory Management
</a>
</li>
<li data-nav-id="/misc/keyboardshortcuts/" title="Keyboard Shortcuts" class="dd-item ">
<a href="/misc/keyboardshortcuts/">
Keyboard Shortcuts
</a>
</li>
<li data-nav-id="/misc/regressiontestsystem/" title="Regression Test System" class="dd-item ">
<a href="/misc/regressiontestsystem/">
Regression Test System
</a>
</li>
</ul>
</li>
</ul>
<section id="shortcuts">
<h3></h3>
<ul>
<li>
<a class="padding" href="https://resinsight.org/about"><i class='fas fa-info-circle'></i> About</a>
</li>
<li>
<a class="padding" href="https://resinsight.org/support"><i class='far fa-question-circle'></i> Support</a>
</li>
<li>
<a class="padding" href="https://resinsight.org/getting-started/download-and-install"><i class='fas fa-download'></i> Download and Install</a>
</li>
</ul>
</section>
<section id="footer">
<a href="https://www.ceetronsolutions.com"><img src='https://resinsight.org//images/CeeSolLogoSmallForDarkBackground.png' style='width: 140px; '></a><br>
ResInsight is developed by <br> <a href="https://www.ceetronsolutions.com">Ceetron Solutions</a>
<p>in collaboration with</p>
<a href="https://www.equinor.com">Equinor ASA</a>
<script type="application/javascript">
var doNotTrack = false;
if (!doNotTrack) {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-79509181-1', 'auto');
ga('send', 'pageview');
}
</script>
</section>
</div>
</nav>
<section id="body">
<div id="overlay"></div>
<div class="padding highlightable">
<div>
<div id="top-bar">
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
<i class="fas fa-bars"></i>
</a>
</span>
<span id="toc-menu"><i class="fas fa-list-alt"></i></span>
<span class="links">
<a href='/'>ResInsight</a> > <a href='/getting-started/'>Getting Started</a> > <a href='/getting-started/download-and-install/'>Download and Install</a> > Build Instructions
</span>
</div>
<div class="progress">
<div class="wrapper">
<nav id="TableOfContents">
<ul>
<li>
<ul>
<li><a href="#source-code">Source code</a></li>
<li><a href="#dependencies-and-prerequisites">Dependencies and Prerequisites</a>
<ul>
<li><a href="#windows-compiler">Windows Compiler</a></li>
<li><a href="#gcc-compiler">GCC Compiler</a></li>
<li><a href="#qt5">Qt5</a></li>
<li><a href="#cmake">CMake</a></li>
</ul>
</li>
<li><a href="#build-instructions">Build Instructions</a>
<ul>
<li><a href="#windows">Windows</a></li>
<li><a href="#linux">Linux</a></li>
<li><a href="#cmake-options-for-resinsight">CMake Options for ResInsight</a></li>
<li><a href="#optional-libraries-and-features">Optional Libraries and features</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="head-tags">
</div>
<div id="body-inner">
<h1>
Build Instructions
</h1>
<h2 id="source-code">Source code</h2>
<p>The source code is hosted at <a href="https://github.com/opm/resinsight">GitHub</a></p>
<p>In a git enabled shell do: <code>git clone https://github.com/OPM/ResInsight.git</code></p>
<h2 id="dependencies-and-prerequisites">Dependencies and Prerequisites</h2>
<h3 id="windows-compiler">Windows Compiler</h3>
<p>Visual Studio 2015 and later is supported.</p>
<h3 id="gcc-compiler">GCC Compiler</h3>
<p>GCC version 4.9 or later is supported. On RedHat Linux 6 you need to install devtoolset-3, and enable it with</p>
<pre><code>source /opt/rh/devtoolset-3/enable
</code></pre>
<h3 id="qt5">Qt5</h3>
<p><a href="http://download.qt.io/archive/qt/">Qt</a> Qt5 version 5.6.0 or later is supported.</p>
<p>On some configurations you will be asked to specify the location of Qt5. Example for Windows :
<code>Qt5_DIR=d:\Qt\5.11.3\msvc2017_64\lib\cmake\Qt5</code></p>
<h4 id="qt4-deprecated">Qt4 (Deprecated)</h4>
<div class="notices info" ><p>Qt4 is marked as deprecated and support for using Qt4 will soon be removed.</p>
</div>
<p><a href="http://download.qt.io/archive/qt/">Qt</a> Qt4 version 4.6.2 or later is supported. On Windows we recommend Qt-4.8.7, while the default installation will do under Linux.</p>
<p><code>RESINSIGHT_BUILD_WITH_QT5=FALSE</code></p>
<p>You will need to patch the Qt sources in order to make them build using Visual Studio 2015 using this :
<a href="https://github.com/appleseedhq/appleseed/wiki/Making-Qt-4.8.7-compile-with-Visual-Studio-2015">Qt-patch</a></p>
<h3 id="cmake">CMake</h3>
<p><a href="https://cmake.org/download/">CMake</a> version 2.8 or later is supported.</p>
<h2 id="build-instructions">Build Instructions</h2>
<p>The ResInsight build may be configured in different ways, with optional support for Octave plugins,
ABAQUS ODB API, HDF5, Pyton, and OpenMP. This is configured using options in CMake.</p>
<p>If you check the button &lsquo;Grouped&rsquo; in the CMake GUI, the CMake variables are grouped by prefix.
This makes it easier to see all of the options for ResInsight.</p>
<ul>
<li>Open the CMake GUI</li>
<li>Set the path to the source code</li>
<li>Set the path to the build directory</li>
<li>Click <strong>Configure</strong> and select your preferred compiler</li>
<li>Set the build options and click &ldquo;Configure&rdquo; again (see ResInsight specific options below)</li>
<li>Click <strong>Generate</strong> to generate the makefiles or solution file and project files in the build directory</li>
<li>Run the compiler using the generated makefiles or solution file/project files to build ResInsight</li>
</ul>
<h3 id="windows">Windows</h3>
<p>ResInsight has been verified to build and run on Windows 7/8/10 using Microsoft Visual Studio 2015/2017.
Typical usage on Windows is to follow the build instructions above, and then open the generated
solution file in Visual Studio to build the application.</p>
<h3 id="linux">Linux</h3>
<p>Typical usage is to follow the build instructions above to build the makefiles. Then go to the build directory, and run:</p>
<ul>
<li>make</li>
<li>make install</li>
</ul>
<p>To build from the command line without using the CMake GUI:</p>
<ul>
<li>mkdir ResInsight_build</li>
<li>cd ResInsight_build</li>
<li>&hellip;</li>
<li>(set CMake options)</li>
<li>&hellip;</li>
<li>cmake &lt; path to ResInsight source folder &gt;</li>
<li>make</li>
<li>make install</li>
</ul>
<p>You will find the ResInsight binary under the Install directory in your build directory.</p>
<h3 id="cmake-options-for-resinsight">CMake Options for ResInsight</h3>
<table>
<thead>
<tr>
<th>CMake Name</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>RESINSIGHT_BUILD_DOCUMENTATION</code></td>
<td>OFF</td>
<td>Use Doxygen to create the HTML based API documentation. Doxygen must be properly installed.</td>
</tr>
<tr>
<td><code>RESINSIGHT_ENABLE_GRPC</code></td>
<td>OFF</td>
<td>Enable gRPC scripting server. Required to be able to use ResInsight from Python</td>
</tr>
<tr>
<td><code>RESINSIGHT_HDF5_DIR</code></td>
<td>Blank</td>
<td>Windows Only: Optional path to HDF5 libraries on Windows</td>
</tr>
<tr>
<td><code>RESINSIGHT_ODB_API_DIR</code></td>
<td>Blank</td>
<td>Optional path to the ABAQUS ODB API from Simulia. Needed for support of geomechanical models</td>
</tr>
<tr>
<td><code>RESINSIGHT_USE_OPENMP</code></td>
<td>ON</td>
<td>Enable OpenMP parallellization in the code</td>
</tr>
</tbody>
</table>
<h4 id="advanced-options">Advanced Options</h4>
<p>To be able to modify <strong>Advanced Options</strong> from the CMake User Interface, tick the checkbox <strong>Advanced</strong></p>
<table>
<thead>
<tr>
<th>CMake Name</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>RESINSIGHT_BUILD_WITH_QT5</code></td>
<td>ON</td>
<td>If ON, use Qt5. If OFF, use Qt4 (Support for Qt4 is deprecated and will be removed)</td>
</tr>
<tr>
<td><code>RESINSIGHT_QT5_BUNDLE_LIBRARIES</code></td>
<td>OFF</td>
<td>Linux only: Include Qt5 libraries in the installation package</td>
</tr>
<tr>
<td><code>RESINSIGHT_BUNDLE_OPENSSL</code></td>
<td>OFF</td>
<td>Bundle the OpenSSL library DLLs in the Windows installer package</td>
</tr>
<tr>
<td><code>RESINSIGHT_ENABLE_COTIRE</code></td>
<td>OFF</td>
<td>Experimental speedup of compilation using cotire</td>
</tr>
<tr>
<td><code>RESINSIGHT_ENABLE_PROTOTYPE_FEATURE_SOURING</code></td>
<td>ON</td>
<td>Enable Souring features</td>
</tr>
<tr>
<td><code>RESINSIGHT_INCLUDE_APPFWK_TESTS</code></td>
<td>OFF</td>
<td>Include unit tests from thirdparty libraries AppFwk and VizFwk</td>
</tr>
<tr>
<td><code>RESINSIGHT_INCLUDE_APPLICATION_UNIT_TESTS</code></td>
<td>OFF</td>
<td>Include Application Code Unit Tests</td>
</tr>
<tr>
<td><code>RESINSIGHT_PRIVATE_INSTALL</code></td>
<td>ON</td>
<td>Linux only: Include libecl libraries in the installation package</td>
</tr>
<tr>
<td><code>RESINSIGHT_HDF5_BUNDLE_LIBRARIES</code></td>
<td>OFF</td>
<td>Linux only: Include HDF5 libraries in the installation package</td>
</tr>
</tbody>
</table>
<h4 id="configuration-parameters-for-python">Configuration parameters for Python</h4>
<table>
<thead>
<tr>
<th>CMake Name</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>RESINSIGHT_ENABLE_GRPC</code></td>
<td>OFF</td>
<td>Enable ResInsight scripting server (required for use of Python)</td>
</tr>
<tr>
<td><code>RESINSIGHT_GRPC_PYTHON_EXECUTABLE</code></td>
<td>Blank</td>
<td>Location of Python3 executable</td>
</tr>
<tr>
<td><code>RESINSIGHT_GRPC_INSTALL_PREFIX</code></td>
<td>Blank</td>
<td>Linux only : Installation prefix for gRPC</td>
</tr>
</tbody>
</table>
<h3 id="optional-libraries-and-features">Optional Libraries and features</h3>
<h4 id="python">Python</h4>
<p>Please see <a href="https://api.resinsight.org">ResInsight Python API</a> for installation and configuration.</p>
<h4 id="octave">Octave</h4>
<p>Octave is now detected searching the file system. If Octave is not detected, the following file path variable must be defined:</p>
<p><code>OCTAVE_CONFIG_EXECUTABLE : d:\octave\Octave-4.0.0\bin\octave-config.exe</code></p>
<p>It is possible to build ResInsight without compiling the Octave plugins. This can be done by specifying blank for
the Octave CMake options. The Octave plugin module will not be built, and CMake will show warnings like &lsquo;Failed to find mkoctfile&rsquo;.
This will not break the build or compilation of ResInsight.</p>
<p>ResInsight has been verified to build and run with Octave versions 3.4.3, 3.8.1, and 4.0.0 on RedHat linux, and 4.0.0 on Windows.</p>
<h5 id="octave-dependencies-for-debian-based-distributions">Octave Dependencies for Debian Based Distributions</h5>
<p>The following command line can be used as a starting point to install required libraries
<code>sudo apt-get install git cmake build-essential octave liboctave-dev qtbase5-dev qtscript5-dev</code></p>
<h4 id="odb-support">ODB support</h4>
<p>ResInsight can be built with support for ABAQUS ODB files. This requires an installation of the ABAQUS ODB API
from Simulia on the build computer. The path to the ABAQUS ODB API folder containing header files and library
files must be specified. Leaving this option blank gives a build without ODB support.
ResInsight has been built and tested with ABAQUS ODB API version 6.14-3 on Windows 7/8/10 and RedHat Linux 6.</p>
<h4 id="hdf5">HDF5</h4>
<p>HDF5 is used to read SourSimRL result files. On Windows this is optional, while on Linux the installed HDF5 library will be used if present.</p>
<p>Use an advanced flag RESINSIGHT_HDF5_BUNDLE_LIBRARIES to include HDF5 libraries in the installation package.</p>
<p>Tested with 1.8.18 on windows, and default installation on RedHat 6.</p>
<footer class="footline">
</footer>
</div>
</div>
<div id="navigation">
<a class="nav nav-prev" href="/getting-started/download-and-install/windows-installation/" title="Windows Installation"> <i class="fa fa-chevron-left"></i></a>
<a class="nav nav-next" href="/getting-started/helpmenuanddocumentation/" title="Help Menu and Documentation" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
</div>
</section>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="/js/clipboard.min.js?1588568942"></script>
<script src="/js/perfect-scrollbar.min.js?1588568942"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1588568942"></script>
<script src="/js/jquery.sticky.js?1588568942"></script>
<script src="/js/featherlight.min.js?1588568942"></script>
<script src="/js/highlight.pack.js?1588568942"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1588568942"></script>
<script src="/js/learn.js?1588568942"></script>
<script src="/js/hugo-learn.js?1588568942"></script>
<link href="/mermaid/mermaid.css?1588568942" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1588568942"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>
</body>
</html>