Installation for Linux #

Installing compulsory dependencies #

GAMBIT has a number of compulsory dependencies, which must be installed for GAMBIT to be built and run. Some basic information is provided for each dependency. When given the option, it is almost always better to install from source than from a package manager. Installing from source means that the package will be present on your system in the same structure and configuration as the developers intended, which cannot always be guaranteed when using package managers. This might save you some headaches when you configure CMake to build GAMBIT.

C/C++ compiler #

One of:

• GCC (GNU Compiler Collection) ≥ 9,
• LLVM Clang ≥ 10
• ICC (Intel C/C++ Compiler) ≥ 15.0.2

Fortran compiler #

One of:

• GFortran (GNU Fortran Compiler) ≥ 9
• ifort (Intel Fortran Compiler) ≥ 15.0.2

Cmake ≥ 3.16.3 #

Python + modules #

GAMBIT needs Python 3, and Python modules numpy, future, datetime, pyyaml, re, os, sys, getopt, shutil, and itertools

Git #

Boost ≥ 1.48 #

GSL (GNU Scientific Library) ≥ 2.1 #

Eigen ≥ 3.1.0 #

LAPACK (Linear Algebra Package) #

pkg-config #

Installing optional dependencies #

GAMBIT has a number of optional dependencies which you may wish to install depending on how you plan to use GAMBIT.

Downloading GAMBIT #

GAMBIT source code can be obtained either by cloning the GitHub repository from the GitHub page ⧉ or by downloading a compressed .zip or .tar.gz file. In both cases you should download the most recent version available.

Cloning the repository #

To clone the repository of version *.* into a specified $FOLDER, use the command:

git clone https://github.com/GambitBSM/gambit_*.*.git $FOLDER

Downloading compressed folders #

To instead download a .zip or .tar.gz file, visit the releases page ⧉ or run one of the following commands:

wget https://github.com/GambitBSM/gambit_2.2/archive/refs/tags/v*.*.*.zip       # Download .zip file
wget https://github.com/GambitBSM/gambit_2.2/archive/refs/tags/v*.*.*.tar.gz    # Download .tar.gz file

Note that these files have versions of the form *.*.*. Once downloaded, the files can be extracted via either:

tar -xvf v*.*.*.tar.gz    # Extract .tar.gz file
unzip v*.*.*.zip          # Extract .zip file

Building GAMBIT #

Navigate to the folder containing GAMBIT source code. Create a build directory and run Cmake:

mkdir build
cd build
cmake ..

The cmake command will automatically try to find the packages it needs to build GAMBIT. However, it will probably need some help via optional flags. Commonly used flags are listed below; you can add these to the cmake command using the syntax FLAG=VALUE.

If CMake cannot find a package then try adding a relevant flag. For example, Boost will usually require the addition of the -DBoost_INCLUDE_DIR flag pointing to the include subdirectory of the Boost installation directory.

A full list of flags and their values can be found at /build/CMakeCache.txt after every run, and examples of cmake commands can be found on the Configuration Examples page.

Next, build GAMBIT’s scanners, specifying the number of cores to use:

make -j$NUMBER_OF_CORES scanners

Then re-run CMake:

cmake ..

Then finally build GAMBIT:

make -j$NUMBER_OF_CORES gambit

Using GAMBIT #

Now that GAMBIT has been built, there should be a gambit executable in the directory above the build subdirectory. You can view the installed scanners using ./gambit scanners and the installed backends using ./gambit backends. You can also control the installation of backends using the following:

make -j$NUMBER_OF_CORES backends         # Install all backends
make -j$NUMBER_OF_CORES $BACKEND_NAME    # Install specific backend
make clean-$BACKEND_NAME                 # Clean specific backend

For basic guidance on how to use GAMBIT, please see the tutorials section.