Octave for macOS: Difference between revisions

From Octave
Jump to navigation Jump to search
(Updated install instructions)
(brew install svn not needed to run Octave on macOS installed via Homebrew.)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
On macOS systems GNU Octave can be installed by:
For the latest version of GNU Octave there are currently '''no''' installer files (e.g. DMG installer) available.
# macOS App Bundles '''"Octave.app"''' (a single [https://en.wikipedia.org/wiki/Apple_Disk_Image dmg-file])
 
# macOS [[#Package Managers|package managers]].
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).  


{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}
{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}


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


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).
'''Install GNU Octave using Homebrew:'''
* [https://github.com/octave-app/octave-app/releases Download installer from GitHub]


A '''very old''' installer is hosted on SourceForge.
Follow the [https://brew.sh/ Homebrew installation instructions].
* [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 ==
It is advised to install the '''Command Line Tools''' type in the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] before Homebrew:


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.
  sudo xcode-select --install
 
=== Anaconda ===
 
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''
 
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].
 
In the [https://support.apple.com/guide/terminal/welcome/mac 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 <code>--gui</code> 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 [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.
=== Homebrew ===
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''


'''Install GNU Octave using Homebrew:'''
A window will pop out to guide the installation.


Follow the [https://brew.sh/ Homebrew installation instructions].
Then, come back to the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
 
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:


   brew update
   brew update
   brew upgrade
   brew upgrade
  brew install svn
   brew install octave
   brew install octave
    
    
Line 54: Line 28:
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].


=== MacPorts ===
To start the Octave GUI without typing commands in Terminal every time, please create a launcher app with the Script Editor as described below.
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''


Follow the [https://www.macports.org/install.php MacPorts installation instructions].
== Create a launcher app with the Script Editor ==


In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
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.


  sudo port selfupdate
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:
  sudo port upgrade outdated
  sudo port install octave
 
  octave --gui


===Spack===
do shell script "/usr/local/bin/octave --gui"
→ ''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]:
 
  sudo xcode-select --install
 
Follow the [https://spack-tutorial.readthedocs.io/en/latest/tutorial_basics.html Spack tutorial] and type in the Terminal App:
 
  spack install octave
  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.}}
For Apple Silicon based systems, use the following script:


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.
do shell script "/opt/homebrew/bin/octave --gui"


== Create a launcher app with the Script Editor ==
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.


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.
If you want to start the Octave command-line interface (CLI), enter instead:
 
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:
 
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"
  tell application "Terminal"
Line 106: Line 57:


Finally:
Finally:
* With a script open in the Script Editor app on your Mac, choose "File > Export".
* 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"
* 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"


Line 113: Line 64:
* 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 {{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.
* In the file info dialog, select the icon (in the top left) and press {{Key|command-v}} to paste the Octave icon over it.
== Alternative Package Managers ==
''Instead of Homebrew, the following package managers can be used to install Octave on macOS:
=== Anaconda ===
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].
In the [https://support.apple.com/guide/terminal/welcome/mac 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 <code>--gui</code> 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 [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.
=== MacPorts ===
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''
Follow the [https://www.macports.org/install.php MacPorts installation instructions].
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
  sudo port selfupdate
  sudo port upgrade outdated
  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]