Instructions For Python Scripts

Table of Contents

• Instructions for DownloadLibs.py
  • 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/runTableMakerMC 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

Instructions for DownloadLibs.py

Download CutsLibrary, MCSignalLibrary, MixingLibrary From Github

VERY IMPORTANT P.S: Downloading DQ libraries from Github is unstable and has a lot of issues. So use DownloadLibs.py script locally if you are working at local machine. It is highly recommended to skip this part directly and go to Get CutsLibrary, MCSignalLibrary, MixingLibrary From Local Machine (You cannot use the Local option for LXPLUS, use this part if you are working in LXPLUS).

These libraries must be downloaded for validation and autocomplete. After the argscomplete package is installed and sourced, they will be downloaded automatically if you do an one time autocomplete operation with the TAB key and the name of the script in the terminal. If you cannot provide this, the DownloadLibs.py script in the NewAllWorkFlows folder can do it manually. To run this script, simply type the following on the command line.

P.S. Don't forget source your argcomplete Before the using this script. --> source argcomplete.sh

python3 DownloadLibs.py

For tag version based download (depends your production) e.g for nightly-20220619, just enter as 20220619:

python3 DownloadLibs.py --version 20220619

If the libraries are downloaded successfully you will get this message:

[INFO] Libraries downloaded successfully!

Get CutsLibrary, MCSignalLibrary, MixingLibrary From Local Machine

These libraries must be downloaded for validation and autocomplete. Instead of downloading libraries from github, you can configure the DownloadLibs.py script to pull the DQ libraries locally from the alice software on the existing computer. This option will not work on LXPLUS. if you are working on a local machine always use this option.

P.S. Don't forget source your argcomplete Before the using this script. --> source argcomplete.sh

Ex. Usage for Working Locally:

python3 DownloadLibs.py --local

In this configuration, the location of alice software is defaulted to /home/<user>/alice. If your alice software folder has a different name or is in a different location, you can configure it with the –localPath parameter. Ex. Usage for different path

python3 DownloadLibs.py --local --localPath alice-software

So with this configuration, your alice software path is changed to /home/<user>/alice-software. Another ex.

python3 DownloadLibs.py --version 20220619 --local --localPath Software/alice

So with this configuration, your alice software path is changed to /home/<user>/Sofware/alice

If the DQ libraries are pulled from local alice software successfully you will get this message:

[INFO] DQ Libraries pulled from local alice software successfully!

We have many logger message for this interface. If you have a problem with configuration, you can find the solution very easily by following the logger messages here. This solution is completely stable

Available configs in DownloadLibs.py Interface

Arg	Opt	Local/Online	nargs	ex. usage
-h	No Param	Online and Local	0	python3 DownloadLibs.py -h
--version	all	Online	1	python3 DownloadLibs.py --version 20220619
--debug	NOTSET DEBUG INFO WARNING ERROR CRITICAL	Online and Local	1	python3 DownloadLibs.py --debug INFO
--local	No Param	Local	1	python3 DownloadLibs.py --local
--localPath	all	Local	1	python3 DownloadLibs.py --local --localPath alice-software

• More Details for DownloadLibs.py interface parameters

Arg	Ref Type	Desc	Default	Real Type
-h	No Param	list all helper messages for configurable commands		*
--version	Integer	Online: Your Production tag for O2Physics example: for nightly-20220619, just enter as 20220619	master	str
--debug	string	Online and Local: execute with debug options"	`INFO`	str.upper
`--local`	No Param	Local: Use Local Paths for getting DQ Libraries instead of online github download. If you are working LXPLUS, It will not working so don't configure with option	-	*
`--localPath`	String	Local: Configure your alice software folder name in your local home path. Default is alice. Example different configuration is --localpath alice-software --local --> home/user/alice-software	`alice`	str

Instructions for runTableMaker/runTableMakerMC.py

Add extrac tables and converters with:

1. –add_mc_conv: conversion from o2mcparticle to o2mcparticle_001
2. –add_fdd_conv: conversion o2fdd from o2fdd_001
   • If you get error like this, you should added it in your workflow
   • [ERROR] Exception caught: Couldn't get TTree "DF_2571958947001/O2fdd_001" from "YOURAOD.root". Please check https://aliceo2group.github.io/analysis-framework/docs/troubleshooting/treenotfound.html for more information.
