Octave

Building: Difference between revisions

Page Discussion

Building (view source)

Revision as of 01:01, 16 March 2022

5,039 bytes added ,  16 March 2022
m
→‎General steps
No edit summary
 
(88 intermediate revisions by 9 users not shown)
Line 1: Line 1:
General information about building the Octave source for different operating systems.
:''This article provides general information about '''building GNU Octave''' from source (on Unix-like systems).''


We try to keep build instructions up to date in the source tree. Please clone using [[Mercurial]] or download it to see the README.
:*''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]].''


There are also instructions in the [http://www.gnu.org/software/octave/doc/interpreter/Installation.html manual].
== General steps ==


* [[Octave for Debian systems]].
# Install all [[#Dependencies|build dependencies]] (see below).
* [[Octave for Arch Linux]].
# Getting the Octave sources ...
* [[Building for Macintosh platform]]
::(A) ... from the development repository (requires also [https://www.mercurial-scm.org/ Mercurial])
<div style="margin-left:5em;">
hg clone https://www.octave.org/hg/octave && \
cd octave                                  && \
./bootstrap
</div>
::(B) ... from a release
<div style="margin-left:5em;">
wget https://ftpmirror.gnu.org/octave/octave-{{Release}}.tar.gz && \
tar -xzf octave-{{Release}}.tar.gz                              && \
cd octave-{{Release}}
</div>
: 3. Configure, build, check, and install Octave
<div style="margin-left:3em;">
mkdir .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>
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 install
</div>


==Dependencies==
== Dependencies ==


{| class"wikitable"
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.
 
=== Build tools ===
 
{| class="wikitable"
|-
|-
| Critical
! Dependency
| style="background:red" | &nbsp;
! Description
! License / Copyright
|-style="background:lightgreen"
| [https://www.gnu.org/software/autoconf Autoconf]
| Software configuration
| GNU GPL v3.0
|-style="background:lightgreen"
| [https://www.gnu.org/software/automake Automake]
| Makefile generator
| GNU GPL v3.0
|-style="background:lightgreen"
| [https://gcc.gnu.org C++, C, and Fortran compilers]
| Compiling the source code
| GNU GPL v3.0
|-style="background:lightgreen"
| [https://www.gnu.org/software/make GNU Make]
| Makefile processor
| GNU GPL v3.0
|-style="background:lightgreen"
| [https://www.gnu.org/software/libtool Libtool]
| Dependency of automake
| Free Software Foundation
|-style="background:lightgreen"
| Unix utilities: gawk, gperf, less, ncurses
| Miscellaneous tasks
| GNU GPL v3.0
|-
|-
| Recommended
| [https://www.gnu.org/software/bison Bison]
| style="background:yellow" | &nbsp;
| Parser generator
| GNU GPL v3.0
|-
|-
| Not critical
| [https://www.gnu.org/software/flex Flex]
| style="background:green" | &nbsp;
| Lexical analyzer
| The Flex project
|}
|}
=== Documentation tools ===


{| class="wikitable"
{| class="wikitable"
|-
|-
! Task
! Dependency
! Name
! Description
! Usage
! License / Copyright
! Debian
! Level
|-
|-
| rowspan="8"| Build tools
| [http://www.ghostgum.com.au/software/epstool.htm epstool]
| C++, C, and Fortran compilers
| Epstool is a utility to create or extract preview images in EPS files, fix bounding boxes and convert to bitmaps.
| Compiling the source code
| GNU GPL v2.0
| {{codeline|build-essential}}
| style="background:red" | &nbsp;
|-
|-
| [http://www.gnu.org/software/make GNU Make]
| [https://www.freetype.org FTGL]
| Makefile processor
| Portable font engine to perform font rendering for Octave’s OpenGL-based graphics functions.
| {{codeline|make}}
| GNU GPL v2.0
| style="background:red" | &nbsp;
|-
|-
| AWK, sed, and other Unix utilities
| [http://geuz.org/gl2ps GL2PS]
| Miscellaneous tasks
| GL2PS is a C library providing high quality vector output for any OpenGL application.
| {{codeline|awk}}, {{codeline|sed}}, ...
| GNU LGPL v2.0
| style="background:red" | &nbsp;
|-
|-
| [http://www.gnu.org/software/bison Bison]
| [https://www.nongnu.org/texi2html Texi2HTML]
| Parser generator
| Perl script which converts Texinfo source files to HTML output.
| {{codeline|bison}}
| GNU GPL v3.0
| style="background:green" | &nbsp;
|-
|-
| [http://www.gnu.org/software/flex Flex]
| [https://www.gnu.org/software/texinfo Texinfo]
| Lexical analyzer
| Documentation system that uses a single source to produce both on-line information and printed output.
| {{codeline|flex}}
| GNU GPL v3.0
| style="background:green" | &nbsp;
|-
|-
| [http://www.gnu.org/software/autoconf Autoconf]
| [https://www.tug.org/texlive/ TeX Live]
| Software configuration
| TeX document production system including all the major TeX-related programs, macro packages, and fonts that are free software.
| {{codeline|autoconf}}
| Freely redistributable as defined by the Free Software Foundation
| style="background:red" | &nbsp;
|}
 
=== External tools and libraries ===
 
{| class="wikitable"
|-
|-
| [http://www.gnu.org/software/automake Automake]
! Dependency
| Makefile generator
! Description
| {{codeline|automake}}
! License / Copyright
| style="background:red" | &nbsp;
|-style="background:lightgreen"
|-
| [https://www.netlib.org/blas BLAS]
| [http://www.gnu.org/software/libtool Libtool]
| Dependency of automake
| {{codeline|libtool}}
| style="background:red" | &nbsp;
|-
| rowspan="19"| External tools
| [http://www.netlib.org/blas BLAS]
| Basic Linear Algebra Subroutine library
| Basic Linear Algebra Subroutine library
| {{codeline|libatlas-base-dev}}
| Free - proper attribution request
| style="background:red" | &nbsp;
|-style="background:lightgreen"
|-
| [https://netlib.org/lapack LAPACK]
| [http://www.netlib.org/lapack LAPACK]
| Linear Algebra Package
| Linear Algebra Package
| {{codeline|liblapack-dev}}
| Free - proper attribution request
| style="background:red" | &nbsp;
|-style="background:lightgreen"
|-
| [https://www.pcre.org PCRE]
| [http://www.pcre.org PCRE]
| Perl Compatible Regular Expression library
| Perl Compatible Regular Expression library
| {{codeline|libpcre3-dev}}
| Free
| style="background:red" | &nbsp;
|-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
| {{codeline|libreadline-dev}}
| GNU GPL v3.0
| style="background:yellow" | &nbsp;
|-
|-
| [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
| {{codeline|libarpack2-dev}}
| BSD like - various authors
| style="background:red" | &nbsp;
|-
|-
| [http://curl.haxx.se cURL]
| [https://curl.haxx.se cURL]
| Library for transferring data with URL syntax
| Library for transferring data with URL syntax
| {{codeline|curl}}
| Free Software -- main author
| style="background:red" | &nbsp;
|-
|-
| [http://www.fftw.org FFTW3]
| [http://www.fftw.org FFTW3]
| Library for computing discrete Fourier transforms
| Library for computing discrete Fourier transforms
| {{codeline|libfftw3-dev}}
| MIT -- GNU GPL v2.0
| style="background:red" | &nbsp;
|-
|-
| [http://www.fltk.org FLTK]
| [https://www.fltk.org FLTK]
| Portable GUI toolkit
| Portable GUI toolkit
| {{codeline|libfltk1.3-dev}}
| GNU GPL v2.0 with static linking exception
| style="background:red" | &nbsp;
|-
|-
| [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
| {{codeline|fontconfig}}
| Provided "as is" -- various authors
| style="background:red" | &nbsp;
|-
|-
| [http://www.freetype.org FreeType]
| [https://www.freetype.org FreeType]
| Portable font engine
| Portable font engine
| {{codeline|libfreetype6-dev}}
| compatible with GNU GPL v3.0
| style="background:red" | &nbsp;
|-
|-
| [http://www.gnu.org/software/glpk GLPK]
| [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
| {{codeline|libglpk-dev}}
| GNU GPL v3.0
| style="background:yellow" | &nbsp;
|-
|-
| [http://www.gnuplot.info gnuplot]
| [http://www.gnuplot.info gnuplot]
| Interactive graphics program
| Interactive graphics program
| {{codeline|gnuplot}}
| Provided "as is" -- various authors
| style="background:red" | &nbsp;
|-
|-
| [http://www.graphicsmagick.org GraphicsMagick++]
| Magick++, e.g. [http://www.graphicsmagick.org GraphicsMagick++]
| Image processing library
| Image processing library
| {{codeline|libgraphicsmagick++1-dev}}
| various -- integrates many third-party libs
| style="background:yellow" | &nbsp;
|-
|-
| [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
| {{codeline|libhdf5-dev}}
| BSD - like
| style="background:yellow" | &nbsp;
|-
|-
| [http://www.opengl.org OpenGL]
| 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
| style="background:red" | &nbsp;
|-
| [http://www.portaudio.com/ PortAudio]
| Audio I/O library
| Free software -- specific
|-
|-
| [http://www.qhull.org Qhull]
| [http://www.qhull.org Qhull]
| Computational geometry library
| Computational geometry library
| {{codeline|libqhull-dev}}
| Free software -- specific
| style="background:yellow" | &nbsp;
|-
|-
| [http://sourceforge.net/projects/qrupdate QRUPDATE]
| [http://sourceforge.net/projects/qrupdate QRUPDATE]
| QR factorization updating library
| QR factorization updating library
| {{codeline|libqrupdate-dev}}
| GNU GPL v3.0
| style="background:yellow" | &nbsp;
|-
| [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://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
| {{codeline|libsuitesparse-dev}}
| Main author
| style="background:yellow" | &nbsp;
|-
| [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
|-
|-
| [http://zlib.net zlib]
| [https://zlib.net zlib]
| Data compression library
| Data compression library
| {{codeline|zlib1g-dev}}
| Provided "as is" -- various authors
| style="background:yellow" | &nbsp;
|}
|}
== 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 ==
* [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
* [[MXE]] -- a more customized Octave build including many self-compiled tools.
== Footnotes ==
<references/>


[[Category:Building]]
[[Category:Building]]
Retrieved from "https://wiki.octave.org/Special:MobileDiff/3796...14242"