[a10293e] | 1 | [![CI](https://github.com/delphes/delphes/actions/workflows/ci.yml/badge.svg)](https://github.com/delphes/delphes/actions/workflows/ci.yml) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.821635.svg)](https://doi.org/10.5281/zenodo.821635)
|
---|
[7b720ac] | 2 |
|
---|
[d836f45] | 3 | Delphes
|
---|
| 4 | =======
|
---|
[fe6bd24] | 5 |
|
---|
[d836f45] | 6 | Delphes is a C++ framework, performing a fast multipurpose detector response simulation.
|
---|
[deecda3] | 7 |
|
---|
[d836f45] | 8 | More details can be found on the Delphes website http://cp3.irmp.ucl.ac.be/projects/delphes
|
---|
[816b1a9] | 9 |
|
---|
| 10 | Quick start with Delphes
|
---|
| 11 | ========================
|
---|
| 12 |
|
---|
| 13 | Commands to get the code:
|
---|
| 14 |
|
---|
| 15 | ```
|
---|
[69da136] | 16 | wget http://cp3.irmp.ucl.ac.be/downloads/Delphes-3.4.2.tar.gz
|
---|
[816b1a9] | 17 |
|
---|
[69da136] | 18 | tar -zxf Delphes-3.4.2.tar.gz
|
---|
[816b1a9] | 19 | ```
|
---|
| 20 |
|
---|
| 21 | Commands to compile the code:
|
---|
| 22 |
|
---|
| 23 | ```
|
---|
[69da136] | 24 | cd Delphes-3.4.2
|
---|
[816b1a9] | 25 |
|
---|
| 26 | make
|
---|
| 27 | ```
|
---|
| 28 |
|
---|
| 29 | Finally, we can run Delphes:
|
---|
| 30 |
|
---|
| 31 | ```
|
---|
| 32 | ./DelphesHepMC
|
---|
| 33 | ```
|
---|
| 34 |
|
---|
| 35 | Command line parameters:
|
---|
| 36 |
|
---|
| 37 | ```
|
---|
| 38 | ./DelphesHepMC config_file output_file [input_file(s)]
|
---|
| 39 | config_file - configuration file in Tcl format
|
---|
| 40 | output_file - output file in ROOT format,
|
---|
| 41 | input_file(s) - input file(s) in HepMC format,
|
---|
| 42 | with no input_file, or when input_file is -, read standard input.
|
---|
| 43 | ```
|
---|
| 44 |
|
---|
| 45 | Let's simulate some Z->ee events:
|
---|
| 46 |
|
---|
| 47 | ```
|
---|
| 48 | wget http://cp3.irmp.ucl.ac.be/downloads/z_ee.hep.gz
|
---|
| 49 | gunzip z_ee.hep.gz
|
---|
| 50 | ./DelphesSTDHEP cards/delphes_card_CMS.tcl delphes_output.root z_ee.hep
|
---|
| 51 | ```
|
---|
| 52 |
|
---|
| 53 | or
|
---|
| 54 |
|
---|
| 55 | ```
|
---|
| 56 | curl -s http://cp3.irmp.ucl.ac.be/downloads/z_ee.hep.gz | gunzip | ./DelphesSTDHEP cards/delphes_card_CMS.tcl delphes_output.root
|
---|
| 57 | ```
|
---|
| 58 |
|
---|
[44b0a31] | 59 | For more detailed documentation, please visit https://cp3.irmp.ucl.ac.be/projects/delphes/wiki/WorkBook
|
---|
[816b1a9] | 60 |
|
---|
| 61 | Configure Delphes on lxplus.cern.ch
|
---|
| 62 | ====================================
|
---|
| 63 |
|
---|
| 64 | ```
|
---|
| 65 | git clone git://github.com/delphes/delphes.git Delphes
|
---|
| 66 |
|
---|
| 67 | cd Delphes
|
---|
| 68 |
|
---|
[e1e72fd] | 69 | source /cvmfs/sft.cern.ch/lcg/app/releases/ROOT/6.06.00/x86_64-centos7-gcc49-opt/root/bin/thisroot.sh
|
---|
[816b1a9] | 70 |
|
---|
[e1e72fd] | 71 | source /cvmfs/sft.cern.ch/lcg/contrib/gcc/4.9.3/x86_64-centos7/setup.sh
|
---|
[816b1a9] | 72 |
|
---|
| 73 | make
|
---|
| 74 | ```
|
---|
| 75 |
|
---|
| 76 | Simple analysis using TTree::Draw
|
---|
| 77 | =================================
|
---|
| 78 |
|
---|
[44b0a31] | 79 | Now we can start [ROOT](root.cern) and look at the data stored in the output ROOT file.
|
---|
[816b1a9] | 80 |
|
---|
| 81 | Start ROOT and load Delphes shared library:
|
---|
| 82 |
|
---|
| 83 | ```
|
---|
| 84 | root -l
|
---|
| 85 | gSystem->Load("libDelphes");
|
---|
| 86 | ```
|
---|
| 87 |
|
---|
| 88 | Open ROOT file and do some basic analysis using Draw or TBrowser:
|
---|
| 89 |
|
---|
| 90 | ```
|
---|
[7ce5d1c] | 91 | TFile *f = TFile::Open("delphes_output.root");
|
---|
| 92 | f->Get("Delphes")->Draw("Electron.PT");
|
---|
[816b1a9] | 93 | TBrowser browser;
|
---|
| 94 | ```
|
---|
| 95 |
|
---|
[44b0a31] | 96 | Notes:
|
---|
| 97 | * ```Delphes``` is the tree name. It can be learned e.g. from TBrowser.
|
---|
| 98 | * ```Electron```is the branch name; ```PT``` is a variable (leaf) of this branch.
|
---|
[816b1a9] | 99 |
|
---|
[44b0a31] | 100 | Complete description of all branches can be found in [doc/RootTreeDescription.html](doc/RootTreeDescription.html).
|
---|
| 101 | This information is also available [in the workbook](https://cp3.irmp.ucl.ac.be/projects/delphes/wiki/WorkBook/RootTreeDescription).
|
---|
[816b1a9] | 102 |
|
---|
| 103 | Macro-based analysis
|
---|
| 104 | ====================
|
---|
| 105 |
|
---|
| 106 | Analysis macro consists of histogram booking, event loop (histogram filling),
|
---|
| 107 | histogram display.
|
---|
| 108 |
|
---|
| 109 | Start ROOT and load Delphes shared library:
|
---|
| 110 |
|
---|
| 111 | ```
|
---|
| 112 | root -l
|
---|
| 113 | gSystem->Load("libDelphes");
|
---|
| 114 | ```
|
---|
| 115 |
|
---|
| 116 | Basic analysis macro:
|
---|
| 117 |
|
---|
| 118 | ```
|
---|
| 119 | {
|
---|
| 120 | // Create chain of root trees
|
---|
| 121 | TChain chain("Delphes");
|
---|
| 122 | chain.Add("delphes_output.root");
|
---|
| 123 |
|
---|
| 124 | // Create object of class ExRootTreeReader
|
---|
| 125 | ExRootTreeReader *treeReader = new ExRootTreeReader(&chain);
|
---|
| 126 | Long64_t numberOfEntries = treeReader->GetEntries();
|
---|
| 127 |
|
---|
| 128 | // Get pointers to branches used in this analysis
|
---|
| 129 | TClonesArray *branchElectron = treeReader->UseBranch("Electron");
|
---|
| 130 |
|
---|
| 131 | // Book histograms
|
---|
| 132 | TH1 *histElectronPT = new TH1F("electron pt", "electron P_{T}", 50, 0.0, 100.0);
|
---|
| 133 |
|
---|
| 134 | // Loop over all events
|
---|
| 135 | for(Int_t entry = 0; entry < numberOfEntries; ++entry)
|
---|
| 136 | {
|
---|
| 137 |
|
---|
| 138 | // Load selected branches with data from specified event
|
---|
| 139 | treeReader->ReadEntry(entry);
|
---|
| 140 |
|
---|
| 141 | // If event contains at least 1 electron
|
---|
| 142 | if(branchElectron->GetEntries() > 0)
|
---|
| 143 | {
|
---|
| 144 | // Take first electron
|
---|
| 145 | Electron *electron = (Electron*) branchElectron->At(0);
|
---|
| 146 |
|
---|
| 147 | // Plot electron transverse momentum
|
---|
| 148 | histElectronPT->Fill(electron->PT);
|
---|
| 149 |
|
---|
| 150 | // Print electron transverse momentum
|
---|
| 151 | cout << electron->PT << endl;
|
---|
| 152 | }
|
---|
| 153 |
|
---|
| 154 | }
|
---|
| 155 |
|
---|
| 156 | // Show resulting histograms
|
---|
| 157 | histElectronPT->Draw();
|
---|
| 158 | }
|
---|
| 159 | ```
|
---|
| 160 |
|
---|
| 161 | More advanced macro-based analysis
|
---|
| 162 | ==================================
|
---|
| 163 |
|
---|
[44b0a31] | 164 | The 'examples' directory contains ROOT macros [Example1.C](examples/Example1.C), [Example2.C](examples/Example2.C) and [Example3.C](examples/Example3.C).
|
---|
[816b1a9] | 165 |
|
---|
| 166 | Here are the commands to run these ROOT macros:
|
---|
| 167 |
|
---|
| 168 | ```
|
---|
| 169 | root -l
|
---|
| 170 | .X examples/Example1.C("delphes_output.root");
|
---|
| 171 | ```
|
---|
| 172 |
|
---|
| 173 | or
|
---|
| 174 |
|
---|
| 175 | ```
|
---|
| 176 | root -l examples/Example1.C'("delphes_output.root")'
|
---|
| 177 | ```
|
---|