3. –add_track_prop: conversion from o2track to o2track_iu (link)
   • If you get error like this, you should added it in your workflow
   • [ERROR] Exception caught: Couldn't get TTree "DF_2660520692001/O2track" from "Datas/AO2D.root". Please check https:/aliceo2group.github.io/analysis-framework/docs/troubleshooting/treenotfoundhtml for more information.

• Minimum Required Parameter List:
  • python3
  • runTableMaker.py
  • JSON Config File
    • Example usage: configs/configTableMakerDataRun3.json
  • -runData
    • Usage (only select one value): -runMC or -runData
  • --process <Value>
    • Usage examples (can take several value) : --process MuonsOnly or --process BarrelOnly MuonOnly BarrelOnlyWithEventFilter

Examples(in NewAllWorkFlows):

• Run TableMaker on Data run3 With Minimum Commands for Barrel Only (with automation)

  python3 runTableMaker.py configs/configTableMakerDataRun3.json -runData --process BarrelOnly

• Run TableMaker on MC run3 with Minimum Commands for Barrel Only (with automation)

  python3 runTableMakerMC.py configs/configTableMakerMCRun3.json -runMC --process BarrelOnly

• Run TableMaker on Data run2 With Minimum Commands for Barrel Only (with automation)

  python3 runTableMaker.py configs/configTableMakerDataRun2.json -runData --process BarrelOnly

• Run TableMaker on MC run2 with Minimum Commands for Barrel Only (with automation)

  python3 runTableMakerMC.py configs/configTableMakerMCRun2.json -runMC --process BarrelOnly

In case of multiple configs example

python3 runTableMakerMC.py configs/configTableMakerMCRun3.json -runMC --process MuonOnlyWithCov OnlyBCs --cfgMCsignals muFromJpsi Jpsi muFromPsi2S Psi2S --onlySelect true --aod Datas/AO2D.root --cfgMuonCuts muonQualityCuts muonTightQualityCutsForTests --syst pp --onlySelect true --add_track_prop

Available configs in runTableMaker/runTableMakerMC Interface

• For runTableMaker.py and runTableMakerMC.py Selections

Arg	Opt	Task	nargs
-h	No Param	all	0
--aod	all	internal-dpl-aod-reader	1
--aod-memory-rate-limit	all	internal-dpl-aod-reader	1
--onlySelect	true false	Special Option	1
--autoDummy	true false	Special Option	1
--process	Full FullTiny FullWithCov FullWithCent BarrelOnlyWithV0Bits BarrelOnlyWithEventFilter BarrelOnlyWithQvector BarrelOnlyWithCent BarrelOnlyWithCov BarrelOnly MuonOnlyWithCent MuonOnlyWithCov MuonOnly MuonOnlyWithFilter MuonOnlyWithQvector OnlyBCs	table-maker	*
--run	2 3	Special Option	1
-runData	No Param	event-selection-task Special Option	0
-runMC	No Param	event-selection-task Special Option	0
--add_mc_conv	No Param	o2-analysis-mc-converter Special Option	0
--add_fdd_conv	No Param	o2-analysis-fdd-converter Special Option	0
--add_track_prop	No Param	o2-analysis-track-propagation Special Option	0
--syst	pp PbPb pPb Pbp XeXe	event-selection-task	1
--muonSelection	0 1 2	event-selection-task	1
--CustomDeltaBC	all	event-selection-task	1
--isVertexZeq	true false	multiplicity-table	1
--isCovariance	true false	track-propagation	1
--isWSlice	true false	tof-pid-full tof-pid	1
--FT0	FT0 NOFT0 OnlyFT0 Run2	tof-event-time	1
--tof-expreso	all	tof-pid-beta	1
--isBarrelSelectionTiny	true false	d-q-barrel-track-selection-task	1
--est	Run2V0M Run2SPDtks Run2SPDcls Run2CL0 Run2CL1 FV0A FT0M FDDM NTPV	centrality-table	*
--cfgWithQA	true false	d-q-barrel-track-selection-task d-q-event-selection-task d-q-event-selection-task d-q-filter-p-p-task analysis-qvector	1
--d_bz	all	v0-selector	1
--v0cospa	all	v0-selector	1
--dcav0dau	all	v0-selector	1
--v0Rmin	all	v0-selector	1
--v0Rmax	all	v0-selector	1
--dcamin	all	v0-selector	1
--dcamax	all	v0-selector	1
--mincrossedrows	all	v0-selector	1
--maxchi2tpc	all	v0-selector	1
--cfgCutPtMin	all	analysis-qvector	1
--cfgCutPtMax	all	analysis-qvector	1
--cfgCutEta	all	analysis-qvector	1
--cfgEtaLimit	all	analysis-qvector	1
--cfgNPow	all	analysis-qvector	1
--cfgEfficiency	all	analysis-qvector	1
--cfgAcceptance	all	analysis-qvector	1
--pid	el mu pi ka pr de tr he al	tof-pid tpc-pid	*
--isFilterPPTiny	true false	d-q-filter-p-p-task	1
--cfgBarrelSels	namespacedCuts	d-q-filter-p-p-task	*
--cfgMuonSels	namespacedCuts	d-q-filter-p-p-task	*
--cfgEventCuts	allCuts	table-maker	*
--cfgBarrelTrackCuts	allCuts	table-maker	*
--cfgMuonCuts	allCuts	table-maker	*
--cfgMuonsCuts	allCuts	d-q-muons-selection	*
--cfgBarrelLowPt	all	table-maker	1
--cfgMuonLowPt	all	table-maker	1
--cfgNoQA	true false	table-maker	1
--cfgDetailedQA	true false	table-maker	1
--cfgMinTpcSignal	all	table-maker	1
--cfgMaxTpcSignal	all	table-maker	1
--cfgMCsignals	allSignals	table-maker	*
--debug	NOTSET DEBUG INFO WARNING ERROR CRITICAL	all	1
--logFile	No Param	special option	0

