Important
The contrib is retired. OpenMS builds its third-party libraries with
vcpkg now; see
Building OpenMS and
OpenMS/OpenMS#10327. This repository no longer publishes releases or Docker
images. The existing releases, the ghcr.io/openms/contrib and
ghcr.io/openms/contrib_manylinux_2_34 images and
contrib-sources stay available,
so older OpenMS versions and their release branches keep building against them.
This directory contains the OpenMS contrib package.
If you downloaded a stable release of OpenMS,
detailed installation instructions and other information
can be found in the documentation (OpenMS/doc/index.html).
If this is a development version obtained via Git or as nightly snapshot, the documentation is not contained in this package. Please refer to the OpenMS website https://www.openms.de for installation instructions.
Please note that an internet connection is required to build the contrib since the actual source packages are only downloaded when built.
You can find the sources on https://github.com/OpenMS/contrib-sources.
To see all available build types, execute
$ cmake -DBUILD_TYPE=LIST .
Using the -DBUILD_TYPE switch on the command line, you can customize which
external libraries should be built (depending on your system, you might already
have some of them installed and may not want to re-install them).
CMake will then download the requested libraries and compile them for you.
- cmake
- autoconf
- automake
- libtool
- 7zip on Windows
Building a library also installs its license and notice files, as its source distribution has them,
to share/licenses/<library>/ in the build directory. SOURCE.txt next to them names the source
archive the library was built from and where it is published. share/licenses/arrow/bundled/ holds
the files of the dependencies Arrow builds and links itself (e.g. Snappy, zstd, Thrift), with Arrow's
list of their versions. Software that is built against the contrib and redistributes its libraries,
such as the pyOpenMS wheels, ships the folders of the libraries it links.
Note that in case you do a partial build, it is wise to install BZIP2 and ZLIB first, since other libraries (e.g. BOOST) depend on it.