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


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).  
About version numbers (Feb 2012):
*The 3.6.x are current releases.
*The 3.4.x are previous releases.
*The 3.2.x are very old releases.


{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}
=Installing a MacOS X Bundle=


== Homebrew ==
An App bundle for Octave on MacOS is not presently available. The developers would like to be able to provide an App bundle, but need volunteers to support the effort.  Octave and many other software packages may be installed an updated using one of the three package managers available for MacOS. To install using a package manager, see the section on [http://www.octave.org/wiki/index.php?title=Octave_for_MacOS_X&action=submit#Package_Managers Package Managers] below.
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''


'''Install GNU Octave using Homebrew:'''
=Manual Installation from Source=


Follow the [https://brew.sh/ Homebrew installation instructions].
The page [[Octave for Mac]] provides minimalistic instructions for building Octave from source on MacOS X. Additional [http://www.gnu.org/software/octave/support.html support] for those who need assistance in building Octave is available.


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


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


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
==Fink==
  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].
[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]).


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


== Create a launcher app with the Script Editor ==
*Install XCode: This is done via the MacOS X App Store.
*Follow [http://www.finkproject.org/download/srcdist.php Fink's installation instructions].
*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 Octave-3.6.1, type {{Codeline|<nowiki>sudo fink install octave361</nowiki>}} at the Terminal's command line. Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours.


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


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


do shell script "/usr/local/bin/octave --gui"
===Simple Installation Instructions===


For Apple Silicon based systems, use the following script:
*Install XCode: This is done via the MacOS X App Store.
*Follow [http://www.macports.org/install.php MacPorts' installation instructions].
*MacPorts has good support for Octave. A list of what MacPorts has available for Octave is [http://www.macports.org/ports.php?by=name&substr=octave here]. To install the most recent version of Octave, type {{Codeline|<nowiki>sudo port install octave-devel</nowiki>}} at the Terminal's command line. Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours.


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


If you want to start the Octave command-line interface (CLI), enter instead:
===Simple Installation Instructions===


tell application "Terminal"
*Install XCode: This is done via the MacOS X App Store.
  do script "/usr/local/bin/octave; exit"
*Follow [https://github.com/mxcl/homebrew/wiki/installation Homebrew's installation instructions].
end tell
*[http://mxcl.github.com/homebrew/ Homebrew] has good support for Octave. To install Octave, type {{Codeline|<nowiki>brew install octave</nowiki>}} at the Terminal's command line. Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours.
 
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 [[: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.
 
== 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 ==
 
* [[Octave for macOS (outdated)]] contains old installation instructions.
 
== Footnotes ==
 
<references/>
 
[[Category:Installation]]
[[Category:Macintosh platform]]
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)