The ALICE O2 software repository contains the framework, as well as the detector specific, code for the reconstruction, calibration and simulation for the ALICE experiment at CERN for Run 3 and 4. It also encompasses the commonalities such as the data format, and the global algorithms like the global tracking. Other repositories in AliceO2Group contain a number of large common modules, for instance for Monitoring or Configuration.
The main entry point for O2 information is here.
In order to install with aliBuild you can follow this tutorial.
We use JIRA to track issues. Head here to create tickets.
The Coding Guidelines are here. See below how to format your code accordingly.
make doc will generate the doxygen documentation.
To access the resulting documentation, open doc/html/index.html in your
build directory. To install the documentation when calling make install
turn on the variable DOC_INSTALL.
Doxygen documentation is also available online here
The code organisation is described here. The build system (cmake) is described here.
# Get the configuration file
git clone https://github.com/AliceO2Group/CodingGuidelines.git
cp CodingGuidelines/_clang-format-4 /path/to/O2/top/dir # (use _clang-format-3 if you use clang-format v3)
# Check the style
# Here any tag "<replacement " indicates a problem ("<replacements " with **s** is fine!)
clang-format -style=file -output-replacements-xml SOURCEFILE`
# shows what would the file content be after the reformatting
clang-format -style=file SOURCEFILE
# Apply the style to the file
clang-format -style=file -i SOURCEFILEA number of config files are available here for various IDEs.