Octave for macOS: Difference between revisions

From Octave
Jump to navigation Jump to search
m (→‎MacPorts: No extra subsection.)
(brew install svn not needed to run Octave on macOS installed via Homebrew.)
 
(65 intermediate revisions by 8 users not shown)
Line 1: Line 1:
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems.
For the latest version of GNU Octave there are currently '''no''' installer files (e.g. DMG installer) available.
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):
However, using the [https://brew.sh/ Homebrew package manager], one can simply install and update Octave on macOS for all latest Apple Silicon architectures (M1 and newer).


*The 4.4.x are current releases.
{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}
*The 4.2.x are previous releases.
*The 4.0.x or earlier are very old releases.


==Installing a macOS App Bundle==
== Homebrew ==
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''


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.
'''Install GNU Octave using Homebrew:'''


* [https://octave-app.org/Developer-Downloads.html macOS App Bundle of Octave 5.1.0 Beta (with GUI)]
Follow the [https://brew.sh/ Homebrew installation instructions].
* [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.)
It is advised to install the '''Command Line Tools''' type in the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] before Homebrew:


==Package Managers==
  sudo xcode-select --install


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.
A window will pop out to guide the installation.
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].
Then, come back to 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.
  brew update
  brew upgrade
  brew install octave
 
  octave --gui


===Xcode Dependency===
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].


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 start the Octave GUI without typing commands in Terminal every time, please create a launcher app with the Script Editor as described below.
* 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===
== 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 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]).
For example Homebrew installs Octave to {{Path|/usr/local/bin/octave}} (or {{Path|/opt/homebrew/bin/octave}} on Apple Silicon) 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 if you wish to start the Octave GUI by default:


*Install Xcode via the Mac App Store.
  do shell script "/usr/local/bin/octave --gui"
** 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.
For Apple Silicon based systems, use the following script:


=== MacPorts ===
do shell script "/opt/homebrew/bin/octave --gui"


[http://www.macports.org/ MacPorts], formerly called DarwinPorts, is a is a free and open-source package management system that simplifies the installation of software on the macOS and Darwin operating systems. It is 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.
Then, in Script Editor, select File>Export. Export As: Octave (or whatever the non-conflicted name you want); File Format: Application (so that it can be run by Finder); Options: Run only; Code sign: Sign to run locally (to avoid annoying asking for permission to access folder each time). Then, you can find and run the GUI application in the Finder.


'''Install GNU Octave using MacPorts:'''
If you want to start the Octave command-line interface (CLI), enter instead:


* Follow the instruction given at the [https://www.macports.org/install.php MacPorts website].
tell application "Terminal"
* Update your installation by running {{Codeline|sudo port selfupdate}} and {{Codeline|sudo port upgrade outdated}} in the terminal.
  do script "/usr/local/bin/octave; exit"
* Run {{Codeline|sudo port install octave}}.
end tell


===Homebrew===
or if Octave is in your default path:


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.
tell application "Terminal"
  do script "`which octave`; exit"
end tell


====Simple Installation Instructions====
Finally:
* With the 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"


First, install Homebrew:
To change the application icon:
*Install Xcode via the Mac App Store.
* Open [[:File:Icon.png|this link]] in a web browser, right-click and select "copy image".
** Install the command line tools by {{Codeline|xcode-select --install}}.
* Select "Octave.app" in the Finder, then press {{Key|command-i}} to bring up the file info dialog.
*Follow [https://brew.sh/ Homebrew's installation instructions].
* In the file info dialog, select the icon (in the top left) and press {{Key|command-v}} to paste the Octave icon over it.


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


First we ensure brew itself has the latest definitions:
''Instead of Homebrew, the following package managers can be used to install Octave on macOS:
<pre>brew update</pre>


Then, we install Octave
=== Anaconda ===
<ref>Homebrew has updated some of its scripts. To install Octave as of May 14, 2020, provide the migrated full path by running <code>brew install homebrew/core/octave</code> instead. [Citation needed!]</ref>:
<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:
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''
<pre>setenv('GNUTERM','qt')
graphics_toolkit("gnuplot")</pre>


Note: If brew complains about:
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].
<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:
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
<pre>brew tap --repair</pre>


The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:
  conda create --name octave
<pre>brew update && brew upgrade octave</pre>
  conda activate octave
  conda install -c conda-forge octave
 
  octave --gui


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.
'''Note that the use of the option <code>--gui</code> shown above is actually unsupported in the context shown''' (as of 2023 March 31). Expect failure:


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.
  octave: GUI features missing or disabled in this build


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].
Please refer to Octave contributor [https://github.com/conda-forge/octave-feedstock/issues/102#issuecomment-1598020613 ngam's response] to [https://github.com/conda-forge/octave-feedstock/issues/102 issue #102 at conda-forge/octave-feedstock]. This note is put here to prevent further user frustration. The original author of this wiki page seems to be unaware of this problem and cannot be located to address this discrepant instruction.


===Spack===
=== MacPorts ===
 
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''
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
Follow the [https://www.macports.org/install.php MacPorts installation instructions].
* 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
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:


* Open [http://wiki.octave.org/File:Icon.png this link] in a web browser, right-click and select "copy image".
  sudo port selfupdate
* Select "Octave.app" in the Finder, then press command-i to bring up the file info dialog.
  sudo port upgrade outdated
* In the file info dialog, select the icon (in the top left) and press command-v to paste the Octave icon over it.
  sudo port install octave
 
  octave --gui


== See also ==
== See also ==

Latest revision as of 00:21, 9 November 2023

For the latest version of GNU Octave there are currently no installer files (e.g. DMG installer) available.

However, using the Homebrew package manager, one can simply install and update Octave on macOS for all latest Apple Silicon architectures (M1 and newer).

Info icon.svg
GNU Octave 9.1.0 is the current stable release.

Homebrew[edit]

Link to Octave package there.

Install GNU Octave using Homebrew:

Follow the Homebrew installation instructions.

It is advised to install the Command Line Tools type in the Terminal App before Homebrew:

 sudo xcode-select --install

A window will pop out to guide the installation.

Then, come back to 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.

To start the Octave GUI without typing commands in Terminal every time, please create a launcher app with the Script Editor as described below.

Create a launcher app with the Script Editor[edit]

For example Homebrew installs Octave to /usr/local/bin/octave (or /opt/homebrew/bin/octave on Apple Silicon) 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 if you wish to start the Octave GUI by default:

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

For Apple Silicon based systems, use the following script:

do shell script "/opt/homebrew/bin/octave --gui"

Then, in Script Editor, select File>Export. Export As: Octave (or whatever the non-conflicted name you want); File Format: Application (so that it can be run by Finder); Options: Run only; Code sign: Sign to run locally (to avoid annoying asking for permission to access folder each time). Then, you can find and run the GUI application in the Finder.

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

Alternative Package Managers[edit]

Instead of Homebrew, the following package managers can be used to install Octave on macOS:

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

Note that the use of the option --gui shown above is actually unsupported in the context shown (as of 2023 March 31). Expect failure:

 octave: GUI features missing or disabled in this build

Please refer to Octave contributor ngam's response to issue #102 at conda-forge/octave-feedstock. This note is put here to prevent further user frustration. The original author of this wiki page seems to be unaware of this problem and cannot be located to address this discrepant instruction.

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

See also[edit]

Footnotes[edit]