Editing Octave for macOS

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 save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
On macOS systems GNU Octave can be installed by:
+
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems.
# macOS App Bundles '''"Octave.app"''' (a single [https://en.wikipedia.org/wiki/Apple_Disk_Image dmg-file])
+
GNU Octave for Mac OS X is readily available using [http://en.wikipedia.org/wiki/Package_management_system package managers] such as [http://www.finkproject.org/ Fink], [http://www.macports.org/ MacPorts], and [http://mxcl.github.com/homebrew/ Homebrew].
# macOS [[#Package Managers|package managers]].
 
  
{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}
+
About version numbers (as of June 2016):
  
== macOS App Bundles ==
+
*The 4.0.x are current releases.
 +
*The 3.8.x are previous releases.
 +
*The 3.6.x are old releases.
 +
*The 3.4.x are very old releases.
  
The [https://octave-app.org/ Octave.app project] provides an unofficial ready-to-use, drag-and-drop macOS App installer based on [[#Homebrew|Homebrew]] (see below).
+
==Installing a Mac OS X Bundle==
* [https://github.com/octave-app/octave-app/releases Download installer from GitHub]
 
  
A '''very old''' installer is hosted on SourceForge.
+
Good progress has been made on creating a reliable App bundle for Octave on Mac OS X. Approaches using [http://www.macports.org MacPorts] and [http://brew.sh Homebrew] have been considered.
* [https://sourceforge.net/projects/octave/files/Octave%20MacOSX%20Binary/2016-07-11-binary-octave-4.0.3/octave_gui_403_appleblas.dmg/download macOS App Bundle of Octave 4.0.3 (with GUI)] (OS X 10.9+)
 
  
== Package Managers ==
+
* [https://sourceforge.net/projects/octave/files/Octave%20MacOSX%20Binary/2016-07-11-binary-octave-4.0.3/octave_gui_403_appleblas.dmg/download download Octave 4.0.3 with graphical user interface]  (OS X 10.9+),
  
All [https://en.wikipedia.org/wiki/Package_manager package managers] below are given in alphabetical order.  The Octave developers do not recommend a certain package manager.
+
To compile and create the application bundle yourself, see the instructions on [[Create_a_MacOS_X_App_Bundle_Using_Homebrew|how to create the bundle using Homebrew]]. (See instructions on [[Create_a_MacOS_X_App_Bundle_Using_MacPorts|how to create a bundle using Macports]] for reference, but this approach is not currently being used.)
  
=== Anaconda ===
+
==Octave server VM installer for OSX 10.10 Yosemite and OS X 10.11 El Capitan==
 +
[http://deepneural.blogspot.fr/p/welcome.html Configuration files] that cause Vagrant to automatically download and configure an Octave server VM under OS X including 10.10 Yosemite. The install process pulls down the latest stable Linux version of Octave at the time of installation. All software used in running this server VM is open source (Vagrant, VirtualBox, Octave). The Octave server will run headless, and display the Octave GUI and graphics on the host via the Mac's native X-windows server. The recommended configuration ensures that by default user files written by the GUI are in a folder shared with the Mac's filesystem, and the VM suspends automatically when the user quits the GUI. Any edited files then persist in the Mac's shared folder.
  
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''
+
==Binary installer for OSX 10.9.1==
  
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].
+
A [http://sourceforge.net/projects/octave/files/Octave%20MacOSX%20Binary/2013-12-30%20binary%20installer%20of%20Octave%203.8.0%20for%20OSX%2010.9.1%20%28beta%29/ binary installer] for Mavericks can be found on Octave Forge.
  
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
+
This installer will install all binaries for GNU Octave 3.8.0 itself and its dependencies under
  
   conda create --name octave
+
   /usr/local/octave/3.8.0
  conda activate octave
 
  conda install -c conda-forge octave
 
 
 
  octave --gui
 
  
=== Homebrew ===
+
And will create two entries in the Applications folder
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''
 
  
'''Install GNU Octave using Homebrew:'''
+
/Applications/Octave-cli.app
 +
/Applications/Octave-gui.app
  
Follow the [https://brew.sh/ Homebrew installation instructions].
+
Which will start Octave in CLI and GUI mode respectively, these are just small wrappers containing a startup script and an icon to allow launching Octave from the Finder.  
  
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
+
If you wish to uninstall GNU Octave 3.8.0 and all other software installed by this installer you can simply move the three folders listed above to the Trash. Notice that you will need to authenticate with an administrator password to be allowed to do so.
  
  brew update
+
You may need to override Gatekeeper to allow installation. You may find instructions about how to do this on [http://support.apple.com/kb/ht5290 this page] in the section labeled "How to open an app from a unidentified developer and exempt it from Gatekeeper".
  brew upgrade
 
  brew install octave
 
 
 
  octave --gui
 
  
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].
+
In short:  
  
=== MacPorts ===
+
* In Finder, Control-click or right click the icon of the app.
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''
+
* Select Open from the top of contextual menu that appears.  
 +
* Click Open in the dialog box. If prompted, enter an administrator name and password.  
  
Follow the [https://www.macports.org/install.php MacPorts installation instructions].
+
This installer is known to work on OSX 10.9.1, you may try, at your own risk, to use it for installing on other system versions but it is not guaranteed to work.
  
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
+
==Manual Installation from Source==
  
  sudo port selfupdate
+
The page [[Octave for Mac]] provides minimalistic instructions for building Octave from source on Mac OS X. Additional [http://www.gnu.org/software/octave/support.html support] for those who need assistance in building Octave is available.
  sudo port upgrade outdated
 
  sudo port install octave
 
 
 
  octave --gui
 
  
===Spack===
+
==Package Managers==
→ ''Link to [https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/octave/package.py Octave package] there.''
 
  
To install the '''Command Line Tools''' type in the [https://support.apple.com/guide/terminal/welcome/mac Terminal App]:
+
A package manager is a software tool to automate the process of installing, upgrading, configuring, and removing software packages for a computer's operating system in a consistent manner. It typically maintains a database of software dependencies and version information to prevent software mismatches and missing prerequisites.
 +
Packages are distributions of software, applications and data. Packages also contain metadata, such as the software's name, description of its purpose, version number, vendor, checksums, and a list of dependencies necessary for the software to run properly. Upon installation, metadata is stored in a local package database.
 +
Operating systems based on Linux and other Unix-like systems typically consist of hundreds or even thousands of distinct software packages; in the former case, a package management system is a convenience, in the latter case it becomes essential.
  
  sudo xcode-select --install
+
There are three reputable package managers available for Mac OS X. GNU Octave for Mac OS X is readily available using [http://en.wikipedia.org/wiki/Package_management_system package managers] such as [http://www.finkproject.org/ Fink], [http://www.macports.org/ MacPorts], and [http://brew.sh/ Homebrew].
  
Follow the [https://spack-tutorial.readthedocs.io/en/latest/tutorial_basics.html Spack tutorial] and type in the Terminal App:
+
The most recent version of Fink's Octave package, MacPorts' Octave port, and Homebrew's Octave formula are generally not the same. Please check the web sites for these package managers to determine if the version of Octave you desire is available.
  
  spack install octave
+
===Xcode Dependency===
  spack load octave
 
 
 
  octave --gui
 
  
{{Note|The entire installation process can '''take up to a few hours'''. Octave has many dependencies which will be downloaded and installed prior to Octave.}}
+
Each package manager requires that Xcode be installed. In part this is to provide an initial set of development tools. It *may* be possible to substitute the [https://github.com/kennethreitz/osx-gcc-installer Mac OS X gcc Installer] by Kenneth Reitz, but this alternative has not yet been tested. If any curious/industrious users experiment with using Kenneth's solution over Apple's Xcode, please let Octave's developers know of the results. Or, if you prefer, just update the itemized list below. It is recommended that users with Xcode already installed avoid installing Kenneth's solution, as it may break your existing Xcode installation.
 +
* Fink: The Mac OS X gcc Installer has not been tested.
 +
* MacPorts: The Mac OS X gcc Installer has not been tested.
 +
* Homebrew: The Mac OS X gcc Installer has not been tested.
  
In case of trouble, please visit the [https://github.com/spack/spack/issues Spack repo issues list], and browse through Octave related issues by writing <code>is:issue octave</code> in the filters box.
+
===Fink===
  
== Create a launcher app with the Script Editor ==
+
[http://www.finkproject.org/ The Fink project] is an effort to port and package open-source Unix programs to Mac OS X. Fink uses [http://en.wikipedia.org/wiki/Dpkg dpkg] and [http://en.wikipedia.org/wiki/Advanced_Packaging_Tool APT] ([http://en.wikipedia.org/wiki/Debian Debian's] package management system), as well as its own frontend program, fink (which is implemented as a set of [http://en.wikipedia.org/wiki/Perl_module Perl modules]).
  
For example Homebrew installs Octave to {{Path|/usr/local/bin/octave}} by default.  From the [https://support.apple.com/guide/terminal/open-or-quit-terminal-apd5265185d-f365-44cb-8b09-71a064a42125/mac Terminal] application you can enter the command <code>which octave</code> to find out the exact location.
+
====Simple Installation Instructions====
  
If you know the installation location, open the [https://support.apple.com/guide/script-editor Script Editor] application and write the following text in the editor window:
+
*Install Xcode via the Mac App Store.
 +
** Once installed, install the Command Line Tools from Xcode's Apple Menu > Preferences > Downloads on 10.7 or 10.8, and use {{Codeline|<nowiki>sudo xcode-select --install</nowiki>}} on 10.9 or 10.10 .
 +
*Follow [http://www.finkproject.org/download/srcdist.php Fink's installation instructions]. For OS X 10.8-10.10, enabling the binary distribution during the initial setup will save you a lot of build time.  For those who prefer it, there is a GUI available for Fink, [http://finkcommander.sourceforge.net Fink Commander].
 +
*Fink has excellent support for Octave and includes recent as well as dated versions. A list of what Fink has available for Octave is [http://pdb.finkproject.org/pdb/browse.php?summary=octave here]. To install the latest Octave with GUI support, type {{Codeline|<nowiki>fink install octave-qtmac</nowiki>}} or {{Codeline|<nowiki>fink install octave-qtx11</nowiki>}} at the Terminal's command line.  For those running the 64 bit version of Fink, it is recommended that {{Codeline|octave-atlas-qtmac}} or {{Codeline|octave-atlas-qtx11}} be installed instead as there are some bugs/features with Apple's vecLib for the X86_64 architecture.  Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take many hours.
 +
* Fink should also be used to install [[http://octave.sourceforge.net/packages.php packages] for Octave.  For example, the control systems package  may be installed by typing {{Codeline|fink install control-atlas-oct382}} at a terminals command line.
  
do shell script "/usr/local/bin/octave --gui"
+
For the {{Codeline|doc()}} function to be supported by Octave, either the unversioned {{Codeline|octave}}, {{Codeline|octave-atlas}}, or {{Codeline|octave-ref}} package must be installed. Essentially, those features used at run-time which don't have a version somewhere in the file path are included in these packages.
  
if you wish to start the Octave GUI by default.  If you want to start the Octave command-line interface (CLI), enter instead:
+
===MacPorts===
 +
 
 +
[http://www.macports.org/ MacPorts], formerly called DarwinPorts, is a package management system that simplifies the installation of software on the Mac OS X and Darwin operating systems. It is a free/open source software project to simplify installation of other free/open source software. Similar in aim and function to Fink and the BSDs' ports collections, DarwinPorts was started in 2002 as part of the OpenDarwin project, with the involvement of a number of Apple Inc. employees including Landon Fuller, Kevin Van Vechten, and Jordan Hubbard.
 +
 
 +
Following instructions are made for MacPorts 2.3.4 on '''Mac OS X 10.11 (El Capitan)''' and '''GNU Octave 4.0.3''' in the first place:
 +
 
 +
====MacPorts Installation====
 +
You have to install MacPorts prior to the Octave installation anyway.
 +
*Install "Xcode" via the Mac App Store and the "Xcode Command Line Tools" as described at [http://guide.macports.org/#installing.xcode MacPorts' installation instructions].
 +
*Install the appropriate [https://www.macports.org/install.php MacPorts version] for your OS X version. If you had installed Mac Ports in the past already, update it first by typing {{Codeline|sudo port selfupdate}} and {{Codeline|sudo port upgrade outdated}} in the terminal.
 +
 
 +
====Basic Installation Instructions====
 +
*Now an Octave installation should work with {{Codeline|sudo port install octave}} out-of-the-box but for some reasons the next lines are worth reading.
 +
*If you decide to do the custom Octave installation ignore the point above and go to the next chapter. The custom installation will consume more (compilation) time. The basic installation may work for the most users.
 +
 
 +
====Custom Installation Instructions====
 +
For best performance, variability and reliability the custom installation is suggested.
 +
 
 +
'''Preliminary Port Installations'''
 +
*The new Octave 4 port relies on the accelerator variant. Unfortunately this variant is known for some problems (see below). A better alternative is the "atlas" port, it is necessary to build it with the here specified variant prior to the Octave port installation: {{Codeline|sudo port install atlas +gcc5}}. This can last for many hours. Do this overnight. If a prior atlas installation failed, do {{Codeline|sudo port clean atlas}} before reinstallation.
 +
*Octave depends on arpack, too. Unfortunately arpack is installed with the ''accelerate'' variant by default. The ''accelerate'' variant uses Apple's Vector Libraries which have some known bugs that can cause Octave to crash if using certain functions in arpack. To avoid this install arpack with the ''atlas'' variant instead of the ''accelerate'' variant {{Codeline|sudo port install arpack -accelerate+atlas}}. You can even do this after you installed Octave. The new variant become active by default.
 +
 
 +
'''Octave Installation'''
 +
*MacPorts has good support for Octave. A list of what MacPorts has available for Octave is [http://www.macports.org/ports.php?by=name&substr=octave here]. To install the most recent version of Octave, type {{Codeline|sudo port install octave -accelerate+atlas}} at the Terminal's command line. Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take some time.
 +
*Note that {{Codeline|octave-devel}} has been replaced by {{Codeline|octave}}, see [https://trac.macports.org/changeset/114034 MacPorts Revision 114034].
 +
*The variant installed may be important to the user's experience.  The available variants for  {{Codeline|octave}} are displayed by typing {{Codeline|port variants octave}}In MacPorts 2.3.4 the variants ''accelerate'', ''app'', ''docs'', ''fltk'', ''gfortran'', ''graphicsmagic'', ''qt4gui'' and ''sound'' are installed by default (marked with '+' sign in {{Codeline|port variants octave}} output). If you need Java support add the new Java variant (+java). A installed Java JRE is mandatory. Go To the Oracle [https://www.java.com/ Java website] for Download. The following command works fine: {{Codeline|sudo port install octave -accelerate+atlas+java}}
 +
*<s>If Octave crashes when plotting use the Gnuplot graphic toolkit instead of FLTK. Type {{Codeline|graphics_toolkit('gnuplot')}} in Octave before plotting. For using the nicer wxt-terminal of Gnuplot, type {{Codeline|setenv("GNUTERM","wxt")}} in Octave. To make this the standard behavior append both commands in one of Octave's startup files e.g. your {{Codeline|~/.octaverc}}. To close the graphic window of gnuplot use the Octave command {{Codeline|close()}} to get rid of the Gnuplot instance instead of using the close button of the window.</s>
 +
*The first plot after startuing Octave 4 can last a while.
 +
 
 +
====Detailed Installation Instructions====
 +
To get detailed instructions from start to end on one page, refer [http://blog.hani-ibrahim.de/en/octave4-mac-os-x-el-capitan-install.html Hani's Omnium Gatherum].
 +
 
 +
====Update problems====
 +
If an update fails you may chosen incompatible variants in a prior installation. See [http://blog.hani-ibrahim.de/en/octave4-upgrade-via-macports.html Octave 4 upgrade via MacPorts fails after “port upgrade outdated”] for details
 +
 
 +
===Homebrew===
 +
 
 +
Homebrew is a package management system that simplifies the installation of software on Mac OS X. It is a free/open source software project to simplify installation of other free/open source software. It is similar in aim and function to MacPorts and Fink. It was written by Max Howell and has gained popularity in the Ruby on Rails community and earned praise for its extensibility.
 +
 
 +
====Simple Installation Instructions====
 +
 
 +
First, install Homebrew:
 +
*Install Xcode via the Mac App Store.
 +
** For Mac OS 10.9 (Mavericks) install the command line tools by {{Codeline|xcode-select --install}}.
 +
** For earlier versions of Mac OS, install the command line tools from Xcode's Apple Menu > Preferences > Downloads.
 +
*Follow [https://github.com/mxcl/homebrew/wiki/installation Homebrew's installation instructions].
 +
* If running Mountain Lion (Mac OS 10.8) or later, install [https://xquartz.macosforge.org/landing/ XQuartz].
 +
* Import the scientific computing packages, including Octave:
 +
<pre>brew tap homebrew/science</pre>
 +
 
 +
To install Octave, update to the latest package definitions, install {{Codeline|gfortran}} (Now you don't need to install it manually, it would be installed by dependency), and then Octave:
 +
<pre>brew update && brew upgrade
 +
brew install octave</pre>
 +
This would install octave with the default dependencies. Note that the default dependencies include java runtime environment. If you do not have java installed, homebrew would guide you to do that. Or you can type {{Codeline|brew install octave --without-java}} to remove its dependency on java.
 +
 
 +
Note: If brew complains about not having a formula for octave, the following command should fix it:
 +
<pre>brew tap --repair</pre>
 +
 
 +
The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:
 +
<pre>brew update && brew upgrade</pre>
 +
 
 +
Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours, but precompiled binary packages called 'bottles' are available with default options for Octave and many of its dependencies.
 +
 
 +
Octave has an experimental built-in GUI (developed using Qt lib) installed by default so that gnuplot and other tools could use it directly. Gnuplot will build with Qt support if Octave's Qt-based GUI is enabled. You do not need to install an X server in most situations. Note: On Snow Leopard, Octave requires an X server. If you install without, Homebrew will guide you to the XQuartz project (https://xquartz.macosforge.org) where you can download this.
 +
 
 +
You might find that you need to add:
 +
 
 +
<pre>setenv ("GNUTERM", "X11")</pre>
 +
 
 +
to your octaverc file, normally located at {{Codeline|/usr/local/share/octave/site/m/startup}}. See also {{Codeline|brew info octave}} for recommended settings.
 +
 
 +
In case of trouble, see the [https://github.com/mxcl/homebrew/wiki/troubleshooting Homebrew Troubleshooting Guide], which assists in diagnosing problems and craft useful bug reports.  The [http://jatinganhotra.com/blog/2014/01/21/installing-octave-on-os-x-10-dot-9-mavericks/ post by Jatin Ganhotra] may also be helpful. Bugs may be reported at [https://github.com/Homebrew/homebrew-science/issues?state=open Homebrew-science's issue tracker].
 +
 
 +
====Using Aquaterm with Gnuplot====
 +
When using {{Codeline|gnuplot}} as the graphics toolkit, if the {{Codeline|aqua}} terminal is not supported by {{Codeline|gnuplot}}, follow the steps below to resolve the problem.
 +
 
 +
*Uninstall {{Codeline|gnuplot}}
 +
<pre>brew uninstall gnuplot</pre>
 +
*Install [http://aquaterm.sourceforge.net Aquaterm]
 +
*Install {{Codeline|gnuplot}}
 +
<pre>brew install gnuplot --with-aquaterm --with-qt4</pre>
 +
 
 +
==Create a launcher app with AppleScript==
 +
 
 +
* Open the "AppleScript Editor" application
 +
* write the following text in the editor window:
  
 
  tell application "Terminal"
 
  tell application "Terminal"
   do script "/usr/local/bin/octave; exit"
+
   do script "/path/to/octave; exit"
 
  end tell
 
  end tell
  
Line 99: Line 179:
 
  end tell
 
  end tell
  
Finally:
+
or if you wish to start the GUI by default, without a terminal:
* With a script open in the Script Editor app  on your Mac, choose "File > Export".
 
* In the menu that appears, select "Application" from the "File format" menu, then navigate to the "Applications" folder and save your script there as "Octave.app"
 
  
To change the application icon:
+
do shell script "/path/to/octave --force-gui"
* Open [[:File:Icon.png|this link]] in a web browser, right-click and select "copy image".
 
* Select "Octave.app" in the Finder, then press {{Key|command-i}} to bring up the file info dialog.
 
* In the file info dialog, select the icon (in the top left) and press {{Key|command-v}} to paste the Octave icon over it.
 
  
== See also ==
+
(e.g. Homebrew installs Octave to '/usr/local/bin/octave' by default)
  
* [[Octave for macOS (outdated)]] contains old installation instructions.
+
* Select "Save as ..." from the "File" menu
 +
* In the menu that appears, select "Application" from the "File format" menu, then navigate to the "Applications" folder and save your script there as "Octave.app"
  
== Footnotes ==
+
To change the application icon
  
<references/>
+
* Open [http://wiki.octave.org/File:Icon.png this link] in a web browser, right-click and select "copy image".
 +
* Select "Octave.app" in the Finder, then press command-i to bring up the file info dialog.
 +
* In the file info dialog, select the icon (in the top left) and press command-v to paste the Octave icon over it.
  
 
[[Category:Installation]]
 
[[Category:Installation]]
 
[[Category:Macintosh platform]]
 
[[Category:Macintosh platform]]

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)