Difference between revisions of "Create a MacOS X App Bundle Using MacPorts"

From Octave
Jump to navigation Jump to search
Line 25: Line 25:
Once indexed the local Octave port may be installed.
Once indexed the local Octave port may be installed.
  <nowiki>sudo port install octave-local +docs</nowiki>
  <nowiki>sudo port install octave-local +docs</nowiki>
The {{Codeline|docs}} variant is required for the {{Codeline|test()}} and {{Codeline|doc()}} functions/commands to work.
Once an Octave port is installed the command below may be used to determine / verify the version and variants of {{Codeline|<nowiki>octave-local</nowiki>}} which are installed.
Once an Octave port is installed the command below may be used to determine / verify the version and variants of {{Codeline|<nowiki>octave-local</nowiki>}} which are installed.

Revision as of 14:45, 25 June 2012

Install MacPorts

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.

An itemized overview of a MacPorts install is below.

  • Install XCode: This is done via the MacOS X App Store.
  • Follow MacPorts' installation instructions.
  • MacPorts has good support for Octave. A list of what MacPorts has available for Octave is here. To install the most recent version of Octave, type sudo port install octave-devel 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.

MacPorts has historically been rather good a maintaining their Octave portfiles. However, there are times when the maintainer fall behind. If the current version of the octave-devel port isn't current, it will be necessary to produce a local portfile. For the remainder of this page, it is assume a local portfile is being used and that the port name is octave-local.

Install an Octave Port

For the purpose of creating an App bundle using MacPorts, an Octave port must be installed. A standard MacPorts port or a local port may be used. For a local portfile it is first required that a local portfile repository be created and the local portfile placed there.

MacPorts' Octave port includes the non-GPL METIS. To avoid license violations do not bundle Metis with Octave and then distribute to others. A second motivation to use a local portfile is that the portfiles for the 3.4.x and 3.6.x series did not include all dependencies for the print feature. The missing dependencies are epstool, pstoedit, and transfig. A prototype portfile which does not depend upon METIS and does depend upon epstool, pstoedit, and transfig has been prepared.

After creating a local portfile repository an Octave portfile may be added to the local repository using the commands below.

mkdir -p ~/ports/math/octave-local
cp ~/Desktop/portfile ~/ports/math/octave-local

This assumes the Octave portfile had been placed on the users Desktop, and that the local portfile repository is located in the users home folder and named ports. After adding the portfile, the local repository must be indexed for MacPorts to recognize it.

cd ~/portfile
portindex -f

Once indexed the local Octave port may be installed.

sudo port install octave-local +docs

The docs variant is required for the test() and doc() functions/commands to work.

Once an Octave port is installed the command below may be used to determine / verify the version and variants of octave-local which are installed.

port installed octave-local

Create the MacOS X App Bundle

There are effectively four tasks needed to produce the App bundle. First, Octave and all its build and run-time dependencies must be extracted from the MacPorts installation. Second a App bundle template for running a shell script is required. This may be done using the MacOS X developer tool, Platypus. Third, the shell script which the App bundle runs is needed. This script will be used to launch the MacOS X Terminal app. This script is referred to as the App's shell script. Finally, a script for setting up the shell environment for Octave and running Octave is required. This script is referred to as the Octave shell script.

Produce a DMG for Octave and its dependencies

MacPorts provides a feature for producing binary packages with standalone binary installers that are precompiled; they do not require MacPorts on the target system. Binary files created with MacPorts may be either .pkg (Mac OS X Installer Packages), or RPM (RPM Package Manager) format. MacPorts may also process a .pkg package into a Mac OS X .dmg disk image file. The port command shown below will create a DMG type binary installer for the Octave port and all its dependencies.

sudo port mdmg octave-local

If more than one version of Octave is installed, or if more than one variant of Octave has been installed, the version and variant should be included.

sudo port mdmg octave-local @<version>+variant1+variant2

The DMG will be placed in the port's work directory. If a local portfile is used, a symbolic link to the work directory will be placed in the directory containing the portfile. In this instance the DMG can be found in ~/ports/math/octave-local/work.

Use Platypus to produce a template for the App bundle

Initial Platypus Dialog (click to enlarge)

To creating an application bundle for MacOS X the utility, Platypus, is used. Platypus is a developer tool for the Mac OS X operating system which is intended to create native Mac OS X applications from interpreted scripts such as shell scripts or Perl, Ruby and Python programs.

A shell script intended to launch a MacOS X Terminal and run Octave will be used as the basis for the MacOS X App bundle. The itemize list below describes how to produce an App bundle template for Octave. Once this has been done, it the App bundle template must be populated with Octave and its dependencies.

  • Run the Platypus application.
  • Import Octave's icon.
    • The icon linked to above is a png with a transparent background. This feature is needed to produce a MacOS X application icon.
    • Using the icon linked to above the Icon Composer developers utility may be used to create a MacOS X icon. The Icon Composer is part of Xcode's developer's tools. Its home is /Developer/Applications/Icon Composer.app
  • Set the "Script Type" to "Shell"
  • Specify the "Script Path".
    • Click on the "Select" button and select the App shell script used to launch the Terminal app.
  • Set the "Output" to "None".
  • Specify App Name (Octave-3.7.0+).
  • Click the "Create" button.
  • Save the App bundle template to the location of your choice.

Populate the App Bundle

To populate the App bundle template with Octave and its dependencies, from MacPorts, follow the itemize instructions below.

  • Move the MacPorts Octave DMG to the Desktop. If a local portfile was used and the location of the local repository was ~/ports, the DMG will be located in ~/ports/math/octave-local/work.
  • Save the original MacPorts installation.
