Difference between revisions of "Octave for macOS"

From Octave
Jump to navigation Jump to search
m
 
(127 intermediate revisions by 31 users not shown)
Line 1: Line 1:
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems.
+
On macOS systems GNU Octave can be installed by:
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 App Bundles '''"Octave.app"''' (a single [https://en.wikipedia.org/wiki/Apple_Disk_Image dmg-file])
 +
# macOS [[#Package Managers|package managers]].
  
About version numbers (as of January 2014):
+
{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}
  
*The 3.8.x are current releases.
+
== macOS App Bundles ==
*The 3.6.x are previous releases.
 
*The 3.4.x are very old releases.
 
  
==Octave server VM installer for OSX 10.10 Yosemite==
+
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).
[http://deepneural.blogspot.fr/p/instructions-1_10.html Instructions and 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 by default run headless, and display the Octave GUI and graphics on the host via the Mac's native X-windows server.
+
* [https://github.com/octave-app/octave-app/releases Download installer from GitHub]
  
==Binary installer for OSX 10.9.1==
+
A '''very old''' installer is hosted on SourceForge.
 +
* [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+)
  
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.
+
== Package Managers ==
  
This installer will install all binaries for GNU Octave 3.8.0 itself and its dependencies under
+
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.
  
  /usr/local/octave/3.8.0
+
=== Anaconda ===
  
And will create two entries in the Applications folder
+
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''
  
/Applications/Octave-cli.app
+
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].
/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.  
+
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.
+
  conda create --name octave
 +
  conda activate octave
 +
  conda install -c conda-forge octave
 +
 
 +
  octave --gui
  
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".  
+
=== Homebrew ===
 +
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''
  
In short:  
+
'''Install GNU Octave using Homebrew:'''
  
* In Finder, Control-click or right click the icon of the app.
+
Follow the [https://brew.sh/ Homebrew installation instructions].
* 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 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==
+
  brew update
 +
  brew upgrade
 +
  brew install octave
 +
 
 +
  octave --gui
  
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.
+
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].
  
==Package Managers==
+
=== MacPorts ===
 +
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''
  
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.
+
Follow the [https://www.macports.org/install.php MacPorts installation instructions].
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 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].
+
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
  
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.
+
  sudo port selfupdate
 +
  sudo port upgrade outdated
 +
  sudo port install octave
 +
 
 +
  octave --gui
  
===XCode Dependency===
+
===Spack===
 +
→ ''Link to [https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/octave/package.py Octave package] there.''
  
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.
+
To install the '''Command Line Tools''' type in the [https://support.apple.com/guide/terminal/welcome/mac Terminal App]:
* 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.
 
  
===Fink===
+
  sudo xcode-select --install
  
[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]).
+
Follow the [https://spack-tutorial.readthedocs.io/en/latest/tutorial_basics.html Spack tutorial] and type in the Terminal App:
  
====Simple Installation Instructions====
+
  spack install octave
 +
  spack load octave
 +
 
 +
  octave --gui
  
*Install XCode via the Mac App Store.
+
{{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.}}
** 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.
+
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.
  
===MacPorts===
+
== Create a launcher app with the Script Editor ==
  
[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.
+
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.
+
do shell script "/usr/local/bin/octave --gui"
*Follow [http://www.macports.org/install.php MacPorts' installation instructions].
 
*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 +atlas+docs}} 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 a few hours.
 
*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-devel}}.  It is recommended that the user include {{Codeline|+atlas+docs}}.  This will avoid bugs present in Apple's vecLib and enable support for Octave's {{Codeline|doc()}} function.
 
  
===Homebrew===
+
if you wish to start the Octave GUI by default. If you want to start the Octave command-line interface (CLI), enter instead:
 
 
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.
 
By default octave does not include docs (used by `help` function) because it requires an entire LaTex environment. If you have MacTex installed (or homebrew would guide you to install it), you can add {{Codeline|--with-docs}} to the installation script:
 
<pre>brew install octave --with-docs --without-java</pre>
 
 
 
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.
 
Octave has an experimental built-in GUI (developed using Qt lib) installed by default so that gnuplot and other tools could use it directly. So you do not need to install a X server in the most situations.
 
Note: On Snow Leopard, Octave requires a 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}}.
 
 
 
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].
 
 
 
==Create a launcher app with AppleScript==
 
 
 
* Open the "AppleScript Editor" application
 
* write the following text in the editor window:
 
 
 
<code>
 
  
 
  tell application "Terminal"
 
  tell application "Terminal"
   do script "/path/to/octave; exit"
