OpenMS obtains its dependencies through vcpkg on every platform, so the build instructions are shared: see Building OpenMS Using vcpkg for the system prerequisites, the GCC/Clang versions required, and the configure/build/test commands. The Linux-specific notes are below. To build against the distribution's packages instead of vcpkg, configure without a preset (see Building without vcpkg (system packages)).

Testing the OpenMS/TOPP Installation

After building OpenMS and TOPP, you should test your installation by executing the following command:

make test

or

ctest

By using ctest you can also execute a subset of tests by using the -R SUBSTRING option and run tests in parallel using the -j option. For example,

ctest -R TOPP_ -j 4

will run all TOPP test using 4 jobs.For more information, consult the ctest man page.

Common Issues with Qt

If the graphical TOPP tools fail to start or exit with an error message related to Qt you may need to set the QT_QPA_PLATFORM environment variable. This is especially true if you are executing the graphical tools remotely over a SSH-forwarded X11 connection.

Setting the QT_QPA_PLATFORM environment variable to minimal before running a TOPP tool should help. For example:

export QT_QPA_PLATFORM=minimal

$OPENMS_DIR/openms_build/bin/TOPPView