• Details parameters for runTableMaker.py and runTableMakerMC.py

Arg	Ref Type	Desc	Default	Real Type
-h	No Param	list all helper messages for configurable command		*
--aod	String	Add your aod file with path		str
--aod-memory-rate-limit	String	Rate limit AOD processing based on memory		str
--onlySelect	Boolean	An Automate parameter for keep options for only selection in process, pid and centrality table (true is highly recomended for automation)	false	str.lower
--autoDummy	Boolean	Dummy automize parameter (if your selection true, it automatically activate dummy process and viceversa)	true	str.lower
--process	String	process selection for skimmed data model in tablemaker		str
--run	Integer	Data run option for ALICE 2/3		str
-runData	no Param	Data Selection instead of MC		str
-runMC	No Param	MC Selection instead of data		-
--add_mc_conv	No Param	Conversion from o2mcparticle to o2mcparticle_001<		-
--add_fdd_conv	No Param	Conversion o2fdd from o2fdd_001		-
--add_track_prop	No Param	Conversion from o2track to o2track_iu		-
--syst	String	Collision system selection		str
--muonSelection	Integer	0 - barrel, 1 - muon selection with pileup cuts, 2 - muon selection without pileup cuts		str
--CustomDeltaBC	all	custom BC delta for FIT-collision matching		str
--isVertexZeq	Boolean	if true: do vertex Z eq mult table		str.lower
--isCovariance	Boolean	If false, Process without covariance, If true Process with covariance related to track-propagation		str.lower
--isWSlice	Boolean	Process with track slices		str.lower
--FT0	Boolean	FT0: Process with FT0, NoFT0: Process without FT0, OnlyFT0: Process only with FT0, Run2: Process with Run2 data		str.lower
--tof-expreso	Float	Expected resolution for the computation of the expected beta		str
--isBarrelSelectionTiny	Boolean	Run barrel track selection instead of normal(process func. for barrel selection must be true)		str.lower
--est	String	Produces centrality percentiles parameters		str
--cfgWithQA	Boolean	If true, fill QA histograms		str.lower
--d_bz	Float	bz field		str
--v0cospa	Float	v0cospa		str
--dcav0dau	Float	DCA V0 Daughters		str
--v0Rmin	Float	V0min		str
--v0Rmax	Float	V0max		str
--dcamin	Float	dcamin		str
--dcamax	Float	dcamax		str
--mincrossedrows	Float	Min crossed rows		str
--maxchi2tpc	Float	max chi2/NclsTPC		str
--cfgCutPtMin	Float	Minimal pT for tracks		str
--cfgCutPtMax	Float	Maximal pT for tracks		str
--cfgCutEta	Float	Eta range for tracksselection		str
--cfgEtaLimit	Float	Eta gap separation, only if using subEvents		str
--cfgNPow	Integer	Power of weights for Q vector		str
--cfgEfficiency	String	CCDB path to efficiency object		str
--cfgAcceptance	String	CCDB path to acceptance object		str
--pid	String	Produce PID information for the particle mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)		str.lower
--isFilterPPTiny	Boolean	Run filter tiny task instead of normal (processFilterPP must be true)		str.lower
--cfgBarrelSels	String	Configure Barrel Selection track-cut:pair-cut:n,track-cut:pair-cut:n,... example jpsiO2MCdebugCuts2::1		str
--cfgMuonSels	String	Configure Muon Selection muon-cut:[pair-cut]:n example muonQualityCuts:pairNoCut:1		str
--cfgEventCuts	String	Space separated list of event cuts		str
--cfgBarrelTrackCuts	String	Space separated list of barrel track cuts		str
--cfgMuonCuts	String	Space separated list of muon cuts in tablemaker and analysis-qvector		str
--cfgMuonsCuts	String	Space separated list of ADDITIONAL muon track cuts		str
--cfgBarrelLowPt	Float	Specify the lowest pt cut for electrons; used in a Partition expression to improve CPU efficiency (GeV)		str
--cfgMuonLowPt	Float	Specify the lowest pt cut for muons; used in a Partition expression to improve CPU efficiency (GeV)		str
--cfgNoQA	Boolean	If true, no QA histograms		str.lower
--cfgDetailedQA	Boolean	If true, include more QA histograms (BeforeCuts classes and more)		str.lower
--cfgMinTpcSignal	Integer	TPC Min Signal Selection		str
--cfgMaxTpcSignal	Integer	TPC Max Signal Selection		str
--cfgMCsignals	String	Space separated list of MC signals		str
--debug	String	execute with debug options	-	str.upper
--logFile	No Param	Enable logger for both file and CLI	-	-

