1,848
edits
(→Documentation tools: "transfig" does not seem to be required any longer...) |
m (→General steps) |
||
(26 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
: '' This article provides general information about building GNU Octave from source.'' | :''This article provides general information about '''building GNU Octave''' from source (on Unix-like systems).'' | ||
:*''If you just want to '''install GNU Octave''', see [[:Category:Installation]].'' | |||
:*''For '''MS Windows''', read [[Building on Microsoft Windows]] and [[Windows Installer]].'' | |||
:*''For '''macOS''', read [[Octave for macOS]].'' | |||
== General steps == | == General steps == | ||
Line 5: | Line 9: | ||
# Install all [[#Dependencies|build dependencies]] (see below). | # Install all [[#Dependencies|build dependencies]] (see below). | ||
# Getting the Octave sources ... | # Getting the Octave sources ... | ||
::(A) ... from the development repository (requires also [https://www.mercurial-scm.org/ Mercurial]) | |||
<div style="margin-left:5em;"> | <div style="margin-left:5em;"> | ||
hg clone https://www.octave.org/hg/octave && \ | hg clone https://www.octave.org/hg/octave && \ | ||
Line 11: | Line 15: | ||
./bootstrap | ./bootstrap | ||
</div> | </div> | ||
:: | ::(B) ... from a release | ||
<div style="margin-left:5em;"> | <div style="margin-left:5em;"> | ||
wget https://ftpmirror.gnu.org/octave/octave-{{Release}}.tar.gz && \ | wget https://ftpmirror.gnu.org/octave/octave-{{Release}}.tar.gz && \ | ||
Line 21: | Line 25: | ||
mkdir .build && \ | mkdir .build && \ | ||
cd .build && \ | cd .build && \ | ||
./../configure --prefix=$HOME/my_octave && \ <ref><code>--prefix</code> determines the installation location.</ref> | ./../configure --prefix=$HOME/my_octave && \ <ref><code>--prefix</code> determines the installation location, see the [[#Install Octave in home directory|Tweaks section]] for details. For more information about configuration options, type <code>./../configure --help</code>.</ref> | ||
make -j2 && \ <ref>Depending on your system and processor count, use a larger number of parallel jobs, e.g. <code>-j8</code>.</ref> | make -j2 && \ <ref>Depending on your system and processor count, use a larger number of parallel jobs, e.g. <code>-j8</code>.</ref> | ||
make check && \ | make check && \ | ||
Line 29: | Line 33: | ||
== Dependencies == | == Dependencies == | ||
Most of the dependencies given in this section can be very conveniently installed on many [[Octave for GNU/Linux|GNU/Linux]] systems | Most of the dependencies given in this section can be very conveniently installed on many [[Octave for GNU/Linux|GNU/Linux]] systems. | ||
{{Note|For a quick way to install the required dependencies, see: | |||
* [[Octave for Debian systems#The right way|Debian / Ubuntu]] | |||
* [[Octave for Arch Linux|Arch Linux]] | |||
* [[Octave for Red Hat Linux systems|Fedora / RedHat / CentOS]]}} | |||
Dependencies marked with <span style="background:lightgreen">green background</span> are '''required''' for building Octave. All other tools and libraries are recommended/optional, but very useful features (like the GUI, plotting, etc.) are likely to be disabled. | Dependencies marked with <span style="background:lightgreen">green background</span> are '''required''' for building Octave. All other tools and libraries are recommended/optional, but very useful features (like the GUI, plotting, etc.) are likely to be disabled. | ||
Line 117: | Line 124: | ||
! License / Copyright | ! License / Copyright | ||
|-style="background:lightgreen" | |-style="background:lightgreen" | ||
| [ | | [https://www.netlib.org/blas BLAS] | ||
| Basic Linear Algebra Subroutine library | | Basic Linear Algebra Subroutine library | ||
| Free - proper attribution request | | Free - proper attribution request | ||
|-style="background:lightgreen" | |-style="background:lightgreen" | ||
| [ | | [https://netlib.org/lapack LAPACK] | ||
| Linear Algebra Package | | Linear Algebra Package | ||
| Free - proper attribution request | | Free - proper attribution request | ||
|-style="background:lightgreen" | |-style="background:lightgreen" | ||
| [ | | [https://www.pcre.org PCRE] | ||
| Perl Compatible Regular Expression library | | Perl Compatible Regular Expression library | ||
| Free | | Free | ||
|-style="background:lightgreen" | |-style="background:lightgreen" | ||
| [ | | [https://www.gnu.org/software/readline GNU Readline] | ||
| Command-line editing library | | Command-line editing library | ||
| GNU GPL v3.0 | | GNU GPL v3.0 | ||
|- | |- | ||
| [ | | [https://github.com/opencollab/arpack-ng ARPACK-NG] | ||
| Solution of large-scale eigenvalue problems | | Solution of large-scale eigenvalue problems | ||
| BSD like - various authors | | BSD like - various authors | ||
|- | |- | ||
| [ | | [https://curl.haxx.se cURL] | ||
| Library for transferring data with URL syntax | | Library for transferring data with URL syntax | ||
| Free Software -- main author | | Free Software -- main author | ||
Line 145: | Line 152: | ||
| MIT -- GNU GPL v2.0 | | MIT -- GNU GPL v2.0 | ||
|- | |- | ||
| [ | | [https://www.fltk.org FLTK] | ||
| Portable GUI toolkit | | Portable GUI toolkit | ||
| GNU GPL v2.0 with static linking exception | | GNU GPL v2.0 with static linking exception | ||
|- | |- | ||
| [ | | [https://www.freedesktop.org/wiki/Software/fontconfig fontconfig] | ||
| Library for configuring and customizing font access | | Library for configuring and customizing font access | ||
| Provided "as is" -- various authors | | Provided "as is" -- various authors | ||
|- | |- | ||
| [ | | [https://www.freetype.org FreeType] | ||
| Portable font engine | | Portable font engine | ||
| compatible with GNU GPL v3.0 | | compatible with GNU GPL v3.0 | ||
|- | |- | ||
| [ | | [https://www.geuz.org/gl2ps/ GL2PS] | ||
| OpenGL to PostScript printing library | |||
| GNU GPL v2.0 | |||
|- | |||
| [https://www.gnu.org/software/glpk GLPK] | |||
| GNU Linear Programming Kit | | GNU Linear Programming Kit | ||
| GNU GPL v3.0 | | GNU GPL v3.0 | ||
Line 165: | Line 176: | ||
| Provided "as is" -- various authors | | Provided "as is" -- various authors | ||
|- | |- | ||
| [http://www.graphicsmagick.org GraphicsMagick++] | | Magick++, e.g. [http://www.graphicsmagick.org GraphicsMagick++] | ||
| Image processing library | | Image processing library | ||
| various -- integrates many third-party libs | | various -- integrates many third-party libs | ||
|- | |- | ||
| [ | | [https://www.hdfgroup.org/solutions/hdf5 HDF5] | ||
| Library for manipulating portable data files | | Library for manipulating portable data files | ||
| BSD - like | | BSD - like | ||
|- | |- | ||
| [ | | JDK, e.g. [https://www.hdfgroup.org/solutions/hdf5 OpenJDK] | ||
| Java programming language compiler and libraries | |||
| GNU GPL v2.0 | |||
|- | |||
| [https://www.opengl.org OpenGL] | |||
| API for portable 2D and 3D graphics | | API for portable 2D and 3D graphics | ||
| Free specs -- license is driver dependent | | Free specs -- license is driver dependent | ||
|- | |||
| [http://www.portaudio.com/ PortAudio] | |||
| Audio I/O library | |||
| Free software -- specific | |||
|- | |- | ||
| [http://www.qhull.org Qhull] | | [http://www.qhull.org Qhull] | ||
Line 185: | Line 204: | ||
| GNU GPL v3.0 | | GNU GPL v3.0 | ||
|- | |- | ||
| [http:// | | [https://riverbankcomputing.com/software/qscintilla QScintilla] | ||
| Source code highlighter and manipulator; a Qt port of Scintilla | |||
| GNU GPL v3.0 | |||
|- | |||
| [https://www.qt.io/ Qt] | |||
| Widget toolkit for creating graphical user interfaces | |||
| GNU LGPL v3.0 | |||
|- | |||
| [https://rapidjson.org/ RapidJSON] | |||
| A fast JSON parser/generator for C++ with both SAX/DOM style API | |||
| MIT license | |||
|- | |||
| [http://faculty.cse.tamu.edu/davis/suitesparse.html SuiteSparse] | |||
| Sparse matrix factorization library | | Sparse matrix factorization library | ||
| Main author | | Main author | ||
|- | |- | ||
| [ | | [https://computing.llnl.gov/projects/sundials/ida SUNDIALS IDA] | ||
| SUite of Nonlinear and DIfferential/ALgebraic equation Solvers - Initial value problems for Differential-Algebraic equation (DAE) systems | |||
| BSD 3-Clause | |||
|- | |||
| [https://zlib.net zlib] | |||
| Data compression library | | Data compression library | ||
| Provided "as is" -- various authors | | Provided "as is" -- various authors | ||
|} | |} | ||
== Tweaks == | |||
=== Install Octave in home directory === | |||
To install multiple versions of GNU Octave on one system, it is recommended to use the <code>--prefix</code> option of the <code>configure</code> script. With this option one can determine a custom installation directory, preferably within your user's home directory, to avoid elevated installation privileges. One does not "clutter" the system by running <code>sudo make install</code> and the custom build Octave can coexist with, for example, your Linux distribution installation of Octave. | |||
In order to start the custom build of Octave almost as convenient as the Linux distribution installation of Octave, one can create an alias within {{Path|.bashrc}}: | |||
echo "alias myoctave='$HOME/my_octave/bin/octave'" >> ~/.bashrc | |||
Then update your {{Path|.bashrc}} without doing logout and login: | |||
source $HOME/.bashrc | |||
If you simply enter <code>octave</code>, you'll start your Linux distribution installation of Octave. But when you enter <code>myoctave</code>, you'll start your custom build of Octave inside your home directory. | |||
=== Uninstall === | |||
# If you still have the {{Path|.build}} folder, just run <code>make uninstall</code> from it. | |||
# Just delete the install folder, e.g. <code>rm -rf $HOME/my_octave</code>. | |||
In any case, don't forget to remove any created ''alias'' entries in {{Path|~/.bashrc}}. | |||
=== Large array support === | |||
: ''Main article: [[Enable large arrays: Build octave such that it can use arrays larger than 2Gb.]]'' | |||
== See also == | == See also == | ||
* [https://hg.savannah.gnu.org/hgweb/octave/file/ | * [https://hg.savannah.gnu.org/hgweb/octave/file/tip/README <code>README</code>] and [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/HACKING.md <code>/etc/HACKING.md</code>] in the development repository. | ||
* https://octave.org/doc/interpreter/Installation.html | * https://octave.org/doc/interpreter/Installation.html | ||
* [[MXE]] -- a more customized Octave build including many self-compiled tools. | |||
== Footnotes == | == Footnotes == |