O2 software project for the ALICE experiment at CERN
Switch branches/tags
nightly-20181018 nightly-20181017 nightly-20181016 nightly-20181015 nightly-20181014 nightly-20181013 nightly-20181012 nightly-20181011 nightly-20181010 nightly-20181009 nightly-20181008 nightly-20181007 nightly-20181006 nightly-20181005 nightly-20181004 nightly-20181003 nightly-20181002 nightly-20181001 nightly-20180930 nightly-20180929 nightly-20180928 nightly-20180927 nightly-20180926 nightly-20180925 nightly-20180924 nightly-20180923 nightly-20180922 nightly-20180921 nightly-20180920 nightly-20180919 nightly-20180918 nightly-20180917 nightly-20180916 nightly-20180915 nightly-20180913 nightly-20180912 nightly-20180911 nightly-20180910 nightly-20180909 nightly-20180908 nightly-20180907 nightly-20180906 nightly-20180905 nightly-20180904 nightly-20180903 nightly-20180902 nightly-20180901 nightly-20180831 nightly-20180830 nightly-20180829 nightly-20180828 nightly-20180827 nightly-20180826 nightly-20180825 nightly-20180824 nightly-20180823 nightly-20180822 nightly-20180821 nightly-20180820 nightly-20180819 nightly-20180818 nightly-20180817 nightly-20180816 nightly-20180815 nightly-20180814 nightly-20180813 nightly-20180812 nightly-20180811 nightly-20180810 nightly-20180809 nightly-20180808 nightly-20180807 nightly-20180806 nightly-20180805 nightly-20180804 nightly-20180803 nightly-20180802 nightly-20180801 nightly-20180731 nightly-20180730 nightly-20180729 nightly-20180728 nightly-20180727 nightly-20180726 nightly-20180725 nightly-20180724 nightly-20180723 nightly-20180722 nightly-20180721 nightly-20180720 nightly-20180719 nightly-20180718 nightly-20180717 nightly-20180715 nightly-20180714 nightly-20180713 nightly-20180712 nightly-20180711 nightly-20180710 nightly-20180709
Nothing to show
Clone or download
Latest commit 4e0a5a9 Oct 17, 2018
Permalink
Failed to load latest commit information.
Algorithm DPL: refactor DataHeader to not include boost Oct 4, 2018
CCDB [WIP] CCDB api import from QC (O2-347) (#1321) Sep 13, 2018
Common Provide interface to external generators that comply to TGenerator (i… Oct 17, 2018
DataFormats DataFormats: add operator< to DataDescription and DataOrigin Oct 15, 2018
Detectors First version of MID geometry (#1421) Oct 17, 2018
EventVisualisation Bring CCDB more in line with O2 coding guidelines (#1303) Sep 10, 2018
Examples Fix a few missing include warnings May 2, 2018
Framework Fix configurations calls (#1424) Oct 17, 2018
Generators Provide interface to external generators that comply to TGenerator (i… Oct 17, 2018
Steer BunchFilling separate class, store it in RunContext Oct 11, 2018
Testing/Temporary First version of MCH geometry and MCH hits. (#1144) Jun 4, 2018
Utilities DPL: refactor DataHeader to not include boost Oct 4, 2018
cmake First version of MID geometry (#1421) Oct 17, 2018
config Copy rootconfig.dat in share/config/ Aug 29, 2017
doc Improve doxygen generation options Dec 13, 2017
macro First version of MID geometry (#1421) Oct 17, 2018
run o2sim: Make logging info more uniform; Do less logging to info Sep 24, 2018
.clang-format Bring CCDB more in line with O2 coding guidelines (#1303) Sep 10, 2018
.clang-tidy Adding a .clang-tidy configurations file Sep 27, 2017
.gitignore First version of MCH geometry and MCH hits. (#1144) Jun 4, 2018
.travis.yml Ignore PCG in clang-format Sep 3, 2018
AliceO2_test.cmake Implement coverage analysis. Allow to pass extra flags to the ctest c… Jul 27, 2015
CMakeLists.txt Add hijing.C to CI ignore list Oct 17, 2018
COPYING Create license file (GPLv3) Sep 4, 2017
CTestConfig.cmake CDash Jun 1, 2015
CTestCustom.cmake first commit, create the project from the template Oct 8, 2014
Dart.sh Implement coverage analysis. Allow to pass extra flags to the ctest c… Jul 27, 2015
Jenkinsfile Use --defaults o2 when checking PRs Feb 27, 2017
README.md Bring CCDB more in line with O2 coding guidelines (#1303) Sep 10, 2018
codecov.yml Move .codecov.yml to codecov.yml in the attempt of having it consider… Jan 25, 2018

README.md

ALICE O2 software

codecov JIRA

Scope

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.

Website

The main entry point for O2 information is here. A quickstart page can be found under https://aliceo2group.github.io/.

Installation

In order to install with aliBuild you can follow this tutorial.

Issue tracking system

We use JIRA to track issues. Report a bug here.

Coding guidelines

The Coding Guidelines are here. See below how to format your code accordingly.

Doxygen

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

Build system (cmake) and directory structure

The code organisation is described here. The build system (cmake) is described here.

Formatting

The project uses clang-format to push for a common code formatting according the the clang-format configuration files in this repository. With an adiabatic approach, all changes have to follow the formatting rules. A tool script can be used to integrate the formatting into git and suggest formatting only for changed lines.

Install clang-format

Use alienv to load clang which includes clang-format : alienv load Clang/latest If Clang is not yet build, use alibuild : aliBuild build --defaults o2 Clang If you use your own clang installation, make sure you have at least version 3.9.

Install clang-format git integration

The git-clang-format Python script integrates clang-format into git. Put it somewhere in your path and ensure that it is executable, e.g.

cd $HOME
mkdir -p bin
cd bin
wget llvm.org/svn/llvm-project/cfe/trunk/tools/clang-format/git-clang-format
chmod u+x git-clang-format

Note: installation of the script will be added to build of AliceO2 software stack.

Checking formatting

Now, git clang-format will invoke clang-format on the changes in current files or a specific commit. E.g. for the last commit

git clang-format HEAD~1

Or for all commits done with respect to the remote branch state

git clang-format origin/dev
Checking files

Show updated version of complete file :

clang-format -style=file SOURCEFILE

Directly apply the style to file :

clang-format -style=file -i SOURCEFILE

Using an IDE

A number of config files are available here for various IDEs.