Instructions for runTableReader.py

• Minimum Required Parameter List:
  • python3
  • runTableReader.py
  • JSON Config File
    • Example For Most common usage: configs/configAnalysisData.json
      

Examples(in NewAllWorkFlows):

• Run TableReader on Data run3 With Minimum Commands

  python3 runTableReader.py configs/configAnalysisData.json

In case of multiple configs example

python3 runTableReader.py configs/configAnalysisData.json --analysis eventSelection trackSelection eventMixing sameEventPairing --process JpsiToEE --cfgTrackCuts jpsiO2MCdebugCuts --aod reducedAod.root --debug debug --logFile

Available configs in runTableReader Interface

Arg	Opt	Task	nargs
-h	No Param	all	0
--aod	all	internal-dpl-aod-reader	1
--autoDummy	true false	Special Option	1
--reader	all	Special Option	1
--writer	all	Special Option	1
--analysis	eventSelection trackSelection muonSelection eventMixing eventMixingVn sameEventPairing dileptonHadron	analysis-event-selection analysis-track-selection analysis-muon-selection analysis-event-mixing analysis-same-event-pairing analysis-dilepton-hadron	*
--mixing	Barrel Muon BarrelMuon BarrelVn MuonVn	analysis-same-event-pairing	*
--process	JpsiToEE JpsiToMuMu JpsiToMuMuVertexing VnJpsiToEE VnJpsiToMuMu ElectronMuon All	analysis-same-event-pairing	*
--syst	pp PbPb pPb Pbp XeXe	event-selection-task	1
--cfgQA	true false	analysis-event-selection analysis-track-selection analysis-muon-selection	1
--cfgMixingVars	allMixingVars	analysis-event-selection	*
--cfgEventCuts	allCuts	analysis-event-selection	*
--cfgTrackCuts	allCuts	analysis-track-selection	*
--cfgMuonCuts	allCuts	analysis-muon-selection	*
--cfgLeptonCuts	true false	analysis-dilepton-hadron	*
--debug	NOTSET DEBUG INFO WARNING ERROR CRITICAL	all	1
--logFile	No Param	special option	0

• Details parameters for runTableReader.py

