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 windows binary installer (see here), instead of building OpenMS from sources. 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 here, maybe the error is already known. If not, please write to the mailing list.
Notation of this tutorial
Pre-Requisites (Software)
7-Zip
(see http://www.7-zip.org/) OpenMS depends on several other libraries. On a windows system, these are usually not present.
In order to make the installation of the remaining required libraries easier, we composed a "contrib-package" containing the libraries Boost, Eigen, WildMagic, libSVM, SeqAn, glpk, zlib, libbz2 and Xerces-C. This contrib package has several advantages over manual installation
Download:
If you plan to use the development version of OpenMS, clone OpenMS and checkout the optional contrib submodule with
to obtain the latest potentially unstable version. If you want to use a release version of OpenMS, use the corresponding Release-tagged version on GitHub (https://github.com/OpenMS/contrib/releases) or download the contrib source from a .tar.gz for older releases.
Installation:
After you got the source code for the contrib package follow these steps:
"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64
to get one! mkdir contrib_win64_build
Call CMake to build the contrib
Be aware that you can build 64bit apps even if your operating system is only 32bit (cross-compiling), but you will not be able to run 64bit apps in this case.
The <generator>
you use must be one of the Visual Studio Generators. This is because some contrib libs require Visual Studio to build. Be careful to specify the Generator suffixed with "Win64" if you want a 64bit contrib! Type cmake
to see a list of available generators.
Example:
Qt comes in two flavors: commercial or non-commercial - choose whatever is applicable to you: read more on the Qt website Recently (beginning with Qt 4.6) there are binary development versions available for VS2010 and VS2008. We found these to contain only 32bit compilations. If you are compiling for 32bit as well, you can download these and save a lot of time. They are incompatible for 64bit builds - compile Qt yourself in this case (or see if you can find 64bit builds on the Qt website). Make sure NOT to use the MinGW precompiled binaries, since they are incompatible with Visual Studio binaries.
To build Qt from sources, download Qt 4.8.7 (see below), which supports all VS versions up to VS 2015!
Follow this procedure if you want to compile Qt yourself:
<path-to-tmp-qt>
henceforth) -platform
param for the next configure command (e.g., -platform win32-msvc2012
) <path-to-qt>
, e.g. c:/dev/Qt4.8.7/
). <path-to-qt>
and sub-directories. You can delete <path-to-tmp-qt>
(since it will consume quite a lot of disk space) <path-to-qt>/bin
(!) directory to your PATH Environment Variable This section is optional. If you can live with the online documentation, you do not need to build your own.
In order to build the class documentation (doc
& doc_internal
targets), TOPP tutorials (doc_tutorials
target) and more, you will need to install three programs:
dot
. You should install the above apps prior to installing OpenMS (see below), because otherwise during the configuration step the documentation targets will be disabled. If you already have a working installation of OpenMS (without documentation), you can simply install the above programs and reconfigure OpenMS by calling cmake .
in your build tree. No need to recompile the library!
For development and cutting edge functionalities we recommend using the Git version from GitHub
Certain stable releases can found on the GitHub release page https://github.com/OpenMS/OpenMS/releases.
If you have not installed the libraries which OpenMS requires, please refer to the section Contrib installation above (and skip the clone step).
Now, we create the build system:
mkdir OpenMS_Win64
Call CMake to create the build system
The choice of <generator>
is dependent on your system. Type cmake
to see a list of available generators.
MSBuild
also on VS solution files! Example: Now there should be a OpenMS_host.sln
file in your build directory, which you can open using Visual Studio. If you want to work on only a subset of OpenMS (e.g., OpenMS_GUI) you can open the specific solution that you will find in the src/ folder of your build folder and below (e.g., src/openms_gui/OpenMS_GUI.sln).
In Visual Studio execute the 'targets' project, which will show you the most prominent targets.
Try to build the OpenMS library - the target is called 'OpenMS'. This will create the OpenMS library dll. If you used the debug configuration it will be called OpenMSd.dll, in release mode its called OpenMS.dll.
As a last step you should add the location of the OpenMS.dll to your PATH environment. This makes calling TOPPView and TOPP tools more convenient if you are working the command line. Also, external projects (see External Code using OpenMS) require the OpenMS dll (OpenMS.dll or OpenMSd.dll) to be in the PATH. Depending on the generator and configuration used you will find the dll in [OpenMS_build]/bin/Release or [OpenMS_build]/bin/Debug (for VS) or just [OpenMS_build]/bin (nmake). In the same folder the TOPP tools will reside once build (see next section). Be aware that the order of directories in the PATH variable determines which dll or executable is used, if no absolute path was given when the executable was called. So the PATH might need to be updated (add/delete/reorder entries) if you are working with multiple installations or configurations of OpenMS.
TOPP is a toolset for the analysis of HPLC-MS data. It consists of several small applications that can be chained to create analysis pipelines tailored for a specific problem.
After you have built OpenMS, you can build the TOPP tools by building the "TOPP" project in the IDE.
Each class in OpenMS and each TOPP tool has a unit test. The tests will be build with the complete solution. To specifically build and execute the tests, go to your OpenMS build_tree and further into ./src/tests/class_tests. There you'll find an OpenMS_class_tests.sln file, which you can open. For other generators an equivalent file with another suffix will be present. Now, build the 'ALL_BUILD' target and the 'RUN_TESTS' target. You can also run the tests in a command prompt in <OpenMS_build_tree> using ctest
. Single tests can be run with ctest -R <testnameregex>
, e.g. ctest -R Base64_test
. For more syntax on CTest look at the online documentation at http://cmake.org/.
The Visual Studio solution files can contain many targets, which makes the IDE a bit sluggish especially when starting up the first time. The OpenMS class tests are by far the largest.
If you just want to compile the library or executables, it's usually faster to use the commandline. Visual Studio solution files can be used here as well, as arguments to MSBuild.exe
, e.g.
OpenMS/tools/build.bat
, which allows to build the most important targets (TOPP, UTILS, Gui, Tests, Doc) in Release or Debug using very short notation. Call it without arguments to see its usage help text. OpenMS / TOPP release 2.3.0 | Documentation generated on Tue Jan 9 2018 18:22:05 using doxygen 1.8.13 |