Skip to content

Installing igatools

Massimiliano Martinelli edited this page Feb 8, 2016 · 16 revisions

Currently, to install igatools you need to compile it from its sources. Below there are some explanatory steps to guide you through the process.

The library is developed and tested on Unix-like architectures (Linux, Mac OS X). The compilation and installation on Windows machines is not tested and is not supported by the igatools main developers.

In order to get the source code, you can download from the GitHub Download ZIP button or you can use git to download the library from the GitHub repository.

To configure and compile the sources you need to have the following programs available in your system:

  • CMake
  • a modern C++14 compiler (some notes about the compilers can be found here).
  • a python interpreter (from our experience, this was usually pre-installed in all Linux/Mac OS X machine we have tested).

In order to generate the documentation from the code (optional), you need to have the following programs

If you are a Linux user we assume you know how to install the appropriate packages for your distribution. As we have experienced more difficulties making it work on Mac OS, we provide some additional instruction in this case

Additionally, igatools relies on some libraries that also need to be available in your system:

Other libraries may be needed if you configure igatools in order to use some parts that are not active by default (more details about the configuration options can be found here).

For clarity we will assume that you will be installing igatools as a common user (as opposed to root) somewhere in your home directory. More precisely, we will use the following directory structure for the sources, build and install of the library and its related dependencies.