Difference between revisions of "Building"

From Octave
Jump to navigation Jump to search
(→‎General steps: Drop table layout.)
(noted hg dependency)
 
(11 intermediate revisions by one other user 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.  If you just want to install Octave, see [[:Category:Installation]].''
  
 
== General steps ==
 
== General steps ==
Line 5: Line 5:
 
# Install all [[#Dependencies|build dependencies]] (see below).
 
# Install all [[#Dependencies|build dependencies]] (see below).
 
# Getting the Octave sources ...
 
# Getting the Octave sources ...
#* ... from the development repository
+
#* ... 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 21: Line 21:
 
  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 107: 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 121: Line 117:
 
! License / Copyright
 
! License / Copyright
 
|-style="background:lightgreen"
 
|-style="background:lightgreen"
| [http://www.netlib.org/blas BLAS]
+
| [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"
| [http://www.netlib.org/lapack LAPACK]
+
| [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"
| [http://www.pcre.org PCRE]
+
| [https://www.pcre.org PCRE]
 
| Perl Compatible Regular Expression library
 
| Perl Compatible Regular Expression library
 
| Free
 
| Free
 
|-style="background:lightgreen"
 
|-style="background:lightgreen"
| [http://www.gnu.org/s/readline GNU Readline]
+
| [https://www.gnu.org/software/readline GNU Readline]
 
| Command-line editing library
 
| Command-line editing library
 
| GNU GPL v3.0
 
| GNU GPL v3.0
 
|-
 
|-
| [http://forge.scilab.org/index.php/p/arpack-ng ARPACK]
+
| [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
 
|-
 
|-
| [http://curl.haxx.se cURL]
+
| [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 149: Line 145:
 
| MIT -- GNU GPL v2.0
 
| MIT -- GNU GPL v2.0
 
|-
 
|-
| [http://www.fltk.org FLTK]
+
| [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
 
|-
 
|-
| [http://www.freedesktop.org/wiki/Software/fontconfig fontconfig]
+
| [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
 
|-
 
|-
| [http://www.freetype.org FreeType]
+
| [https://www.freetype.org FreeType]
 
| Portable font engine
 
| Portable font engine
 
| compatible with GNU GPL v3.0
 
| compatible with GNU GPL v3.0
 
|-
 
|-
| [http://www.gnu.org/software/glpk GLPK]
+
| [https://www.gnu.org/software/glpk GLPK]
 
| GNU Linear Programming Kit
 
| GNU Linear Programming Kit
 
| GNU GPL v3.0
 
| GNU GPL v3.0
Line 173: Line 169:
 
| various -- integrates many third-party libs
 
| various -- integrates many third-party libs
 
|-
 
|-
| [http://www.hdfgroup.org/HDF5 HDF5]
+
| [https://www.hdfgroup.org/solutions/hdf5 HDF5]
 
| Library for manipulating portable data files
 
| Library for manipulating portable data files
 
| BSD - like
 
| BSD - like
 
|-
 
|-
| [http://www.opengl.org OpenGL]
+
| [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
Line 189: Line 185:
 
| GNU GPL v3.0
 
| GNU GPL v3.0
 
|-
 
|-
| [http://www.cise.ufl.edu/research/sparse/SuiteSparse SuiteSparse]
+
| [http://faculty.cse.tamu.edu/davis/suitesparse.html SuiteSparse]
 
| Sparse matrix factorization library
 
| Sparse matrix factorization library
 
| Main author
 
| Main author
 
|-
 
|-
| [http://zlib.net zlib]
+
| [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/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://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 ==

Latest revision as of 10:47, 14 November 2019

This article provides general information about building GNU Octave from source. If you just want to install Octave, see Category:Installation.

General steps[edit]

  1. Install all build dependencies (see below).
  2. Getting the Octave sources ...
    • ... from the development repository (requires also Mercurial)
hg clone https://www.octave.org/hg/octave && \
cd octave                                  && \
./bootstrap
  • ... from a release
wget https://ftpmirror.gnu.org/octave/octave-5.1.0.tar.gz && \
tar -xzf octave-5.1.0.tar.gz                               && \
cd octave-5.1.0
3. Configure, build, check, and install Octave
mkdir .build                            && \
cd    .build                            && \
./../configure --prefix=$HOME/my_octave && \ [1]
make -j2                                && \ [2]
make check                              && \
make install

Dependencies[edit]

Most of the dependencies given in this section can be very conveniently installed on many GNU/Linux systems. Please read the respective wiki page for your distribution on the Octave for GNU/Linux page.

On MS Windows and 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.

Dependencies marked with green background 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.

Build tools[edit]

Dependency Description License / Copyright
Autoconf Software configuration GNU GPL v3.0
Automake Makefile generator GNU GPL v3.0
C++, C, and Fortran compilers Compiling the source code GNU GPL v3.0
GNU Make Makefile processor GNU GPL v3.0
Libtool Dependency of automake Free Software Foundation
Unix utilities: gawk, gperf, less, ncurses Miscellaneous tasks GNU GPL v3.0
Bison Parser generator GNU GPL v3.0
Flex Lexical analyzer The Flex project

Documentation tools[edit]

Dependency Description License / Copyright
epstool Epstool is a utility to create or extract preview images in EPS files, fix bounding boxes and convert to bitmaps. GNU GPL v2.0
FTGL Portable font engine to perform font rendering for Octave’s OpenGL-based graphics functions. GNU GPL v2.0
GL2PS GL2PS is a C library providing high quality vector output for any OpenGL application. GNU LGPL v2.0
Texi2HTML Perl script which converts Texinfo source files to HTML output. GNU GPL v3.0
Texinfo Documentation system that uses a single source to produce both on-line information and printed output. GNU GPL v3.0
TeX Live 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

External tools and libraries[edit]

Dependency Description License / Copyright
BLAS Basic Linear Algebra Subroutine library Free - proper attribution request
LAPACK Linear Algebra Package Free - proper attribution request
PCRE Perl Compatible Regular Expression library Free
GNU Readline Command-line editing library GNU GPL v3.0
ARPACK-NG Solution of large-scale eigenvalue problems BSD like - various authors
cURL Library for transferring data with URL syntax Free Software -- main author
FFTW3 Library for computing discrete Fourier transforms MIT -- GNU GPL v2.0
FLTK Portable GUI toolkit GNU GPL v2.0 with static linking exception
fontconfig Library for configuring and customizing font access Provided "as is" -- various authors
FreeType Portable font engine compatible with GNU GPL v3.0
GLPK GNU Linear Programming Kit GNU GPL v3.0
gnuplot Interactive graphics program Provided "as is" -- various authors
GraphicsMagick++ Image processing library various -- integrates many third-party libs
HDF5 Library for manipulating portable data files BSD - like
OpenGL API for portable 2D and 3D graphics Free specs -- license is driver dependent
Qhull Computational geometry library Free software -- specific
QRUPDATE QR factorization updating library GNU GPL v3.0
SuiteSparse Sparse matrix factorization library Main author
zlib Data compression library Provided "as is" -- various authors

Tweaks[edit]

Install Octave in home directory[edit]

To install multiple versions of GNU Octave on one system, it is recommended to use the --prefix option of the configure 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 sudo make install 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 .bashrc:

echo "alias myoctave='$HOME/my_octave/bin/octave'" >> ~/.bashrc

Then update your .bashrc without doing logout and login:

source $HOME/.bashrc

If you simply enter octave, you'll start your Linux distribution installation of Octave. But when you enter myoctave, you'll start your custom build of Octave inside your home directory.

Uninstall[edit]

  1. If you still have the .build folder, just run make uninstall from it.
  2. Just delete the install folder, e.g. rm -rf $HOME/my_octave.

In any case, don't forget to remove any created alias entries in ~/.bashrc.

Large array support[edit]

Main article: Enable large arrays: Build octave such that it can use arrays larger than 2Gb.

See also[edit]

Footnotes[edit]

  1. --prefix determines the installation location, see the Tweaks section for details. For more information about configuration options, type ./../configure --help.
  2. Depending on your system and processor count, use a larger number of parallel jobs, e.g. -j8.