Difference between revisions of "Octave for macOS"

From Octave
Jump to navigation Jump to search
(Initial edit)
 
(I think "App Bundle" is a bit technical to use in doco intended for end users; just "App" is probably better.)
 
(202 intermediate revisions by 60 users not shown)
Line 1: Line 1:
GNU Octave is primarily developed on GNU/Linux and other POSIX conformal systems. GNU Octave for MacOS 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].
+
On macOS systems GNU Octave can be installed by:
 +
# 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 (Feb 2012):
+
{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}
*The 3.6.x are current releases.
 
*The 3.4.x are previous releases.
 
*The 3.2.x are very old releases.
 
  
=Installing a MacOS X Bundle=
+
== macOS App Bundles ==
  
App bundle's for Octave on MacOS are not being produced at the present time. The developers are currently encouraging the use of one of the three package managers available, for MacOS, for installation of Octave.
+
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).
 +
* [https://github.com/octave-app/octave-app/releases Download installer from GitHub]
  
=Manual Installation from Source=
+
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+)
  
[http://www.octave.org/wiki/index.php?title=Octave_for_Mac Minimalistic] instructions for building Octave from source are available. Additional [http://www.gnu.org/software/octave/support.html support] for those who need assistance in building Octave is available.
+
== Package Managers ==
  
=Package Managers=
+
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.
  
A package manager, is a collection of software tools 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.
+
=== Homebrew ===
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, checksum, and a list of dependencies necessary for the software to run properly. Upon installation, metadata is stored in a local package database.
+
''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''
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 X. GNU Octave for MacOS 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].
+
[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.
  
==Fink==
+
'''Install GNU Octave using Homebrew:'''
  
[http://www.finkproject.org/ The Fink project] is an effort to port and package open-source Unix programs to MacOS 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]).
+
# 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>
  
===Simple Installation Instructions===
+
==== Further reading ====
  
==MacPorts==
+
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>
  
[http://www.macports.org/ MacPorts], formerly called DarwinPorts, is a package management system that simplifies the installation of software on the MacOS 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.
+
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.
  
===Simple Installation Instructions===
+
Note: If brew complains about not having a formula for octave, the following command should fix it:
 +
<pre>brew tap --repair</pre>
  
==Homebrew==
+
The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:
 +
<pre>brew update && brew upgrade octave</pre>
  
Homebrew is a package management system that simplifies the installation of software on the Mac OS X operating system. 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.
+
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.
  
===Simple Installation Instructions===
+
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].
 +
 
 +
=== MacPorts ===
 +
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''
 +
 
 +
[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.
 +
 
 +
'''Install GNU Octave using MacPorts:'''
 +
 
 +
# 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://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>
 +
 
 +
===Spack===
 +
→ ''Link to [https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/octave/package.py Octave package] there.''
 +
 
 +
[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]).
 +
 
 +
'''Install GNU Octave using Spack:'''
 +
 
 +
# 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>
 +
 
 +
{{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.}}
 +
 
 +
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.
 +
 
 +
== Create a launcher app with AppleScript ==
 +
 
 +
Open the "AppleScript Editor" application and write the following text in the editor window:
 +
 
 +
tell application "Terminal"
 +
  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:
 +
 
 +
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 --gui"
 +
 
 +
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"
 +
 
 +
To change the application icon:
 +
* 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.
 +
 
 +
== See also ==
 +
 
 +
* [[Octave for macOS (outdated)]] contains old installation instructions.
 +
 
 +
== Footnotes ==
 +
 
 +
<references/>
 +
 
 +
[[Category:Installation]]
 +
[[Category:Macintosh platform]]

Latest revision as of 22:48, 15 April 2021

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

Homebrew[edit]

Link to Octave package there.

Homebrew was written 2009 by Max Howell and has gained popularity in the Ruby on Rails community and earned praise for its extensibility.

Install GNU Octave using Homebrew:

  1. Install Xcode via the Mac App Store.
  2. Follow Homebrew's installation instructions.
  3. Ensure brew itself has the latest definitions
    brew update
  4. Install Octave [1]
    brew install octave

Further reading[edit]

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:

setenv('GNUTERM','qt')
graphics_toolkit("gnuplot")

Note: If brew complains about:

Linking /usr/local/Cellar/ghostscript/9.14...
Error: Could not symlink share/ghostscript/Resource
/usr/local/share/ghostscript is not writable.

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:

sudo chown -R `whoami` /usr/local/share/ghostscript
brew link --overwrite ghostscript

Then run the brew install octave command again.

Note: If brew complains about not having a formula for octave, the following command should fix it:

brew tap --repair

The command below upgrades Octave and its dependencies to the latest Homebrew-supported versions:

brew update && brew upgrade octave

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.

In case of trouble, see the Homebrew Troubleshooting Guide, which assists in diagnosing problems and craft useful bug reports. Bugs may be reported at Homebrew-core's issue tracker.

MacPorts[edit]

Link to Octave package there.

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.

Install GNU Octave using MacPorts:

  1. Install Xcode via the Mac App Store.
  2. Follow MacPorts' installation instructions.
  3. Update your installation
    sudo port selfupdate
    sudo port upgrade outdated
  4. Install Octave
    sudo port install octave

Spack[edit]

Link to 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 was created 2013 by Todd Gamblin and is currently being updated and developed by a large list of contributors (mainly via GitHub).

Install GNU Octave using Spack:

  1. Install Xcode via the Mac App Store.
  2. Follow Spack tutorial.
  3. Update Spack by going to the local Spack repository (develop branch) folder and run
    git pull
  4. Install Octave
    spack install octave
  5. To use Octave we need to first load the package
    spack load octave
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 AppleScript[edit]

Open the "AppleScript Editor" application and write the following text in the editor window:

tell application "Terminal"
 do script "/path/to/octave; exit"
end tell

(e.g. Homebrew installs Octave to /usr/local/bin/octave by default) 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 --gui"

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"

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]

  1. Homebrew has updated some of its scripts. To install Octave as of May 14, 2020, provide the migrated full path by running brew install homebrew/core/octave instead. [Citation needed!]