liuyaozhang/PythonInterfaceOOP

OOP based PWG-DQ User Interface (CLI) Development in Python

User Python Based Interface

\tableofcontents

This project includes python based user interface development for PWG-DQ Workflows based on nightly-20221212. You can follow the instructions and you can find tutorials in table of contents (For prerequisites, Installation guide for argcomplete and Some Informations good to know).

Contact

Ionut Cristian Arsene (Owner of O2DQWorkflows)

Cevat Batuhan Tolon (Author Of Interface)

LATEST CHANGES (VERY IMPORTANT!!!)

On 25/11/2022, serious changes occurred in the naming rules of the O2-DQ Framework. Interface has been updated to use naming conventions on and after this date. If you are using an older O2 version, pull the scripts from old commits. It is recommended to update O2Physics instead.

Reference 1: AliceO2Group/O2Physics#1520

Reference 2 : AliceO2Group/O2Physics#1534

Important

Since the interface is constantly updated for stability, it is recommended to update it with git pull --rebase command

Table Of Contents

• Python Scripts And JSON Configs
  • Main Python Scripts
  • Config Files
  • DQ Interface Scripts
  • Common Deps Interface Scripts
  • Extra Modules
• Prerequisites!!!
  • Cloning repository
  • argcomplete - Bash tab completion for argparse
  • Instalation Guide For argcomplete
    • Prerequisites Before Installation argcomplete Package For Linux Based Systems and LXPLUS
    • Local Instalation (Not Need For O2)
    • O2 Installation
    • Prerequisites Before Installation argcomplete Package For MacOS Based Systems
    • Local Instalation (Not Need For O2)
    • O2 Installation
• Instructions for TAB Autocomplete
• Technical Informations
  • Helper Command Functionality
  • Some Things You Should Be Careful For Using and Development
  • Some Notes Before The Instructions
  • Interface Modes: JSON Overrider and JSON Additional
• Instructions for Python Scripts
  • Download CutsLibrary, MCSignalLibrary, MixingLibrary From Github
  • Get CutsLibrary, MCSignalLibrary, MixingLibrary From Local Machine
  • Available configs in DownloadLibs.py Interface
• Instructions for runTableMaker/runTableMakerMC.py
  • Available configs in runTableMaker Interface
• Instructions for runTableReader.py
  • Available configs in runTableReader Interface
• Instructions for runDQEfficiency.py
  • Available configs in runDQEfficiency Interface
• Instructions for runFilterPP.py
  • Available configs in runFilterPP Interface
• Instructions for runDQFlow.py
  • Available configs in runDQFlow Interface
• Tutorial Part
  • Download Datas For Tutorials
    • Workflows In Tutorials
    • Skimmed Datas In Tutorials
    • Pre-Made JSON configuration Files In Tutorials
  • MC Part
    • Run tableMakerMC on LHC21i3d2 (jpsi to MuMu pp Run3Simulation)
    • Run dqEfficiency on MC (LHC21i3d2 pp Run3Simulation)
    • Run tablemakerMC on LHC21i3b (Prompt jpsi to dielectron pp Run3Simulation)
    • Run dqEfficiency on MC (LHC21i3b pp Run3Simulation)
    • Run tablemakerMC on LHC21i3f2 (Non-Prompt jpsi to dielectron pp Run3Simulation)
    • Run dqEfficiency on LHC21i3f2 (LHC21i3f2 pp Run3Simulation)
  • Data Part
    • Run tableMaker on LHC15o (LHC15o PbPb Run2Data)
    • Run tableReader on LHC15o (LHC15o PbPb Run2Data)
    • Run tableMaker on LHC15o With Generic Flow Analysis (LHC15o PbPb Run2Data)
    • Run tableReader on LHC15o with Generic Flow Analysis (LHC15o PbPb Run2Data)
    • Run dqFlow on LHC15o (LHC15o PbPb Run2Data)
    • Run v0Selector on LHC15o (LHC15o PbPb Run2Data)
    • Run tableMaker on LHC22c (LHC22c pp Run3Data)
    • Run tableReader on Data (LHC22c pp Run3Data)
    • Run filterPP on fwdprompt(fwdprompt pp Run3Data)
  • Special Part : Dilepton Analysis For Non-Standart Existing Workflows in DQ
    • MC : Dilepton Track Analysis (On Bc Simulation)
    • Data : Dilepton Hadron Analysis (On PbPb Data LHC15o)
• Developer Guide
  • Naming Conventions
• TroubleshootingTreeNotFound
  • Converters
  • add_track_prop

TODO LIST

• Add developer guide (for contributing) chapter
• Maintaince need for available configs part (v0selector is missing)
• Needed to explain O2-DQ Data Model and Workflow