+
   do script "/usr/local/bin/octave; exit"
 
  end tell
 
  end tell
 
</code>
 
  
 
or if Octave is in your default path:
 
or if Octave is in your default path:
  
<code>
 
 
  tell application "Terminal"
 
  tell application "Terminal"
 
   do script "`which octave`; exit"
 
   do script "`which octave`; exit"
 
  end tell
 
  end tell
</code>
 
  
* Select "Save as ..." from the "File" menu
+
Finally:
 +
* 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"
 
* 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  
+
To change the application icon:
 
+
* Open [[:File:Icon.png|this link]] in a web browser, right-click and select "copy image".
* 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 {{Key|command-i}} to bring up the file info dialog.
* 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 {{Key|command-v}} to paste the Octave icon over it.
* In the file info dialog, select the icon (in the top left) and press command-v to paste the Octave icon over it.
 
  
==Installing a Mac OS X Bundle==
+
== See also ==
  
A reliable App bundle for Octave on Mac OS X is not presently available. The developers would like to be able to provide an App bundle, but need volunteers to support the effort.  An approach for producing an App Bundle using [http://www.macports.org MacPorts] is being documented [[Create_a_MacOS_X_App_Bundle_Using_MacPorts|here]].  This approach shows promise, but a few problems must be resolved before a bundle will become available.
+
* [[Octave for macOS (outdated)]] contains old installation instructions.
  
Octave and many other software packages may be installed and updated using one of the three package managers available for Mac OS X. To install using a package manager, see the section on [[Octave_for_MacOS_X#Package_Managers|Package Managers]].
+
== Footnotes ==
  
{{Warning|Octave-Forge does have [https://sourceforge.net/projects/octave/files/Octave%20MacOSX%20Binary/ App bundles] for old Octave, versions and have problems running on Mac OS 10.6 and above.  The latest App bundle does not provide full support for the printing, or the documentation features of Octave. Other features may be missing as well. For individuals who'd like to use it anyway please carefully follow the instructions for [[Installing Mac OS X Bundle]].}}
+
<references/>
  
 
[[Category:Installation]]
 
[[Category:Installation]]
 
[[Category:Macintosh platform]]
 
[[Category:Macintosh platform]]

Latest revision as of 06:26, 29 April 2022

On macOS systems GNU Octave can be installed by:

  1. macOS App Bundles "Octave.app" (a single dmg-file)
  2. macOS package managers.
Info icon.svg
GNU Octave 7.3.0 is the current stable release.

macOS App Bundles[edit]

The Octave.app project provides an unofficial ready-to-use, drag-and-drop macOS App installer based on Homebrew (see below).

A very old installer is hosted on SourceForge.

Package Managers[edit]

All package managers below are given in alphabetical order. The Octave developers do not recommend a certain package manager.

Anaconda[edit]

Link to Octave package there.

Follow the Anaconda installation instructions.

In the Terminal App type:

 conda create --name octave
 conda activate octave
 conda install -c conda-forge octave
 
 octave --gui

Homebrew[edit]

Link to Octave package there.

Install GNU Octave using Homebrew:

Follow the Homebrew installation instructions.

In the Terminal App type:

 brew update
 brew upgrade
 brew install octave
 
 octave --gui

In case of trouble try brew doctor, see the Homebrew Troubleshooting Guide.

MacPorts[edit]

Link to Octave package there.

Follow the MacPorts installation instructions.

In the Terminal App type:

 sudo port selfupdate
 sudo port upgrade outdated
 sudo port install octave
 
 octave --gui

Spack[edit]

Link to Octave package there.

To install the Command Line Tools type in the Terminal App:

 sudo xcode-select --install

Follow the Spack tutorial and type in the Terminal App:

 spack install octave
 spack load octave
 
 octave --gui
Info icon.svg
The entire installation process can take up to a few hours. Octave has many dependencies which will be downloaded and installed prior to Octave.

In case of trouble, please visit the Spack repo issues list, and browse through Octave related issues by writing is:issue octave in the filters box.

Create a launcher app with the Script Editor[edit]

For example Homebrew installs Octave to /usr/local/bin/octave by default. From the Terminal application you can enter the command which octave to find out the exact location.

If you know the installation location, open the Script Editor application and write the following text in the editor window:

do shell script "/usr/local/bin/octave --gui"

if you wish to start the Octave GUI by default. If you want to start the Octave command-line interface (CLI), enter instead:

tell application "Terminal"
 do script "/usr/local/bin/octave; exit"
end tell

or if Octave is in your default path:

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

Finally:

  • 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:

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

See also[edit]

Footnotes[edit]