Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • nightly_master
  • jul24_patches
  • nov23_patches
  • DC_2404
  • nighly_master
  • DC_Jan24
  • DC_Nov23
  • DC_Oct23
  • feb23_patches
  • L1Algo-dev9
  • dec21_patches protected
  • apr21_patches protected
  • dev_2025_14
  • dev_2025_13
  • dev_2025_12
  • dev_2025_11
  • dev_2025_10
  • dev_2025_09
  • dev_2025_08
  • dev_2025_07
  • dev_2025_06
  • dev_2025_05
  • dev_2025_04
  • dev_2025_03
  • dev_2025_02
  • dev_2025_01
  • dev_2024_52
  • dev_2024_51
  • dev_2024_50
  • dev_2024_49
  • dev_2024_48
  • dev_2024_47
33 results
Blame Permalink
README.md 8.26 KiB

Installation Instructions for for CbmRoot

The easiest way to install CbmRoot is described in Chapter 3 which introduces a scripts for automatic installation of CbmRoot and its dependencies. If you are unsure how to install CbmRoot please follow the instructions in this chapter.

1. Dependencies

1.1 Compiler

To be able to compile CbmRoot, the used compiler must support the C++17 standard. A GCC beginning from version 7 and clang beginning from version 6 should be okay.

1.2 FairSoft

To install, compile, and run CbmRoot, several external programs are required. These are for example Root, Geant3 or Geant4 and many others. Installing these is the first step of the CbmRoot installation. As the individual installation of each of these programs is very time consuming, the FairRoot team provides a software bundle known as FairSoft, which contains all the needed packages, and also provides tools for its automated installation on several platforms. The most up-to-date information regarding the installation of FairSoft, together with a complete list of the contained packages, can be found on the project's GitHub page:

https://github.com/FairRootGroup/FairSoft

This page should be considered the primary source of information regarding FairSoft, which takes precedence over any others (which may in some cases be outdated). Additional information, for instance regarding older versions, can be found on CBM Redmine:

https://redmine.cbm.gsi.de/projects/cbmroot/wiki/Install_External_Packages

We recommend to always use the latest FairSoft release version. Currently this is "apr21p2", which is compatible with the latest version of CbmRoot. Different combinations of older versions of FairSoft, FairRoot and CbmRoot may work in principle, but are not endorsed or actively supported.

Please make sure SQLite is installed on your system before compiling FairSoft, as this is required by CbmRoot. Failing to compile FairSoft with SQLite support will lead to a crash during the CbmRoot compilation which results in a complete reinstallation of FairSoft and FairRoot after the package was installed. There have also been reports about problems with other missing packages. Mainly these were the Threading Building Blocks (tbb) and the GNU Scientific Library. Since these packages may be missing in the instructions from the FairRoot webpage please install them using the following commands depending on your OS.

Debian/Ubuntu:

sudo apt install sqlite3 libsqlite3-dev
sudo apt install libgsl-dev
sudo apt install libtbb-dev

OpenSuse:

sudo zypper install sqlite3 sqlite3-devel
sudo zypper install gsl-devel
sudo zypper install tbb-devel

Fedora:

sudo dnf install sqlite-devel
sudo dnf install gsl-devel
sudo dnf install tbb-devel

The complete installation of FairSoft (and likewise FairRoot and CbmRoot) doesn't need any administrative privileges and an installation into system paths is strongly discouraged, as this may create conflicts with existing software. So please make sure that you do the installation as normal user.

For an installation which is to be shared between users on a MacOS or linux system it is recommended to use the opt/ folder. Consider also using the auto installer (see section 3).

The compilation of FairSoft is the most time-consuming part of the CbmRoot installation and can take several hours, depending on your system. If you are working at GSI there are always ready-to-use versions of FairSoft available. For detailed information please check the following wiki page

https://redmine.cbm.gsi.de/projects/cbmroot/wiki/RunCbmGSI

1.3 FairRoot

CbmRoot is based on FairRoot, a simulation, reconstruction and analysis framework based on the ROOT system, which by now is also used by several other experiments as base for their developments. Beside FairSoft you need also to install FairRoot to be able to compile CbmRoot.

Detailed instructions how to get and compile FairRoot can be found on the project's GitHub page at:

https://github.com/FairRootGroup/FairRoot

We again recommend this official repository as the primary source of information, and recommend using the latest release version.

Other information can be found at:

https://redmine.cbm.gsi.de/projects/cbmroot/wiki/InstallFairRoot

In order to compile FairRoot, you must set the environment variable SIMPATH to contain the path to your FairSoft installation, i.e.: