Octave for macOS: Difference between revisions

Jump to navigation Jump to search
2,193 bytes removed ,  9 March 2019
Update Homebrew install instructions, removing references to obsolete X11, removed options, and out-of-support macOS versions
No edit summary
(Update Homebrew install instructions, removing references to obsolete X11, removed options, and out-of-support macOS versions)
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems.  
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems.  
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]. An unofficial native macOS "Octave.app" distribution of GNU Octave is also available as either [http://octave-app.org/ a dmg or homebrew cask].
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://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 July 2018):
About version numbers (as of December 2018):


*The 4.4.x are current releases.
*The 4.4.x are current releases.
Line 8: Line 8:
*The 4.0.x or earlier are very old releases.
*The 4.0.x or earlier are very old releases.


==Installing a Mac OS X Bundle==
==Installing a macOS App Bundle==


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


* [http://octave-app.org/ Mac OS X Bundle of Octave 4.4.0 Beta 4]
* [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 download Octave 4.0.3 with graphical user interface]  (OS X 10.9+),
* [https://octave-app.org/Developer-Downloads.html macOS App Bundle of Octave 4.4.x (with GUI) Beta releases]
* [http://octave-app.org/Download.html]
* [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+)


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.)
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.)
Alternately, the [http://octave-app.org/ Octave.app project] provides an unofficial ready-to-use macOS app bundle installer. 


==Octave 4.2.2 VM installer for Mac OS X 10.10 Yosemite, 10.11 El Capitan, 10.12 Sierra, 10.13 High Sierra==
==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.
[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 OSX 10.9.1==
==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.
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.
Line 48: Line 46:
* Click Open in the dialog box. If prompted, enter an administrator name and password.  
* Click Open in the dialog box. If prompted, enter an administrator name and password.  


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.
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==
==Manual Installation from Source==


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.
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==
==Package Managers==
Line 60: Line 58:
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.
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 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].
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.
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.
Line 67: Line 65:


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


===Fink===
===Fink===


[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]).
[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====
====Simple Installation Instructions====
Line 87: Line 85:
===MacPorts===
===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.
[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:
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:
Line 122: Line 120:
===Homebrew===
===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.
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====
====Simple Installation Instructions====
Line 128: Line 126:
First, install Homebrew:
First, install Homebrew:
*Install Xcode via the Mac App Store.
*Install Xcode via the Mac App Store.
** For Mac OS 10.9 (Mavericks) install the command line tools by {{Codeline|xcode-select --install}}.
** 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://brew.sh/ Homebrew's installation instructions].
*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].


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.
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:
First we ensure brew itself has the latest definitions:
<pre>brew update && brew upgrade</pre>
<pre>brew update</pre>


Then, we install Octave. To install only the command-line version use:
Then, we install Octave:
<pre>brew install octave</pre>
<pre>brew install octave</pre>


To install Octave with the Qt GUI, install qt then install Octave --with-qt:
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>brew install qt
brew install octave --with-qt</pre>
 
This would install octave with the default dependencies.
Note: QT may ask you to upgrade your OS (I was running 10.10 and had to upgrade to 10.14 to get it to work)
Note: The second command above also asked me to upgrade XCode to 10, which takes some time (>5GB file)
 
The default charting package in Octave is straight qt. However, on the Mac gnuplot often works better. To set up gnuplot, install (or reinstall) it with qt enabled:
<pre>brew install gnuplot --with-qt</pre>
 
Then configure Octave to use it by placing the following text in your ~/.octaverc file:
<pre>setenv('GNUTERM','qt')
<pre>setenv('GNUTERM','qt')
graphics_toolkit("gnuplot")</pre>
graphics_toolkit("gnuplot")</pre>
Line 172: Line 157:
Note: If brew complains about not having a formula for octave, the following command should fix it:
Note: If brew complains about not having a formula for octave, the following command should fix it:
<pre>brew tap --repair</pre>
<pre>brew tap --repair</pre>
Note: If brew complains about unknown or ambiguous terminal type, and its possible you have installed gnuplot before, try running:
<pre>brew reinstall gnuplot --with-qt</pre>


The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:
The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:
Line 182: Line 163:
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 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.
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.
 
Note: For older versions of iOS (e.g. SnowLeppard), 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}}
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].
<pre>brew uninstall gnuplot</pre>
*Install [http://aquaterm.sourceforge.net Aquaterm]
*Install {{Codeline|gnuplot}}
<pre>brew install gnuplot --with-aquaterm --with-qt</pre>


==Create a launcher app with AppleScript==
==Create a launcher app with AppleScript==
21

edits

Navigation menu