Editing Octave for macOS

GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems. 
GNU Octave for macOS 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], [https://spack.readthedocs.io/ Spack] and [http://mxcl.github.com/homebrew/ Homebrew]. An unofficial native macOS "Octave.app" distribution of GNU Octave is also available as either [http://octave-app.org/ a dmg or Homebrew cask].

About version numbers (as of December 2018):

*The 4.4.x are current releases.
*The 4.2.x are previous releases.
*The 4.0.x or earlier are very old releases.

==Installing a macOS App Bundle==

Good progress has been made on creating a reliable App bundle for Octave on macOS. Approaches using [http://www.macports.org MacPorts] and [http://brew.sh Homebrew] have been considered. The [http://octave-app.org/ Octave.app project] provides an unofficial ready-to-use macOS app bundle installer based on Homebrew.

* [https://octave-app.org/Developer-Downloads.html macOS App Bundle of Octave 5.1.0 Beta (with GUI)]
* [https://octave-app.org/Download.html macOS App Bundle of Octave 4.4.x (with GUI)]
* [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+)

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.)

==Octave 4.2.2 VM installer for Mac OS X 10.10 Yosemite, 10.11 El Capitan, 10.12 Sierra, 10.13 High Sierra==
[http://deepneural.blogspot.fr/p/welcome.html Point and click configuration files] that cause Vagrant to automatically download and configure an Octave 4.2.2 server VM under OS X including 10.10 Yosemite, 10.11 El Capitan, 10.12 Sierra and 10.13 High Sierra. The install process pulls down Octave 4.2.2 from the repository. All software used in running this server VM is open source (Vagrant, VirtualBox, Octave). The Octave GUI and graphics will display seamlessly on the Mac via the Mac's native X-windows server, while the server runs headless. 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.

==Binary installer for OS X 10.9.1==

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.

This installer will install all binaries for GNU Octave 3.8.0 itself and its dependencies under 

  /usr/local/octave/3.8.0 

And will create two entries in the Applications folder 

 /Applications/Octave-cli.app 
 /Applications/Octave-gui.app 

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. 

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.

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". 

In short: 

* In Finder, Control-click or right click the icon of the app. 
* Select Open from the top of contextual menu that appears. 
* Click Open in the dialog box. If prompted, enter an administrator name and password. 

This installer is known to work on OS X 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.

==Manual Installation from Source==

The page [[Octave for Mac]] provides minimalistic instructions for building Octave from source on macOS. Additional [http://www.gnu.org/software/octave/support.html support] for those who need assistance in building Octave is available.

==Package Managers==

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.

There are three reputable package managers available for macOS. GNU Octave for macOS 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].

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.

===Xcode Dependency===

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 macOS gcc Installer has not been tested.
* MacPorts: The macOS gcc Installer has not been tested.
* Homebrew: The macOS gcc Installer has not been tested.

===Fink===

[http://www.finkproject.org/ The Fink project] is an effort to port and package open-source Unix programs to macOS. 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]).

====Simple Installation Instructions====

*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.

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.

===MacPorts===

[http://www.macports.org/ MacPorts], formerly called DarwinPorts, is a package management system that simplifies the installation of software on the macOS 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 macOS. 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.
** Install the command line tools by {{Codeline|xcode-select --install}}.
*Follow [https://brew.sh/ Homebrew's installation instructions].

To install Octave, update to the latest package definitions with {{Codeline|brew update}}, and then install Octave.

First we ensure brew itself has the latest definitions:
<pre>brew update</pre>

Then, we install Octave:
<pre>brew install octave</pre>

The default charting package in Octave is straight qt. However, on the Mac gnuplot often works better. To switch to gnuplot, place the following text in your ~/.octaverc file:
<pre>setenv('GNUTERM','qt')
graphics_toolkit("gnuplot")</pre>

Note: If brew complains about:
<pre>
Linking /usr/local/Cellar/ghostscript/9.14...
Error: Could not symlink share/ghostscript/Resource
/usr/local/share/ghostscript is not writable.
</pre>
This is telling you the user permissions for ghostscript are not setup in a way that your user profile can use. You need to change those permissions to your user profile.
The following command will repair the issue:
<pre>
sudo chown -R `whoami` /usr/local/share/ghostscript
brew link --overwrite ghostscript
</pre>
Then run the brew install command again for octave.

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 octave</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 a built-in GUI (developed using Qt lib) installed by default so that gnuplot and other tools can use it directly. This GUI is always installed when installing Octave using Homebrew.

In case of trouble, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide], which assists in diagnosing problems and craft useful bug reports. Bugs may be reported at [https://github.com/Homebrew/homebrew-core/issues Homebrew-core's issue tracker].

===Spack===

Spack is a package management tool that supports the installation of multiple versions of software on macOS and other operating systems. It is a free/open source software project to simplify installation of other software. It is similar in aim and function to MacPorts and Homebrew. It was created by Todd Gamblin and is currently being updated and developed by a large list of contributors (mainly via GitHub).

====Simple Installation Instructions====

First, install Spack:
*Install Xcode via the Mac App Store.
** Install the command line tools by {{Codeline|xcode-select --install}}.
*Follow [https://spack-tutorial.readthedocs.io/en/latest/ Spack tutorial].

To install Octave, first we ensure that Spack itself has the latest definitions, by going to the local Spack repository (develop branch) folder and running the command:
<pre>git pull</pre>

Then, we install the latest version of Octave:
<pre>spack install octave</pre>

To use Octave we need to first load the package:
<pre>spack load octave</pre>

Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take up to a few hours.

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 in the filters box:
<pre>is:issue octave</pre>

==Create a launcher app with AppleScript==

* Open the "AppleScript Editor" application
* write the following text in the editor window:

 tell application "Terminal"
  do script "/path/to/octave; exit"
 end tell

or if Octave is in your default path:

 tell application "Terminal"
  do script "`which octave`; exit"
 end tell

or if you wish to start the GUI by default, without a terminal:

 do shell script "/path/to/octave --force-gui"

(e.g. Homebrew installs Octave to '/usr/local/bin/octave' by default)

* 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"

To change the application icon 

* 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:Macintosh platform]]