Octave for macOS: Difference between revisions

From Octave
Jump to navigation Jump to search
m (replace "MacOS X" with "Mac OS X", matching Apple's usage)
(brew install svn not needed to run Octave on macOS installed via Homebrew.)
 
(187 intermediate revisions by 54 users not shown)
Line 1: Line 1:
GNU Octave is primarily developed on GNU/Linux and other POSIX conformant systems. GNU Octave for Mac OS 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].
For the latest version of GNU Octave there are currently '''no''' installer files (e.g. DMG installer) available.


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


==Manual Installation from Source==
{{Note|'''GNU Octave {{Release}}''' is the current stable release.}}


The page [[Octave for Mac]] provides minimalistic instructions for building Octave from source on Mac OS X. Additional [http://www.gnu.org/software/octave/support.html support] for those who need assistance in building Octave is available.
== Homebrew ==
→ ''Link to [https://formulae.brew.sh/formula/octave Octave package] there.''


==Package Managers==
'''Install GNU Octave using 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.
Follow the [https://brew.sh/ Homebrew installation instructions].
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.
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 Mac OS X. GNU Octave for Mac OS 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].
It is advised to install the '''Command Line Tools''' type in the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] before Homebrew:


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


===XCode Dependency===
A window will pop out to guide the installation.


Each package manager requires that XCode be installed. In part this is to provide an initial set of development tools. It *may* be possible to substitute the [https://github.com/kennethreitz/osx-gcc-installer Mac OS X gcc Installer] by Kenneth Reitz, but this alternative has not yet been tested. If any curious/industrious users experiment with using Kenneth's solution over Apple's XCode, please let Octave's developers know of the results. Or, if you prefer, just update the itemized list below. It is recommended that users with XCode already installed avoid installing Kenneth's solution, as it may break your existing XCode installation.
Then, come back to the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
* Fink: The Mac OS X gcc Installer has not been tested.
* MacPorts: The Mac OS X gcc Installer has not been tested.
* Homebrew: The Mac OS X gcc Installer has not been tested.


===Fink===
  brew update
  brew upgrade
  brew install octave
 
  octave --gui


[http://www.finkproject.org/ The Fink project] is an effort to port and package open-source Unix programs to Mac OS 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]).
In case of trouble try <code>brew doctor</code>, see the [https://docs.brew.sh/Troubleshooting Homebrew Troubleshooting Guide].


====Simple Installation Instructions====
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 XCode: This is done via the Mac App Store.  For Mac OS X 10.8, it is necessary to run Xcode and install the command-line tools via its Xcode's Preferences.
== Create a launcher app with the Script Editor ==
*Follow [http://www.finkproject.org/download/srcdist.php Fink's installation instructions]. For those who prefer it, there is a GUI available for Fink, [http://finkcommander.sourceforge.net Fink Commander].
*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 the latest Octave, type {{Codeline|<nowiki>sudo fink install octave</nowiki>}} at the Terminal's command line.  For those running the 64 bit version of Fink, it is recommended that {{Codeline|octave-atlas}} be installed instead as there are some bugs/features with Apple's vecLib for the X86_64 architecture.  Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours.
* Fink should also be used to install [[http://octave.sourceforge.net/packages.php packages] for Octave.  For example, the control systems package for Lion may be installed by typing {{Codeline|fink install control-atlas-oct362}} at a terminals command line.


For the {{Codeline|doc()}} function to be supported by Octave, either the unversioned {{Codeline|octave}}, {{Codeline|octave-atlas}}, or {{Codeline|octave-ref}} package must be installed. Essentially, those features used at run-time which don't have a version somewhere in the file path are included in these packages.
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 Mac OS 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 Mac App Store.
do shell script "/opt/homebrew/bin/octave --gui"
*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|sudo port install octave-devel +atlas+docs}} 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.
*The variant installed may be important to the user's experience.  The available variants for  {Codeline|octave-devel} are displayed by typing {{Codeline|port variants octave-devel}}.  It is recommended that the user include {{Codeline|+atlas+docs}}.  This will avoid bugs present in Apple's vecLib and enable support for Octave's  {{Codeline|doc()}} function.


===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 Mac OS X. 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"
  do script "/usr/local/bin/octave; exit"
end tell


*Install XCode: This is done via the Mac App Store. (technically you may only require just the xcode command line tools- this download is smaller at 113 megs rather than the full xcode suite at about 1.6 gigs-)
or if Octave is in your default path:
* download and install xquartz
*Follow [https://github.com/mxcl/homebrew/wiki/installation Homebrew's installation instructions].
[http://mxcl.github.com/homebrew/ Homebrew] has good support for Octave. To install Octave, you must first enable the scientific related formulae by typing at the Terminal's command line:


  brew tap homebrew/science
  tell application "Terminal"
  do script "`which octave`; exit"
end tell


Then, if you do not have a fortran compiler installed, type
Finally:
 
* With the script open in the Script Editor app on your Mac, choose "File > Export".
brew install gfortran
* 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"
 
brew install octave
 
**** caution -information below on using suite-sparse 3.7.0 might have been outdated by now , so try the normal build above which uses suite-sparse 4.2.0, and if that fails try the approach below *****
Currently, linking Octave fails with the newest suite-sparse (4.1.0). As a solution, an older version can be installed.
First, versioning must be enabled and an older version has to be chosen (in this case, 3.7.0)
 
brew tap homebrew/versions
brew versions suite-sparse


Then go to the install directory of brew ({{Codeline|<nowiki>/usr/local</nowiki>}} by default) and get the formula for the older version (the revision number, {{Codeline|<nowiki>ff53163</nowiki>}},  is shown in the fourth column by in the previous command's output)
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.


cd /usr/local/Library/Taps/homebrew-science/
== Alternative Package Managers ==
git checkout  ff53163 /usr/local/Library/Taps/homebrew-science/suite-sparse.rb


Now compile and activate the selected version and install Octave
''Instead of Homebrew, the following package managers can be used to install Octave on macOS:


brew unlink suite-sparse
=== Anaconda ===
brew install -v ./suite-sparse.rb
brew switch suite-sparse 3.7.0
brew install octave
**** caution -information above on using suite-sparse 3.7.0 might have been outdated by now , so try the normal build above which uses suite-sparse 4.2.0, and if that fails try the approach above  *****


Note that Octave has many dependencies which will be downloaded and installed prior to Octave. The entire installation process can take a few hours.
→ ''Link to [https://anaconda.org/conda-forge/octave Octave package] there.''


==Create a launcher app with AppleScript==
Follow the [https://docs.anaconda.com/anaconda/install/mac-os/ Anaconda installation instructions].


* Open the "AppleScript Editor" application
In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:
* write the following text in the editor window:
 
<code>
 
tell application "Terminal"
  do script "/path/to/octave; exit"
end tell


</code>
  conda create --name octave
  conda activate octave
  conda install -c conda-forge octave
 
  octave --gui


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


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


</code>
=== MacPorts ===
→ ''Link to [https://github.com/macports/macports-ports/blob/master/math/octave/Portfile Octave package] there.''


* Select "Save as ..." from the "File" menu
Follow the [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"


In the [https://support.apple.com/guide/terminal/welcome/mac Terminal App] type:


To change the application icon
  sudo port selfupdate
  sudo port upgrade outdated
  sudo port install octave
 
  octave --gui


* Open [http://wiki.octave.org/File:Icon.png this link] in a web browser, right-click and select "copy image".
== See also ==
* 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.


==Installing a Mac OS X Bundle==
* [[Octave for macOS (outdated)]] contains old installation instructions.


A reliable App bundle for Octave on Mac OS X is not presently available. The developers would like to be able to provide an App bundle, but need volunteers to support the effort.  An approach for producing an App Bundle using [http://www.macports.org MacPorts] is being documented [[Create a Mac OS X App Bundle Using MacPorts|here]].  This approach shows promise, but a few problems must be resolved before a bundle will become available.
== Footnotes ==


Octave and many other software packages may be installed and updated using one of the three package managers available for Mac OS X. To install using a package manager, see the section on [[Octave_for_MacOS_X#Package_Managers|Package Managers]].
<references/>


{{Warning|Octave-Forge does have [https://sourceforge.net/projects/octave/files/Octave%20MacOSX%20Binary/ App bundles] for old Octave, versions and have problems running on Mac OS 10.6 and above.  The latest App bundle does not provide full support for the printing, or the documentation features of Octave. Other features may be missing as well. For individuals who'd like to use it anyway please carefully follow the instructions for [[Installing Mac OS X Bundle]].}}
[[Category:Installation]]
[[Category:Macintosh platform]]

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]