Octave for macOS: Difference between revisions

From Octave
Jump to navigation Jump to search
(→‎Homebrew: By own experience this warning is not true and too scary for new users and thanks to brew bottles fast (just a few minutes).)
(brew install svn not needed to run Octave on macOS installed via Homebrew.)
 
(28 intermediate revisions by 8 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 macOS App Bundle 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:


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.
  sudo xcode-select --install


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.
A window will pop out to guide the installation.


All package managers below are given in alphabetical order. The Octave developers do not recommend a certain package manager.
Then, come back to the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:


=== Homebrew ===
  brew update
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''
  brew upgrade
  brew install octave
 
  octave --gui


[https://brew.sh/ Homebrew] was written 2009 by Max Howell and has gained popularity in the Ruby on Rails community and earned praise for its extensibility.
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].


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


# Install [https://developer.apple.com/xcode/ Xcode] via the '''Mac App Store'''.
== Create a launcher app with the Script Editor ==
#* Install the '''Command Line Tools''' by [https://support.apple.com/guide/terminal/open-or-quit-terminal-apd5265185d-f365-44cb-8b09-71a064a42125/mac opening a terminal] and type <pre>sudo xcode-select --install</pre>
# Follow [https://brew.sh/ Homebrew's installation instructions].
# Ensure brew itself has the latest definitions <pre>brew update</pre>
# Install Octave <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>


==== Further reading ====
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.


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 {{Path|~/.octaverc}} file:
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:
<pre>setenv('GNUTERM','qt')
graphics_toolkit("gnuplot")</pre>


Note: If brew complains about:
do shell script "/usr/local/bin/octave --gui"
<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 <code>brew install octave</code> command again.


Note: If brew complains about not having a formula for octave, the following command should fix it:
For Apple Silicon based systems, use the following script:
<pre>brew tap --repair</pre>


The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:
do shell script "/opt/homebrew/bin/octave --gui"
<pre>brew update && brew upgrade octave</pre>


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


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].
If you want to start the Octave command-line interface (CLI), enter instead:


=== MacPorts ===
tell application "Terminal"
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''
  do script "/usr/local/bin/octave; exit"
end tell


[http://www.macports.org/ MacPorts], formerly called 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.
or if Octave is in your default path:


'''Install GNU Octave using MacPorts:'''
tell application "Terminal"
  do script "`which octave`; exit"
end tell


# Install [https://developer.apple.com/xcode/ Xcode] via the '''Mac App Store'''.
Finally:
#* Install the '''Command Line Tools''' by [https://support.apple.com/guide/terminal/open-or-quit-terminal-apd5265185d-f365-44cb-8b09-71a064a42125/mac opening a terminal] and type <pre>sudo xcode-select --install</pre>
* With the script open in the Script Editor app on your Mac, choose "File > Export".
# Follow [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"
# Update your installation <pre>sudo port selfupdate&#10;sudo port upgrade outdated</pre>
# Install Octave <pre>sudo port install octave</pre>


===Spack===
To change the application icon:
→ ''Link to [https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/octave/package.py Octave package] there.''
* Open [[: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.
* In the file info dialog, select the icon (in the top left) and press {{Key|command-v}} to paste the Octave icon over it.


[https://spack.io/ Spack] is a package management tool that supports the installation of multiple versions of software on macOS and other operating systems. It was created 2013 by Todd Gamblin and is currently being updated and developed by a large list of contributors (mainly via [https://github.com/spack/spack GitHub]).
== Alternative Package Managers ==


'''Install GNU Octave using Spack:'''
''Instead of Homebrew, the following package managers can be used to install Octave on macOS:


# Install [https://developer.apple.com/xcode/ Xcode] via the '''Mac App Store'''.
=== Anaconda ===
#* Install the '''Command Line Tools''' by [https://support.apple.com/guide/terminal/open-or-quit-terminal-apd5265185d-f365-44cb-8b09-71a064a42125/mac opening a terminal] and type <pre>sudo xcode-select --install</pre>
# Follow [https://spack-tutorial.readthedocs.io/en/latest/ Spack tutorial].
# Update Spack by going to the local Spack repository (develop branch) folder and run <pre>git pull</pre>
# Install Octave <pre>spack install octave</pre>
# To use Octave we need to first load the package <pre>spack load octave</pre>


{{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.}}
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''


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.
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].


== Create a launcher app with AppleScript ==
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:


Open the "AppleScript Editor" application and write the following text in the editor window:
  conda create --name octave
  conda activate octave
  conda install -c conda-forge octave
 
  octave --gui


tell application "Terminal"
'''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:
  do script "/path/to/octave; exit"
end tell


(e.g. Homebrew installs Octave to {{Path|/usr/local/bin/octave}} by default) or if Octave is in your default path:
  octave: GUI features missing or disabled in this build


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


or if you wish to start the GUI by default, without a terminal:
=== MacPorts ===
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''


do shell script "/path/to/octave --force-gui"
Follow the [https://www.macports.org/install.php MacPorts installation instructions].


Then:
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
* 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:
  sudo port selfupdate
* Open [[:File:Icon.png|this link]] in a web browser, right-click and select "copy image".
  sudo port upgrade outdated
* Select "Octave.app" in the Finder, then press {{Key|command-i}} to bring up the file info dialog.
  sudo port install octave
* In the file info dialog, select the icon (in the top left) and press {{Key|command-v}} to paste the Octave icon over it.
 
  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.2.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]

Retrieved from "https://wiki.octave.org/wiki/index.php?title=Octave_for_macOS&oldid=14913"