Editing Building

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
:''This article provides general information about '''building GNU Octave''' from source (on Unix-like systems).''
: '' This article provides general information about building GNU Octave from source.''
 
:*''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 9: Line 5:
# 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])
#* ... from the development repository
<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 15: Line 11:
  ./bootstrap
  ./bootstrap
</div>
</div>
::(B) ... from a release
::* ... 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 25: Line 21:
  mkdir .build                            && \
  mkdir .build                            && \
  cd    .build                            && \
  cd    .build                            && \
  ./../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>
  ./../configure --prefix=$HOME/my_octave && \ <ref><code>--prefix</code> determines the installation location.</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 33: Line 29:
== 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.  Please read the respective wiki page for your distribution on the [[Octave for GNU/Linux]] page.


{{Note|For a quick way to install the required dependencies, see:
On [[Octave for Microsoft Windows|MS Windows]] and [[Octave for macOS|macOS]] systems the generic Octave build process described on this page needs some more effort to fulfill the described build dependencies.  Please read [[Octave for Microsoft Windows]] and [[Octave for macOS]] for information how to build Octave for the respective systems.
* [[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 114: Line 107:
| TeX document production system including all the major TeX-related programs, macro packages, and fonts that are free software.
| TeX document production system including all the major TeX-related programs, macro packages, and fonts that are free software.
| Freely redistributable as defined by the Free Software Foundation
| Freely redistributable as defined by the Free Software Foundation
|-
| [https://www.ctan.org/pkg/transfig transfig]
| Tans­lates fig­ures gen­er­ated by xfig to a large va­ri­ety of for­mats.
| BSD Style Li­cense
|}
|}


Line 124: Line 121:
! License / Copyright
! License / Copyright
|-style="background:lightgreen"
|-style="background:lightgreen"
| [https://www.netlib.org/blas BLAS]
| [http://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]
| [http://www.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]
| [http://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]
| [http://www.gnu.org/s/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]
| [http://forge.scilab.org/index.php/p/arpack-ng ARPACK]
| 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]
| [http://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 152: Line 149:
| MIT -- GNU GPL v2.0
| MIT -- GNU GPL v2.0
|-
|-
| [https://www.fltk.org FLTK]
| [http://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]
| [http://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]
| [http://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]
| [http://www.gnu.org/software/glpk GLPK]
| 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 176: Line 169:
| Provided "as is" -- various authors
| Provided "as is" -- various authors
|-
|-
| Magick++, e.g. [http://www.graphicsmagick.org GraphicsMagick++]
| [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]
| [http://www.hdfgroup.org/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]
| [http://www.opengl.org OpenGL]
| 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 204: Line 189:
| GNU GPL v3.0
| GNU GPL v3.0
|-
|-
| [https://riverbankcomputing.com/software/qscintilla QScintilla]
| [http://www.cise.ufl.edu/research/sparse/SuiteSparse SuiteSparse]
| 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]
| [http://zlib.net zlib]
| 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/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://hg.savannah.gnu.org/hgweb/octave/file/3490ea06aba1/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 ==
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://wiki.octave.org/Building"