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 (optional)
    • 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
  • Definition and access of user-specific configuration
    • Running it
  • Convenience classes
    • The TrendingTask class
    • The SliceTrendingTask class
    • The QualityTask class
    • The TRFCollectionTask class
    • The BigScreen 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
    • Monitor cycles
    • Writing a DPL data producer
    • Custom merging
    • Critical, resilient and non-critical tasks
    • QC with DPL Analysis
      • Uploading objects to QCDB
      • Getting AODs in QC Tasks
      • Merging with other analysis workflows
      • Enabling a workflow to run on Hyperloop
  • Solving performance issues
    • Dispatcher
    • QC Tasks
    • Mergers
  • Understanding and reducing memory footprint
    • Analysing memory usage with valgrind
  • CCDB / QCDB
    • Accessing objects in CCDB
    • Access GRP objects with GRP Geom Helper
    • Global Tracking Data Request helper
    • Custom metadata
    • Details on the data storage format in the CCDB
    • Local CCDB setup
    • Instructions to move an object in the QCDB
  • 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 simple user-defined task configuration ("taskParameters")
    • Definition and access of user-defined configuration ("extendedTaskParameters")
    • Definition of new arguments
    • Configuration files details
      • Global configuration structure
      • Common configuration
      • QC Tasks configuration
      • QC Checks configuration
      • QC Aggregators configuration
      • QC Post-processing configuration
      • External tasks configuration
  • Miscellaneous
    • Data Sampling monitoring
    • Monitoring metrics
    • Common check IncreasingEntries
    • Update the shmem segment size of a detector

Where to get help

• 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