This document addresses OpenMS users and explains the installation procedure for building OpenMS from its sources. If you only want to use the OpenMS Proteomics Pipeline (TOPP), you are strongly encouraged to download the binary installer (see here), instead of building OpenMS from sources. Be aware though that we do not provide binary installers for every MacOS version. For more information read the install instructions for the TOPP binaries.
This document especially considers the installation of several libraries which are required by OpenMS. Most of these libraries are made available in our "contrib-package" (see below).
If you encounter errors during configuring/compiling our software, have a look at our "Known Issues" section (documentation), maybe the error is already known. If not, please write to the mailing list.
Required applications
In order to compile OpenMS, several applications need to be installed:
If your OpenMS version is a development version from SVN, the following applications are needed in order to create the OpenMS documentation:
In order to facilitate the installation of the libraries required for OpenMS, we composed a "contrib-package" containing the libraries Boost, GSL, libSVM, SeqAn, glpk, zlib, bzip2 and Xerces-C.
The contrib package is contained in the OpenMS release package and is available under the path contrib in the OpenMS directory.
If you are using the developer version of OpenMS, you must check out the contrib from Sourceforge SVN repository
CMake is used to check the system and create the contrib libraries.
enter the created directory and call cmake to build the contrib
Example:
</LI>
If everything worked, the following sub-directories were created under in the contrib build directory:
If you have not installed the libraries which %OpenMS requires, please refer to the section @ref install_win_contrib above. <br> Assuming you have successfully installed the dependent libraries, you need to get the %OpenMS source code. The latest stable version of %OpenMS can be found in the <a href="http://www.OpenMS.de/download.php" target="_blank">download</a> page. For further (e.g. latest developer version from SVN) info see the <a href="http://open-ms.sourceforge.net/download.php" target="_blank">download instructions</a>. <br> <br>
call cmake to create the build system there
You can set CMake variables using the -D VARIABLE=VALUE
option. A full list of the CMake variables is shown when you execute
cmake
before using ccmake
. Example:
The most important CMake variables are:
INSTALL_PREFIX | the path where the library is installed. Install prefixes are not supported for developing with OpenMS. OpenMS must be built in place! |
CMAKE_FIND_ROOT_PATH | Additional search path for the contrib libraries. If not set the the location is assumed to be <path_to_OpenMS>/contrib . |
QT_QMAKE_EXECUTABLE | Defines the Qt 'qmake' application. The corresponding Qt installation is used. |
CMAKE_BUILD_TYPE | Should be either 'Release' (optimization enabled) or 'Debug' (debug info and precondition/postcondiction checks enabled). The default is 'Release'. |
QT_DB_PLUGIN | Defines the Qt database type. By default MySQL is used. |
CMAKE_CXX_COMPILER | Defines the C++ compiler to use. |
After CMake was executed, you can list the make targets by calling:
In order to build the OpenMS library and TOPP tools execute the following command:
If you have chosen to use a install prefix via the INSTALL_PREFIX variable you should install the components using:
bin/
folder of the installation directory. Add this folder to your PATH variable.After you have installed OpenMS and TOPP, you should test your installation by executing the following command:
Building OpenMS with 64bit support requires Qt 4.5 (or higher) build with 64bit support. You need to specify the architecture, by adding the option
to the CMake call.
On Mac OS X 10.6 (Snow Leopard) 64bit is the default architecture. Use
to create a 32bit binary.
OpenMS / TOPP release 1.9.0 | Documentation generated on Tue May 28 2013 12:41:58 using doxygen 1.8.3.1 |