Editing Octave for macOS

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
For the latest version of GNU Octave there are currently '''no''' installer files (e.g. DMG installer) available.
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems.  On macOS systems GNU Octave can be installed
* from a single [https://en.wikipedia.org/wiki/Apple_Disk_Image dmg-file], a macOS App Bundle called "Octave.app" in recent versions, or
* by using a macOS [[#Package Managers|package manager]].


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 ==
The [https://octave-app.org/ Octave.app project] ([https://github.com/octave-app GitHub page]) provides an unofficial ready-to-use macOS App Bundle installer based on [[#Homebrew|Homebrew]] (see below).
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''
* [https://octave-app.org/Developer-Downloads.html macOS App Bundle of Octave 5.2.0 Beta (with GUI)]
* [https://octave-app.org/Download.html macOS App Bundle of Octave 4.4.x (with GUI)]


'''Install GNU Octave using Homebrew:'''
An older 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+)


Follow the [https://brew.sh/ Homebrew installation instructions].
== 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 ===
→ ''Latest Octave: [https://formulae.brew.sh/formula/octave Version 5.2.0]''


  brew update
[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.
  brew upgrade
  brew install octave
 
  octave --gui


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'''.
#* 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>


== Create a launcher app with the Script Editor ==
{{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. Precompiled binary packages called 'bottles' are available with default options for Octave and many of its dependencies, which speed up the installation.}}


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


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:
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:
<pre>setenv('GNUTERM','qt')
graphics_toolkit("gnuplot")</pre>


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


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


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


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


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


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


or if Octave is in your default path:
[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.


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


Finally:
# Install [https://developer.apple.com/xcode/ Xcode] via the '''Mac App Store'''.
* With the script open in the Script Editor app on your Mac, choose "File > Export".
#* 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>
* 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"
# Follow [https://www.macports.org/install.php MacPorts' installation instructions].
# Update your installation <pre>sudo port selfupdate&#10;sudo port upgrade outdated</pre>
# Install Octave <pre>sudo port install octave</pre>


To change the application icon:
===Spack===
* Open [[:File:Icon.png|this link]] in a web browser, right-click and select "copy image".
→ ''Latest Octave: [https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/octave/package.py Version 5.2.0]''
* 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.


== Alternative Package Managers ==
[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]).


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


=== Anaconda ===
# Install [https://developer.apple.com/xcode/ Xcode] via the '''Mac App Store'''.
#* 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>


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


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


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


  conda create --name octave
Open the "AppleScript Editor" application and write the following text in the editor window:
  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:
tell application "Terminal"
  do script "/path/to/octave; exit"
end tell


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


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


=== MacPorts ===
or if you wish to start the GUI by default, without a terminal:
→ ''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].
do shell script "/path/to/octave --force-gui"


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


  sudo port selfupdate
To change the application icon:
  sudo port upgrade outdated
* Open [[:File:Icon.png|this link]] in a web browser, right-click and select "copy image".
  sudo port install octave
* 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.
  octave --gui


== See also ==
== See also ==
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://wiki.octave.org/Octave_for_macOS"