How to compile CombLayer

CombLayer is predominately written for the Linux platform using C++ compilers that support C++17 or greater.

Requirements

  • Either clang or gcc>=8.0
  • GNU Scientific Library (GSL)
  • boost::regex
  • STL
  • cmake
  • doxygen (for building documentation)

Basic build method

  1. Check out the source code: 
    git clone https://github.com/SAnsell/CombLayer
cd CombLayer
  2. Generate the build system for your machine: 
    cmake ./
  3. Compile:
    make
    This will build all available models. Obviously, if you need, say, the ESS model only, run 
    make ess

Additional technical details on dependencies and compilation with different compilers can be found in the travis-ci configuration file, which we use for automated tests.

Class reference

The CombLayer class reference can be built by executing

make doxygen

Open html/index.html in your web browser.