sudo mv /opt /opt-save
  • Install the MacPorts Octave DMG, which as placed on the MacOS X Desktop. Installing the DMG will create a new /opt directory containing Octave and all its build and run-time dependencies. To avoid conflict with the original MacPorts installation.
  • Place the Octave shell script in the same directory as the App bundle template created using Platypus.
  • Populate the App bundle by running the script below from the directory containing the Platypus App bundle template and the Octave shell script.
#! /bin/sh
cp -pRf ${MACPORTS_PREFIX} ${FULLAPP}/Contents/Resources/.
rm ${FULLAPP}/Contents/Resources/bin/octave
cp octave ${FULLAPP}/Contents/Resources/bin/.
mkdir ${FULLAPP}/Contents/Resources/Applications
cp /Applications/MacPorts/AquaTerm.app ${FULLAPP}/Contents/Resources/Applications
  • Restore the original MacPorts installation.
sudo rm -r /opt
sudo mv /opt-save /opt

The Octave App bundle for MacOS X is now ready to run.

Running Octave from the Terminal's Command Line

The bundled Octave may be run from a terminal command line using the command below.


To create a symbolic link in your path that runs the bundled Octave, us the command below.

ln -s /Applications/Octave-3.7.0+.app/Contents/Resources/bin/octave /usr/local/bin/octave

If the link does not work, be sure that /usr/local/bin is in your shell path. If it is not in your path, it may be added by editing ~/.profile. Just add the line below to the end of the file.

export PATH="${PATH}:/usr/local/bin"

Problems, Restrictions, and Annoyances of the App Bundle

  • In the past, the App bundle did not run if there were spaces in its path. A solution to this problem has been applied, but is not fully tested.
  • In some instances, the Octave binary attempts to load an library whose version number is older than the one it intended to link to (at build time). This will produce an error like to one below. The developer utility, dylibbundler, is useful in pointing to and/or bundling dynamic libraries in an App bundle. These errors may linger as the application of this tool requires some experimentation in this case.
dyld: Library not loaded: /opt/local/libiconv.2.dylib
  • The Octave shell script used to run Octave is designed to ensure that the bundled version of AquaTerm is used by Octave. This was done because binary incompatibilities have been encountered between the bundled Gnuplot and AquaTerm applications provided by other sources. If Octave/Gnuplot appear to have a problem producing a plot using AquaTerm, verify that Aquaterm is running. If it is not, then quit and relaunch the Octave App. If an Aquaterm application is running, please verify that it is the one bundled with Octave.
  • Executables built by MacPorts may include features specific to the MacOS X version the executables were build on. As a result, the Octave App bundle may not run on a different version of MacOS X.
  • The mex and mkoctfile functions have not been tested. Although the App bundle does include a gcc toolset, some debugging is expected before this will work reliably.
  • When Octave is running, clicking on Octave's icon in the dock has no effect. This is because the App bundle runs a shell script which launches Terminal.app which runs Octave. To locate the Octave session, click on the Terminal.app.
  • Only one instance of the App may be run by clicking on the app. Multiple instances may be run from the command line.


Those interested in testing an App bundle can try this link. The DMG is large (620+ MB). I kindly ask those with the patience to download it, to report results to bpabbott at mac dot com. When reporting on your experience, please include;

  • The version of MacOS X you are running.
    • Note: This App bundle will not run on Mac OS 10.5 or earlier.
  • The Mac's processor (found under "About This Mac").
    • Note: This App bundle will only run on Intel processors, and requires a 64 bit processor (X86_64).
    • If the App bundle doesn't run, it may necessary to enable 64 bit mode. See Apple's support page for instructions ⇒ OS X: Starting up with the 32-bit or 64-bit kernel;
  • Whether you have Fink, Homebrew, or MacPorts installed.
  • For intricate problems, please provide enough information so that others may duplicate it.

Testing Results

Results reported by some volunteers testing an App bundle are below. As some of the reported results are inconsistent, individuals are cautioned to not interpret these results as definitive.

  • An App bundle built for arch=X86_64 on an Intel Core i7 MacBook Pro running MacOS 10.7 was found to run on the following;
  • MacBook Pro (Intel Core i7) running MacOS 10.7 with MacPorts installed.
  • MacBook Pro (Intel Core i7) running MacOS 10.7 with no MacPorts, and no Fink, installed.
  • Macbook Pro (Intel Core-2 Duo 2.5 GHz) MacOS 10.6.8 with 64 bit support enabled, and with MacPorts installed.
  • The App bundle did not run on;
  • MacBook (Intel Core Duo) running MacOS 10.6 with no MacPorts, and no Fink, installed. The error encountered is below.
$ cd /Applications/Octave-3.7.0+.app/Contents/Resources/bin/
$ ./octave
The application cannot be opened because it has an incorrect executable format.
./octave: line 124: /Applications/Octave-3.7.0+.app/Contents/Resources/bin/octave-3.7.0+: Bad CPU type in executable
  • MacMini (Intel Core 2 Duo) running MacOS 10.6 with Fink installed. The error encountered is below. Enabling 64 bit did not effect this problem.
terminate called after throwing an instance of '__gnu_cxx::__concurrence_lock_error'
what():  __gnu_cxx::__concurrence_lock_error
  • MacMini (Intel Core 2 Duo) running MacOS 10.6 with no Fink or MacPorts installed. The error encountered is below.
terminate called after throwing an instance of '__gnu_cxx::__concurrence_lock_error'
what():  __gnu_cxx::__concurrence_lock_error