Skip to content

Source installation notes

Martin Shetty edited this page Nov 2, 2017 · 4 revisions

Common build dependencies

The following tools are required to build the library itself.

If you intent to build the unit tests, you also need:

Test coverage reporting is available with gcc, using gcov or gcovr.

To generate documents, you will also need:

  • Sphinx a Python based documentation generator
  • doxygen to extract the API documentation from the source tree

Dependency management can be made easier if you use:

  • Conan for automatic dependency resolution, which in turn requires:
  • Python for the platform you want to build

Some comments on conan

We use the community remote repository for a reasonable conan package. Thus one has to add

conan remote add conan-community https://api.bintray.com/conan/conan-community/conan

Windows

On Windows Conan is most probably the best choice to satisfy library dependencies. So you definitely should think about using it.

Notes on installing googletest

It is highly advised that googletest be built with the same compiler as the software that is to be tested. Therefore, the standard packages do not come with precompiled libraries. One option is to compile googletest from source and install it to the system. CMake will then automatically find it when building h5cpp. Otherwise, h5cpp may attempt to build gtest itself, but this is only configured for a few distributions of Debian:

Debian 8 (Jessie)

To build with googletest on Jessie you need to install libgtest-dev.

Debian 9 (Stretch)

For googletest on stretch the package googletest is required. It should pull in all additional requirements.