Arg	Ref Type	Desc	Default	Real Type
-h	No Param	list all helper messages for configurable command		*
--aod	String	Add your AOD File with path	-	str
--autoDummy	Boolean	Dummy automize parameter (if process skimmed false, it automatically activate dummy process and viceversa)	true	str.lower
--reader	String	Add your AOD Reader JSON with path	configs/readerConfiguration_reducedEvent.json	str
--writer	String	Add your AOD Writer JSON with path	configs/writerConfiguration_dileptons.json	str
--analysis	String	Skimmed process selections for analysis	-	str
--mixing	String	Skimmed process selections for Event Mixing manually	-	str
--process	String	Skimmed process Selections for Same Event Pairing	-	str
--isMixingEvent	String	Event Mixing Activate or Disable Option	-	str.lower
--cfgQA	Boolean	If true, fill QA histograms	-	str
--cfgMixingVars	String	Mixing configs separated by a space	-	str
--cfgEventCuts	String	Space separated list of event cuts	-	str
--cfgTrackCuts	String	Space separated list of barrel track cuts	-	str
--cfgMuonCuts	String	Space separated list of muon cuts	-	str
--cfgLeptonCuts	String	Space separated list of barrel track cuts	-	str
--debug	String	execute with debug options	-	str.upper
--logFile	No Param	Enable logger for both file and CLI	-	-

Instructions for runDQEfficiency.py

• Minimum Required Parameter List:
  • python3
  • runDQEfficiency.py
  • JSON Config File
    • Example For Most common usage: configs/configAnalysisMC.json
      

Examples(in NewAllWorkFlows):

• Run DQEfficiency on Data run3 With Minimum Commands

  python3 runDQEfficiency.py configs/configAnalysisMC.json

In case of multiple configs example

python3 runDQEfficiency.py configs/configAnalysisMC.json --analysis muonSelection eventSelection sameEventPairing --aod reducedAod.root --cfgMuonCuts muonQualityCuts muonTightQualityCutsForTests --cfgMuonMCSignals muFromJpsi muFromPsi2S --cfgBarrelMCGenSignals Jpsi Psi2S --cfgBarrelMCRecSignals mumuFromJpsi mumuFromPsi2S dimuon --process JpsiToMuMu --cfgQA true

Available configs in runDQEfficiency Interface

• For runDQEfficiency.py Selections

Arg	Opt	Task	nargs
-h	No Param	all	0
--aod	all	internal-dpl-aod-reader	1
--autoDummy	true false	Special Option	1
--reader	all	Special Option	1
--writer	all	Special Option	1
--analysis	eventSelection trackSelection muonSelection sameEventPairing dileptonTrackDimuonMuonSelection dileptonTrackDielectronKaonSelection	analysis-event-selection analysis-track-selection analysis-muon-selection analysis-same-event-pairing analysis-dilepton-track	*
--process	JpsiToEE JpsiToMuMu JpsiToMuMuVertexing	analysis-same-event-pairing	*
--cfgQA	true false	analysis-event-selection analysis-track-selection analysis-muon-selection	1
--cfgEventCuts	allCuts	analysis-event-selection	*
--cfgTrackCuts	allCuts	analysis-track-selection	*
--cfgTrackMCSignals	allMCSignals	analysis-track-selection	*
--cfgMuonCuts	allCuts	analysis-muon-selection	*
--cfgMuonMCSignals	allMCSignals	analysis-muon-selection	*
--cfgBarrelMCRecSignals	allMCSignals	analysis-same-event-pairing	*
--cfgBarrelMCGenSignals	allMCSignals	analysis-same-event-pairing	*
--cfgFlatTables	true false	analysis-same-event-pairing	1
--cfgLeptonCuts	allCuts	analysis-dilepton-track	*
--cfgFillCandidateTable	true false	analysis-dilepton-track	1
--cfgBarrelDileptonMCRecSignals	allMCSignals	analysis-dilepton-track	*
--cfgBarrelDileptonMCGenSignals	allMCSignals	analysis-dilepton-track	*
--debug	NOTSET DEBUG INFO WARNING ERROR CRITICAL	all	1
--logFile	No Param	special option	0

• Details parameters for runDQEfficiency.py

