AliceO2Group/QualityControl · GitHub

This is the repository of the data quality control (QC) software for the ALICE O2 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
    • Post-processing example
• Modules development
  • Context
    • QC architecture
    • DPL
    • Data Sampling
    • Code Organization
    • Developing with aliBuild/alienv
    • User-defined modules
    • Repository
  • Module creation
  • Test run
  • Modification of the Task
  • Check
    • Configuration
    • Implementation
    • Results
  • Quality Aggregation
    • Quick try
    • Configuration
    • Implementation
  • Naming convention
  • Committing code
  • Data sources
  • Run number and other run attributes (period, pass type, provenance)
  • A more advanced example
• Framework
  • Plugging the QC to an existing DPL workflow
  • Production of QC objects outside this framework
  • Multi-node setups
  • Batch processing
  • Moving window
  • Monitor cycles
  • Custom merging
  • Critical, resilient and non-critical tasks
  • QC with DPL Analysis
  • Propagating Check results to RCT in Bookkeeping
  • Solving performance issues
  • Understanding and reducing memory footprint
  • Monitoring
• Post-processing
  • The post-processing framework
    • Post-processing interface
    • Configuration
    • Running it
  • Convenience classes
    • The TrendingTask class
    • The SliceTrendingTask class
    • The ReferenceComparatorTask class
    • The CcdbInspectorTask class
    • The QualityTask class
    • The BigScreen class
  • More examples
• Configuration reference
  • Global configuration structure
  • Common configuration
  • QC Tasks configuration
  • QC Checks configuration
  • QC Aggregators configuration
  • QC Post-processing configuration
  • External tasks configuration
  • Merging multiple configuration files into one
  • Templating config files
  • Definition and access of simple user-defined task configuration ("taskParameters")
  • Definition and access of user-defined configuration ("extendedTaskParameters")
• QCDB and CCDB
  • QCDB vs CCDB
  • Details on the data storage format in the QCDB
  • Custom metadata for QC objects in the QCDB
  • Instructions to move an object in the QCDB
  • Accessing objects in CCDB
  • Access GRP objects with GRP Geom Helper
  • Global Tracking Data Request helper
  • Local CCDB 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
  • Reference data
• Miscellaneous
  • Asynchronous Data and Monte Carlo QC operations
  • QCG
  • Data Sampling monitoring
  • Monitoring metrics
  • Common check IncreasingEntries
  • Common check TrendCheck
  • Update the shmem segment size of a detector
  • Readout chain
  • Writing a DPL data producer

• By email at alice-o2-qc-support@cern.ch
• Discourse: https://alice-talk.web.cern.ch/
• JIRA: https://alice.its.cern.ch
• O2 development newcomers' guide: https://aliceo2group.github.io/quickstart