| OpenMS 2.5.0

Building OpenMS on Windows

# Introduction

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

- A string in <> is something the user needs to choose e.g. <path_to_contrib> means that this string should be replaced by the path where the user put the OpenMS contrib package. Usually all commands where this is necessary come with examples, so don't worry.
- Whenever you added a path to your Windows PATH Environment variable, every Command Prompt which is already open will not be refreshed. You will need a to open a new one.

# Setup of environment

Pre-Requisites (Software)

- Visual Studio: VS2015 and above are supported, but we thoroughly recommend VS2019 (faster compilation, faster executables and it fixes a bug in OpenMP multithreading - see issue #4389). The C++ Express editions should work as well, we tested VSE2015 Update 3.
  Not supported are MinGW (g++ based compiler) and VS2013 (and earlier, due to missing C11 support). Do not use a MinGW-enabled shell since CMake will get confused! Please use the Command Prompt of the Visual Studio version you want to build with. Other compilers which are close to the VS toolchain might work, but are not tested.
- CMake: Have at least CMake 3.1 or greater installed (see http://www.cmake.org). For building with our contrib package please use 3.14+.
  CMake's Generator (-G flag) also must support your version of Visual Studio. If it doesn't, please upgrade CMake.
- 7-Zip: To extract archives within submodules of the contrib you will need `7-Zip` (see http://www.7-zip.org/)
  7z.exe is searched in "C:/Program Files/7-Zip/" and "C:/Programme/7-Zip/". Make sure it is in either of these locations or add the installation directory to your PATH.

# Installing required dependency libraries

OpenMS depends on several other libraries. On a Windows system, these are usually not present.

## Contrib installation

In order to make the installation of the remaining required libraries easier, we composed a "contrib-package" containing the libraries Boost, Eigen, sqlite3, CoinMP, WildMagic, libSVM, libHDF5, SeqAn, glpk, zlib, libbz2 and Xerces-C. This contrib package has several advantages over manual installation

- You get all the libraries in versions tested with OpenMS.
- It contains a batch script that builds all the libraries in one step.
- You don't have to spend hours reading installation instructions of all the libraries.
- We applied some patches to the libraries to fix some bugs.
  These bugs may be fatal if you do not use the contrib package.

Download:

If you plan to use the development version of OpenMS, clone OpenMS and checkout the optional contrib submodule with

git clone https://github.com/OpenMS/OpenMS
git submodule update --init contrib

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:

1. Open a VisualStudio Developer Command prompt (by default you will get a 32-bit environment which you most likely do not want; use a x64 environment if you want 64 bit apps!)
   Note
     VS2015 does not provide a commandline shortcut for a 64bit command prompt. Call `"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64` to get one!
     VS2017 has a (well hidden) batch-file which correctly configures your environment for 64bit builds. It should be located at `"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"`
2. Create a build directory for the OpenMS contrib
   e.g. `mkdir contrib_win64_build`

3. 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.

   cd <path_to_contrib_build>
   cmake -DBUILD_TYPE=ALL -DNUMBER_OF_JOBS=4 -G "<generator>" -A x64 "<path_to_contrib>"

   The `<generator>` you use must be one of the Visual Studio Generators. This is because some contrib libs require Visual Studio to build. Use the `-A x64` flag to build 64-bit libraries for the contrib (32-bit does not really make any sense for LC-MS data processing)! Type `cmake` to see a list of available generators.

   Example:

   cd c:\dev\contrib_win64_build
   cmake -DBUILD_TYPE=ALL -DNUMBER_OF_JOBS=4 -G "Visual Studio 16 2019" -A x64 "c:\dev\OpenMS\contrib"

4. Add the <path_to_contrib_build>/lib directory to your PATH Environment Variable (this is so Windows can find the DLL's when running our executables).

## QT installation

Qt comes in two flavors: commercial or non-commercial - choose whatever is applicable to you: read more on the Qt website For several recent QT5 versions, there are binary development versions available for the most recent compilers. Go to https://www.qt.io/download and click on "Go open source" at the end of the right column to download the installer. Follow steps, download, save and run the installer. Create a Qt account. Choose a folder like "c:\dev\QT". From the components choose a matching version, e.g. QT 5.10.0 and the MSVC component that fits your Visual Studio version and architecture (most likely only 64bit is supported anymore). You can deselect QTCreator under Tools. Accept the license, choose startmenu entries if wanted and install. Resulting files appear under "c:\dev\QT\$VERSION".

To build Qt from sources, download Qt5 from their git repository ad follow the steps below:

Follow this procedure if you want to compile Qt yourself:

1. non-commercial:
   1. install perl (e.g. Strawberry Perl), Python and git
   2. download Qt5 source via git or as a source package from the website:
      git clone git://github.com/qt/qt5 --branch 5.9 qt-5.9
   3. activate the needed modules via:
      perl init-repository --module-subset="essential,qtsvg" --branch
   4. open a Visual Studio Command Line (use x64 version if you want 64bit apps!)
   5. cd qt-5.9
   6. if you have multiple versions of VS installed you might need to provide the `-platform` param for the next configure command (e.g., `-platform win32-msvc2012`)
   7. To save disk space, we use the -prefix switch do install only the required parts of Qt to a new directory of your choice (called `<path-to-qt>`, e.g. `c:/dev/Qt/5.9/`). Check more options and supported compilers here: http://doc.qt.io/qt-5/configure-options.html (especially for developers). Note that part of Qt requires Python to compile, so its a good idea to add the Python executable to your path
      PATH=%PATH%;C:\Python27\
      configure -opensource -skip speech -skip location -nomake tests -nomake examples -confirm-license -opengl dynamic -prefix <path-to-qt> -platform win32-msvc
   8. nmake
   9. nmake install
   10. all Qt files (libs, includes etc) are now in `<path-to-qt>` and sub-directories.
   11. alternatively to nmake, you can download JOM (http://qt-project.org/wiki/jom) and type "jom" in your Qt build directory to use multiple cores (builds a lot faster usually)
2. commercial:
   1. we have no experience here, but it should be possible to get the DLL's and Link-Libraries here as well.
3. add the `<path-to-qt>/bin` (!) directory to your PATH Environment Variable, so the dlls are found during runtime.
4. set the environment variable QT_QPA_PLATFORM_PLUGIN_PATH to `<path-to-qt>/plugins/platforms`, otherwise you might get an error "This application failed to start because it could not find or load the Qt platform plugin "windows". Alternatively, you can copy the entire platforms-folder into the folder where your OpenMS executables will be created (but they will depend on the build-type, i.e. release|debug|...).

# Building the documentation (optional)

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:

1. Doxygen (1.8.16 is tested, others might work as well; older versions might produce errors or incomplete documentation due to lack of support for certain commands or bugs)
   - Download the installer for Windows (http://www.doxygen.org)
   - Execute the installer. It should automatically add doxygen.exe to the Windows PATH Environment (please recheck)
2. MikTeX (version 2.7 and 2.9 are tested, others might work as well, texlive is an option, too) - basic version (for DVIPS, LATEX etc).
   - Download binaries for Windows (http://miktex.org/)
   - During installation tick "install missing packages on the fly = yes"
   - The installer SHOULD add the bin directory of MikTeX automatically to the Windows PATH Environment (please recheck)
3. GPL Ghostscript (e.g. 8.60, 9.19) for Windows
   - Download binaries for Windows (http://www.ghostscript.com/) and install
   - Add the <path_to_GHOSTSCRIPT>/bin directory (e.g. c:/programs/gs/gs8.60/bin) to the Windows PATH Environment
4. Optional:
   You can create dependency graphs using a doxygen plug-in called `dot`.
   - Download binaries for windows from http://www.graphviz.org (we tested: graphviz-2.18.exe)
   - The installer should have added dot.exe to the Windows PATH Environment (please recheck)

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!

# Installing OpenMS

For development and cutting edge functionalities we recommend using the Git version from GitHub

git clone https://github.com/OpenMS/OpenMS

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:

1. Open a Visual Studio Command Line (use x64 version if you want 64bit apps – and yes, you want that!)
2. Create a build directory for OpenMS, e.g. `mkdir OpenMS_Win64`
   Note
     Due to Windows restrictions concerning the maximum length of a file path (of 260 characters) and the rather deep folder hierarchies created by CMake and Visual Studio, we advise to restrict the length of the base path to your build directory. We suggest less than 40 characters if possible.

3. Call CMake to create the build system

   cd <path_to_OpenMS_build>
   cmake -D OPENMS_CONTRIB_LIBS="<path_to_contrib_build>" -D CMAKE_PREFIX_PATH=<path_to_QT5_prefix> -G "<generator>" -A x64 -T host=x64 "<path_to_OpenMS>"

   The CMAKE_PREFIX_PATH should hold the path to your Qt5 build directory (see example below). Note that it is NOT the main Qt5 directory, but the subfolder which is named after the toolchain it was build with (e.g. "5.6/msvc2015_64"). The choice of `<generator>` depends on your system. Type `cmake –help` to see a list of available generators.

   Note
     We strongly recommend the Visual Studio Generator and it should be identical to the one used for building the contrib. Other generators (such as nmake) are not supported! If you need compiling on the command line, you can use `MSBuild` also on VS solution files! Use the `-A x64` flag to build a 64-bit OpenMS library and TOPP executables (32-bit does not really make any sense for LC-MS data processing)! The `-T host=x64` flag instructs Visual Studio to use a 64bit compiler and linker toolchain to avoid linker errors (`LNK1210: exceeded internal ILK size limit; link with /INCREMNTAL:NO`) during development (if the flag is omitted the 32bit toolchain is used to generate 64bit binaries). Example:
     cd c:\dev\OpenMS_Win64
     cmake -D OPENMS_CONTRIB_LIBS="C:\dev\contrib_win64_build" -D CMAKE_PREFIX_PATH=c:\dev\Qt5.6.2\5.6\msvc2015_64\ -G "Visual Studio 16 2019" -A x64 -T host=x64 ..\OpenMS

You can set more CMake variables adding `-DVARIABLE=VALUE` options when calling CMake.The most important CMake variables are:

`OPENMS_CONTRIB_LIBS` | Separate search path for the contrib libraries from github.com/OpenMS/contrib that is internally considered before CMAKE_PREFIX_PATH for searching, linking and adding include directories.
`CMAKE_PREFIX_PATH` | Additional search path for the contrib libraries. [MacOSX only] If you want to use libraries installed via Homebrew or MacPorts you might need to provide the corresponding paths `-DCMAKE_PREFIX_PATH=/usr/local/Cellar` for Homebrew `-DCMAKE_PREFIX_PATH=/opt/local` for MacPorts

Please keep in mind that both Homebrew and MacPorts do not provide all libraries so you also need to specify the path to your self-build contrib via -DOPENMS_CONTRIB_LIBS

`Qt5_DIR` | Additional search path for the Qt5 CMake files. Use `/PATH/TO/QT_INSTALLATION/lib/cmake/Qt5` as value. <>
`HAS_XSERVER=On/Off` | [Linux/MacOS only] Defines if a running X Server is available when building OpenMS. As building parts of the documentation and running certain tests requires a running X Server, this flag can be used to disable those parts of the documentation and the tests that need an X Server. (Default: On)
`ADDRESS_SANITIZER=On/Off` | [g++/clang only] Enables/Disables Address Sanitizer (ASAN) to find access violations and other bugs.
`WITH_GUI=On/Off` | Defines if the OpenMS GUI tools (TOPPView, TOPPAS) should be built or not. If you plan to use OpenMS without a GUI, set this flag to "Off" (Default: On)
`ENABLE_TUTORIALS=On/Off` | Enables targets to build and install the pdf tutorials (needs LaTeX). (Default: On)
`ENABLE_DOCS=On/Off` | Enables documentation targets, allowing to build the OpenMS documentation. (Default: On)
`GIT_TRACKING=On/Off` | Embed Git checksum into the library. (Default: On)
`ENABLE_UPDATE_CHECK=On/Off` | Check online for OpenMS Updates upon invocation of any TOPP/UTIL. (Default: On)
`CMAKE_BUILD_TYPE` | [makefiles only; does not apply for XCode or VS] Should be either 'Release' (optimization enabled) or 'Debug' (debug info and precondition/postcondition checks enabled). The default is 'Release'.
`CMAKE_CXX_COMPILER` | Defines the C++ compiler to use.
`MY_CXX_FLAGS` | Additional custom C++ compile options you would like to add (must fit your chosen compiler). This might be useful, for example, for adding debug symbols to a Release build, or for performance analysis (e.g. for '... -DMY_CXX_FLAGS="-g;-fno-omit-frame-pointer" ...')
`CMAKE_C_COMPILER` | Defines the C compiler to use. This should match the C++ compiler. Mixing compilers (e.g., clang++ for C++ and gcc for C) can lead to undefined behaviour as some internal settings (e.g., OpenMP support) are determined using the C compiler and are assumed to be the same for the C++ compiler.
`SEARCH_ENGINES_DIRECTORY` (optional) | The location where thirdparty search engines (X!Tandem, OMSSA, MyriMatch, MSGF+, Fido) are located. This directory should have the same structure as the example in the search engine repository at https://github.com/OpenMS/THIRDPARTY after flattening for your platform. /. This directory is only needed to include thirdparty tools in the installer for OpenMS.
`PYOPENMS` | Use ON to enable the target for Python bindings, see also pyOpenMS (Python bindings).
`CMAKE_INSTALL_PREFIX` | the path where the bin/ and lib/ directories should be installed to (when
    sudo make install
is wished for a system-wide install: e.g. -DCMAKE_INSTALL_PREFIX=/usr/local/) Note: Moving these directories after installing is not supported. For development, install prefixes are not supported. In this case OpenMS must be built in place!

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.dll library. 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.

# Building the TOPP tools

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.

# Testing your OpenMS/TOPP installation

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/.

# Building OpenMS on the commandline

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.

MSBuild.exe <solution.sln> /maxcpucount /target:<target> /p:Configuration=<Config>

Note
  Since the call can be a bit lengthy, there is a batch file in `OpenMS/tools/build.bat` and in the root of your build tree (copied there by cmake for convenience), 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. For example to build only the OpenMS library in release mode, call

build OpenMS r