README.md

This is the repository of the data quality control (QC) software for the ALICE O² system.

For a general overview of our (O2) software, organization and processes, please see this page.

• QuickStart
  • Read this first!
  • Requirements
  • Setup
    • Environment loading
  • Execution
    • Basic workflow
    • Readout chain
    • Post-processing example
• Modules development
  • Context
    • QC architecture
    • DPL
    • Data Sampling
      • Custom Data Sampling Condition
      • Bypassing the Data Sampling
    • Code Organization
    • Developing with aliBuild/alienv
    • User-defined modules
    • Repository
      • Paths
  • Module creation
  • Test run
    • Saving the QC objects in a local file
  • Modification of the Task
  • Check
    • Configuration
    • Implementation
  • Quality Aggregation
    • Quick try
    • Configuration
    • Implementation
  • Naming convention
  • Committing code
  • Data sources
    • Readout
    • DPL workflow
  • Run number and other run attributes (period, pass type, provenance)
  • A more advanced example
  • Monitoring
• Post-processing
  • The post-processing framework
    • Post-processing interface
    • Configuration
    • Running it
  • Convenience classes
    • The TrendingTask class
    • The SliceTrendingTask class
    • The TRFCollectionTask class
  • More examples
• Advanced topics
  • Framework
    • Plugging the QC to an existing DPL workflow
    • Production of QC objects outside this framework
    • Multi-node setups
    • Batch processing
    • Moving window
    • Writing a DPL data producer
    • Custom merging
    • QC with DPL Analysis
  • Solving performance issues
  • CCDB / QCDB
    • Access run conditions and calibrations from the CCDB
    • Access GRP objects with GRP Geom Helper
    • Custom metadata
    • Details on the data storage format in the CCDB
    • Local CCDB setup
  • Asynchronous Data and Monte Carlo QC operations
  • QCG
    • Display a non-standard ROOT object in QCG
    • Canvas options
    • Local QCG (QC GUI) setup
  • FLP Suite
    • Developing QC modules on a machine with FLP suite
    • Switch detector in the workflow readout-dataflow
    • Get all the task output to the infologger
    • Using a different config file with the general QC
    • Enable the repo cleaner
  • Configuration
    • Merging multiple configuration files into one
    • Definition and access of task-specific configuration
    • Configuration files details
  • Miscellaneous
    • Data Sampling monitoring
    • Monitoring metrics
    • Common check IncreasingEntries
• Frequently asked questions
  • Git
    • Are there instructions how to use Git ?
  • Coding Guidelines
    • Where are the Coding Guidelines ?
    • How do I check my code or apply the guidelines ?
  • Build
    • How do I add a dependency to my module ?
    • How do I make my module depend on library XXX from AliceO2 ?
  • Run
    • Why are my QC processes using 100% CPU ?
  • QCDB
    • How to see which objects are stored in the CCDB ?
    • How to delete objects from the CCDB ?
    • My objects are not stored due to their size. What can I do ?

Where to get help

• Discourse: https://alice-talk.web.cern.ch/
• JIRA: https://alice.its.cern.ch
• O2 development newcomers' guide: https://aliceo2group.github.io/quickstart
• Doxygen: https://aliceo2group.github.io/QualityControl/
• CERN Mailing lists: alice-o2-wp7 and alice-o2-qc-contact