Installation of TChecker

Please, notice that TChecker has only been tested on Linux and Mac OS X. The installation instructions below may not work for other operating systems.

Requirements

TChecker depends on several softwares and libraries listed below. Linux users can install these softwares using the packaging system shipped along with their distribution. Mac OS X users can install the required software using an external packaging system like Brew or MacPorts.

• a C++ compiler with decent C++17 support (Clang >= 3.6 or GNU g++ >= 6 should work. Apple LLVM >= 10.0.0 works)
• CMake (>= 2.8)
• flex (>= 2.5.35)
• bison (>= 3.0.4)
• The Boost library (>= 1.65.0 -- probably works with earlier versions)
• Catch2 (>= 2.7.0)
• Doxygen (>= 1.8.15 -- probably works with earlier versions)

Building and installing TChecker

We recommend building TChecker in a dedicated directory, not in the source directory itself. This allows to easily remove files generated by CMake and by the compiler. This also allows CMake to build a project for your favorite IDE, out of the source directory. We describe the installation process following this recommendation, using make as a build system.

1. Create a directory to contain both the source directory and the build directory: mkdir tchecker-src, then enter the new directory.
2. Clone the project git clone https://github.com/fredher/tchecker.git in directory tchecker-src.
3. Create the build directory, still in directory tchecker-src: mkdir build
4. Then, enter the build directory cd build and follow the next steps:
   1. Configure the build system: cmake ../tchecker (where ../tchecker is the directory containing the source code created by git clone). You can use the -G flag to generate a project for your favorite build system/IDE (Makefile is the default), and option -D to define cmake variables (see CMake documentation). In particular, you can build the Debug version or the Release version of TChecker by setting option CMAKE_BUILD_TYPE. The installation directory is set using option CMAKE_INSTALL_PREFIX. The path to required software can be specified using option CMAKE_PREFIX_PATH if needed.
   2. Compile the project: make (use option -j for parallel build)
   3. Build the documentation: make doc
   4. Finally, install TChecker: make install

The installation procedure creates four directories: bin, lib, include and share/doc/tchecker/html in the installation directory (default is /usr/local). The TChecker tool can be found in directory bin (see below for usage). The development tools are provided in the other directories: the headers in include, the library in lib, and the Doxygen documentation in share/doc/tchecker/html.