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. A quickstart page can be found under https://aliceo2group.github.io/.
In order to build and install O2 with aliBuild you can follow this tutorial.
We use JIRA to track issues. Report a bug here.
Add the JIRA issue key (e.g. O2-XYZ) to the PR title or in a commit message to have the PR/commit appear in the JIRA ticket.
The Coding Guidelines are here. See below how to format your code accordingly.
Documentation pages: https://aliceo2group.github.io/AliceO2/.
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.
Rules and instructions are available in the repository CodingGuidelines.