Files and folders

Files and folders

Overview of files and folders

This is only a short description of files and folders:

• ci/: Contains continuous integration configuration for Travis CI and Codecov IO
• cmake/: Contains build configuration for CMake
• database/: Empty location of (calibration) databases. Everything is ignored inside this folder (do not git add anything to the source repository) except the README.md, which you should read.
• doc/: Additional documentation files.
• extra/: Contains helper scripts and macros, such as AntSubmit and AntSimSubmit, or BrowseHistograms.C.
• progs/: Contains executable source files, such as Ant or Ant-plot, using components from src/.
• src/: The main folder with all the work in form of many, many lines of code. See below.
• test/: The code testing the code.
• third-party/: Everything used by Ant, such as TCLAP or Catch, kept separate to make updates easy.

The src folder organization

The subfolders of src/ define the main components of the Ant framework.

• src/base/: Helpful little snippets used by everything else.
• src/tree/: TEventdata structure and its sub-structuresTEventData`.
• src/unpacker/': "Raw file" to Ant TEvent` data structure converters
• src/calibration/: Calibration modules used by expconfig
• src/expconfig/: Description of experimental setup and configuration. Detectors, Needed Calibrations, etc.
• src/reconstruct/: Reconstruction of events from raw detector readhits. Uses calibration and expconfig
• src/analysis/: Analysis and processing of TEvent data, physics classes live here and use common utilities.
• src/mc: Monte-Carlo simulation (mostly Pluto) related code
• src/root-addons: Code strongly tied to CERN ROOT, usually macros and extra CINT objects