Arg	Ref Type	Desc	Default	Real Type
-h	No Param	list all helper messages for configurable command		*
--aod	String	Add your AOD File with path	-	str
--autoDummy	Boolean	Dummy automize parameter (if process skimmed false, it automatically activate dummy process and viceversa)	true	str.lower
--reader	String	Add your AOD Reader JSON with path	configs/readerConfiguration_reducedEventMC.json	str
--writer	String	Add your AOD Writer JSON with path	configs/writerConfiguration_dileptonMC.json	str
--analysis	String	Skimmed process selections for analysis	-	str
--process	String	Skimmed process selections for Same Event Pairing	-	str
--cfgQA	Boolean	If true, fill QA histograms	-	str
--cfgEventCuts	String	Space separated list of event cuts	-	str
--cfgTrackCuts	String	Space separated list of barrel track cuts	-	str
--cfgTrackMCSignals	String	Space separated list of MC signals	-	str
--cfgMuonCuts	String	Space separated list of muon cuts	-	str
--cfgMuonMCSignals	String	Space separated list of MC signals	-	str
--cfgBarrelMCRecSignals	String	Space separated list of MC signals (reconstructed)	-	str
--cfgBarrelMCGenSignals	String	Space separated list of MC signals (generated)	-	str
--cfgBarrelDileptonMCRecSignals	String	Space separated list of MC signals (reconstructed) cuts	-	str
--cfgBarrelDileptonMCGenSignals	String	Space separated list of MC signals (generated)cuts	-	str
--debug	String	execute with debug options	-	str.upper
--logFile	No Param	Enable logger for both file and CLI	-	-

Instructions for runFilterPP.py

Add extrac tables and converters with:

1. –add_mc_conv: conversion from o2mcparticle to o2mcparticle_001
2. –add_fdd_conv: conversion o2fdd from o2fdd_001
   • If you get error like this, you should added it in your workflow
   • [ERROR] Exception caught: Couldn't get TTree "DF_2571958947001/O2fdd_001" from "YOURAOD.root". Please check https://aliceo2group.github.io/analysis-framework/docs/troubleshooting/treenotfound.html for more information.
3. –add_track_prop: conversion from o2track to o2track_iu (link)
   • If you get error like this, you should added it in your workflow
   • [ERROR] Exception caught: Couldn't get TTree "DF_2660520692001/O2track" from "Datas/AO2D.root". Please check https:/aliceo2group.github.io/analysis-framework/docs/troubleshooting/treenotfoundhtml for more information.

• Minimum Required Parameter List:
  • python3
  • runFilterPP.py
  • JSON Config File
    • Example For usage: configs/configFilterPPDataRun3.json

Examples(in NewAllWorkFlows):

• Run filterPP on Data run3 With Minimum Commands

  python3 runFilterPP.py configs/configFilterPPDataRun3.json

• Run filterPP on Data run2 With Minimum Commands

  python3 runFilterPP.py configs/configFilterPPDataRun2.json

In case of multiple configs example

python3 runFilterPP.py configs/configFilterPPDataRun3.json --aod AO2D.root --syst pp --process barrelTrackSelection eventSelection --cfgBarrelSels jpsiO2MCdebugCuts2::1 --cfgEventCuts eventStandardNoINT7 --cfgBarrelTrackCuts jpsiO2MCdebugCuts2 jpsiO2MCdebugCuts2 --cfgWithQA true

Available configs in runFilterPP Interface

• For runFilterPP.py Selections

Arg	Opt	Task	nargs
-h	No Param	all	0
--aod	all	internal-dpl-aod-reader	1
--autoDummy	true false	Special Option	1
--process	barrelTrackSelection eventSelection muonSelection barrelTrackSelectionTiny filterPPSelectionTiny	d-q-barrel-track-selection d-q-event-selection-task d-q-muons-selection	*
--add_mc_conv	No Param	o2-analysis-mc-converter Special Option	0
--add_fdd_conv	No Param	o2-analysis-fdd-converter Special Option	0
--add_track_prop	No Param	o2-analysis-track-propagation Special Option	0
--syst	pp PbPb pPb Pbp XeXe	event-selection-task	1
--muonSelection	0 1 2	event-selection-task	1
--CustomDeltaBC	all	event-selection-task	1
--isVertexZeq	true false	multiplicity-table	1
--pid	el mu pi ka pr de tr he al	tof-pid tpc-pid	*
--isWSlice	true false	tof-pid-full tof-pid	1
--tof-expreso	all	tof-pid-beta	1
--FT0	FT0 NOFT0 OnlyFT0 Run2	tof-event-time	1
--cfgWithQA	true false	dq task selection	1
--cfgEventCuts	allCuts	d-q-event-selection-task	*
--cfgBarrelTrackCuts	allCuts	d-q-barrel-track-selection	*
--cfgBarrelSels	namespacedCuts	d-q-filter-p-p-task	*
--cfgMuonSels	namespacedCuts	d-q-filter-p-p-task	*
--cfgMuonsCuts	allCuts	d-q-muons-selection	*
--debug	NOTSET DEBUG INFO WARNING ERROR CRITICAL	all	1
--logFile	No Param	special option	0

