Compilation on Mac OS X
This document describes how to build Stellarium from sources on Mac OS X. This process ought to improve over time.
The set of instructions was written for the 0.13.0 release and using an Intel machine with Mountain Lion (10.8) or later, including Yosemite (10.10.3 at the moment).
Prepare Mac OS X to build Stellarium
Note: if you need an universal binary, see section Compiling dependencies to build an universal binary below.
- Install the latest version of Apple's Developer Tools: https://developer.apple.com/xcode/
- Install the latest stable version of Qt5 (5.4.2 at the moment): http://www.qt.io/download-open-source/ (offline installer)
- Add Qt5 to your PATH environment variable, adding to your .bash_profile file the following line:
You need some tools to build Stellarium on OS X. This tools are CMake and Bazaar. There are (at least) two simple options to install these tools on OS X. Choose only one of them (HomeBrew or MacPorts).
Option 1: Install necessary tools with HomeBrew
Simpler, lighter and safer (doesn't need sudo) than MacPorts.
- Install HomeBrew: http://brew.sh
- Install CMake:
$ brew install cmake
- Install Bazaar:
$ brew install bazaar
- (optional) Install Gettext:
$ brew install gettext; brew link gettext --force
Option 2: Install necessary tools with MacPorts
- Install MacPorts: http://www.macports.org/install.php
- Install CMake:
$ sudo port install cmake
- Install Bazaar:
$ sudo port install bzr
Don't forget to restart your terminal session, so that your new PATH setting is taken in account.
Building Stellarium itself
Create a build directory with your favorite shell (the following directory is just an example, you can pick any name and path you want)
$ mkdir ~/Development $ cd ~/Development
Getting Stellarium source code
In that directory checkout the sources with the bzr command
$ bzr branch lp:stellarium stellarium
For more details, see the Bazaar checkout instructions.
If you have already done it once, you have just to update your copy using this bzr command
$ bzr pull
Time to compile Stellarium
We setup the build directory
$ cd stellarium $ mkdir -p builds/macosx $ cd builds/macosx
We run cmake...
$ cmake ../..
... and compile
Optionnaly, we test our build
$ make tests
IMPORTANT: you should delete or move aside the old Stellarium.app before each new build:
$ rm -r Stellarium.app/
Then make the Mac OS X application:
$ make install $ make mac_app
The mac_app target includes a python script that makes use of otool and install_name_tool to:
- read the link dependencies of Stellarium.app/Contents/MacOS/stellarium,
- copy those dependencies into the app (.frameworks and .dylibs),
- recurse on those copied-in dependencies, stopping at a point where system libraries are called for.
Creating DMG (Apple Disk Image)
$ mkdir Stellarium $ cp -r Stellarium.app Stellarium $ hdiutil create -format UDZO -srcfolder Stellarium Stellarium.dmg
We recommend Qt Creator
The core group of developers of stellarium uses QtCreator as main IDE, its integration with Qt and the possibility of having a consistent tool through different platforms makes it the most suitable option for our goals.
Compiling dependencies to build an universal binary
Note: This step is outdated. No universal builds were made since version 0.11.3 (2012-07-31). If you know how to update it, feel free to do it.
Note: This step is needed only if you need an universal binary. If you don't intend to create an universal package you can ignore this and refer to section Building Stellarium itself.
We have to compile the dependencies with special flags to be able to generate an universal binary.
In case you are compiling in a Leopard or Snow Leopard machine you have to recompile stellarium dependencies making use of the oldest system libraries (in our case those in 10.4 aka Tiger). We need the following compilation flags:
a. We want to generate a single binary for both intel and ppc architectures so:
-arch i386 -arch ppc
b. We want to link with the old framework and system libraries:
-mmacosx-version-min=10.4 -isysroot /Developer/SDKs/MacOSX10.4u.sdk/ (Not sure if this is really needed)
- Libiconv: It's important to compile libiconv in the first place because gettext depends on it. Get the latest release from here: http://www.gnu.org/software/libiconv/ Uncompress the file in your favorite directory and configure and compile like this:
$ ./configure --prefix=/usr CFLAGS='-arch i386 -arch ppc -mmacosx-version-min=10.4 -isysroot /Developer/SDKs/MacOSX10.4u.sdk/' $ make $ make install
- Gettext: Get the latest release from here: http://www.gnu.org/software/gettext/ . Uncompress the file in your favorite directory and configure and compile like this:
$ ./configure CFLAGS='-arch i386 -arch ppc -mmacosx-version-min=10.4 -isysroot /Developer/SDKs/MacOSX10.4u.sdk/' $ make $ make install
At the moment of writing these steps 4.6.2 is the latest version of Qt. Trolltech provides support from MacOS 10.4 to 10.6 so our binaries will be constrained by this. I went through these instructions in a Leopard machine. To compile in Snow Leopard it's necessary to consider the following notes copied from the Qt 4.6.0 changelog:
- Gcc 4.2 is used by default. Configure with -platform macx-g++40 to select 4.0.
- Using the 10.4u SDK requires gcc 4.0.
- Configuring for the Cocoa port (-cocoa) produces 64-bit binaries by default. Use the -arch flags to override.
- Building for ppc64 is no longer supported by the gcc tool chain.
- Building for ppc is still supported.
I haven't tried to generate universal binaries on a Snow Leopard machine. We have to validate these steps.
All kinds of things might go wrong!
We will write here the most frequent problems and the possible solutions found by the developers.