• Details parameters for runFilterPP.py

Arg	Ref Type	Desc	Default	Real Type
-h	No Param	list all helper messages for configurable command		*
--aod	String	Add your aod file with path		str
--autoDummy	Boolean	Dummy automize parameter (if process skimmed false, it automatically activate dummy process and viceversa)	true	str.lower
--process	barrelTrackSelection eventSelection muonSelection barrelTrackSelectionTiny filterPPSelectionTiny	dq task selection	*	str
--add_mc_conv	No Param	Conversion from o2mcparticle to o2mcparticle_001<		-
--add_fdd_conv	No Param	Conversion o2fdd from o2fdd_001		-
--add_track_prop	No Param	Conversion from o2track to o2track_iu		-
--syst	String	Collision system selection		str
--muonSelection	Integer	0 - barrel, 1 - muon selection with pileup cuts, 2 - muon selection without pileup cuts		str
--CustomDeltaBC	all	custom BC delta for FIT-collision matching		str
--isVertexZeq	Boolean	if true: do vertex Z eq mult table		str.lower
--pid	String	Produce PID information for the particle mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)		str.lower
--isWSlice	Boolean	Process with track slices		str.lower
--tof-expreso	Float	Expected resolution for the computation of the expected beta		str
--FT0	Boolean	FT0: Process with FT0, NoFT0: Process without FT0, OnlyFT0: Process only with FT0, Run2: Process with Run2 data		str.lower
--cfgWithQA	Boolean	If true, fill QA histograms		str.lower
--cfgEventCuts	String	Space separated list of event cuts		str
--cfgBarrelTrackCuts	String	Space separated list of barrel track cuts		str
--cfgBarrelSels	String	Configure Barrel Selection track-cut:pair-cut:n,track-cut:pair-cut:n,... example jpsiO2MCdebugCuts2::1		str
--cfgMuonSels	String	Configure Muon Selection muon-cut:[pair-cut]:n example muonQualityCuts:pairNoCut:1		str
--cfgMuonsCuts	String	Space separated list of ADDITIONAL muon track cuts		str
--debug	String	execute with debug options	-	str.upper
--logFile	No Param	Enable logger for both file and CLI	-	-

Instructions for runDQFlow.py

• Minimum Required Parameter List:
  • python3
  • runDQFlow.py
  • JSON Config File
    • Example For usage: configs/configFlowDataRun3.json

Examples(in NewAllWorkFlows):

• Run filterPP on Data run3 With Minimum Commands

  python3 runDQFlow.py configs/configFlowDataRun3.json

• Run filterPP on Data run2 With Minimum Commands

  python3 runDQFlow.py configs/configFlowDataRun2.json

In case of multiple configs example

python3 runDQFlow.py configs/configFilterPPDataRun3.json --aod AO2D.root --syst pp --cfgTrackCuts jpsiPID1 --cfgMuonCuts muonQualityCuts --cfgWithQA true --cfgCutPtMin 1 --cfgCutPtMax 15 

Available configs in runDQFlow Interface

Add extrac tables and converters with:

1. –add_mc_conv: conversion from o2mcparticle to o2mcparticle_001
2. –add_fdd_conv: conversion o2fdd from o2fdd_001
   • If you get error like this, you should added it in your workflow
   • [ERROR] Exception caught: Couldn't get TTree "DF_2571958947001/O2fdd_001" from "YOURAOD.root". Please check https://aliceo2group.github.io/analysis-framework/docs/troubleshooting/treenotfound.html for more information.
3. –add_track_prop: conversion from o2track to o2track_iu (link)
   • If you get error like this, you should added it in your workflow
   • [ERROR] Exception caught: Couldn't get TTree "DF_2660520692001/O2track" from "Datas/AO2D.root". Please check https:/aliceo2group.github.io/analysis-framework/docs/troubleshooting/treenotfoundhtml for more information.

• For runDQFlow.py Selections

Arg	Opt	Task	nargs
-h	No Param	all	0
--aod	all	internal-dpl-aod-reader	1
--add_mc_conv	No Param	o2-analysis-mc-converter Special Option	0
--add_fdd_conv	No Param	o2-analysis-fdd-converter Special Option	0
--add_track_prop	No Param	o2-analysis-track-propagation Special Option	0
--syst	pp PbPb pPb Pbp XeXe	event-selection-task	1
--muonSelection	0 1 2	event-selection-task	1
--CustomDeltaBC	all	event-selection-task	1
--pid	el mu pi ka pr de tr he al	tof-pid tpc-pid	*
--est	Run2V0M Run2SPDtks Run2SPDcls Run2CL0 Run2CL1 FV0A FT0M FDDM NTPV	centrality-table	*
--isVertexZeq	true false	multiplicity-table	1
--isWSlice	true false	tof-pid-full tof-pid	1
--tof-expreso	all	tof-pid-beta	1
--FT0	FT0 NOFT0 OnlyFT0 Run2	tof-event-time	1
--cfgWithQA	true false	analysis-qvector	1
--cfgEventCuts	allCuts	analysis-qvector	*
--cfgBarrelTrackCuts	allCuts	analysis-qvector	*
--cfgMuonCuts	allCuts	analysis-qvector	*
--cfgCutPtMin	all	analysis-qvector	1
--cfgCutPtMax	all	analysis-qvector	1
--cfgCutEta	all	analysis-qvector	1
--cfgEtaLimit	all	analysis-qvector	1
--cfgNPow	all	analysis-qvector	1
--cfgEfficiency	all	analysis-qvector	1
--cfgAcceptance	all	analysis-qvector	1
--debug	NOTSET DEBUG INFO WARNING ERROR CRITICAL	all	1
--logFile	No Param	special option	0

• Details parameters for runDQFlow.py

Arg	Ref Type	Desc	Default	Real Type
-h	No Param	list all helper messages for configurable command		*
--aod	String	Add your aod file with path		str
--add_mc_conv	No Param	Conversion from o2mcparticle to o2mcparticle_001<		-
--add_fdd_conv	No Param	Conversion o2fdd from o2fdd_001		-
--add_track_prop	No Param	Conversion from o2track to o2track_iu		-
--syst	String	Collision system selection		str
--muonSelection	Integer	0 - barrel, 1 - muon selection with pileup cuts, 2 - muon selection without pileup cuts		str
--CustomDeltaBC	all	custom BC delta for FIT-collision matching		str
--isVertexZeq	Boolean	if true: do vertex Z eq mult table		str.lower
--isWSlice	Boolean	Process with track slices		str.lower
--est	String	Produces centrality percentiles parameters		str
--pid	String	Produce PID information for the particle mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)		str.lower
--tof-expreso	Float	Expected resolution for the computation of the expected beta		str
--FT0	Boolean	FT0: Process with FT0, NoFT0: Process without FT0, OnlyFT0: Process only with FT0, Run2: Process with Run2 data		str.lower
--cfgWithQA	Boolean	If true, fill QA histograms		str.lower
--cfgEventCuts	String	Space separated list of event cuts		str
--cfgBarrelTrackCuts	String	Space separated list of barrel track cuts		str
--cfgMuonCuts	String	Space separated list of muon cuts		str
--cfgCutPtMin	Float	Minimal pT for tracks		str
--cfgCutPtMax	Float	Maximal pT for tracks		str
--cfgCutEta	Float	Eta range for tracksselection		str
--cfgEtaLimit	Float	Eta gap separation, only if using subEvents		str
--cfgNPow	Integer	Power of weights for Q vector		str
--cfgEfficiency	String	CCDB path to efficiency object		str
--cfgAcceptance	String	CCDB path to acceptance object		str
--debug	String	execute with debug options	-	str.upper
--logFile	No Param	Enable logger for both file and CLI	-	-

TODO v0selector interface instructions will be added.

← Go back to Instructions For Techincal Informations | ↑ Go to the Table of Content ↑ | Continue to Tutorials →