Studying Particle Flow with Fireworks

COLIN: for some how-to's, upload a video on youtube?

Overview

This page explains how to set up an experimental version of Fireworks, to study the particle flow reconstruction. To display the particles created by the particle flow algorithm, just use the standard version of Fireworks. This includes:

  • PFCandidates
  • PFJets

In addition to this however, you can use a modified version of Fireworks which is designed to help you understand how the particle flow algorithm identifies and reconstructs particles, using the following inputs:

  • ECAL and HCAL rechits
  • PFClusters
  • Tracks, with their extrapolated position in the calorimeters
  • PFBlocks

Installation recipes

Depending upon what you wish to do with the software there are two installation recipes. The first shows how to acquire the binary files needed if you only wish to run the event display. This is the easiest and quickest method to start displaying events. The second installation recipe truly allows you to get the most up-to-date source code, make your own modifications and re-compile (see here for more information on FWLite).

NB: If you only wish to display events and don't need access to source code and/or you are working on your own machine then it is highly recommended that you follow the first set of installation instructions.

Start by explaining how to set up cvs

Prerequisite: setting up CVS

Installation Recipe 1 - cmsShow 4.2

1. Use the download link here or in a terminal run

 wget http://cern.ch/cmsshow/cmsShow-4.2.linux.tar.gz 

2. Run the following commands in the directory to which you just downloaded the tarball:

   tar xzf cmsShow-4.2.linux.tar.gz
   cd cmsShow-4.2
   ./cmsShow data.root

explain how to get the two fwc files in the current directory.

Installation Recipe 2 - Current release with FWlite: 4_2_3

In order to use this installation recipe there are a few prerequisites that need to be met.

  • You are either:
    • working on a mac with xcode installed,
    • using an slc5 terminal or have access to an slc5 terminal (e.g. ssh username@lxplus.cern.ch)
    • using the chroot method explained here.

To install simply follow the instructions below. More information on the installation can be found at the standard Fireworks page.

Linux:

  wget http://cmsrep.cern.ch/cms/cpt/Software/download/cms/TARS/slc5_amd64_gcc434/CMSSW_4_2_3_FWLITE-slc5_amd64_gcc434.tar.gz
  tar xzf CMSSW_4_2_3_FWLITE-slc5_amd64_gcc434.tar.gz
  cd CMSSW_4_2_3_FWLITE
  ./install.sh
  ./cmsShow   http://cern.ch/fireworks/data-4.2.root

Mac:

  curl -OL http://cmsrep.cern.ch/cms/cpt/Software/download/cms/TARS/osx106_amd64_gcc421/CMSSW_4_2_3_FWLITE-osx106_amd64_gcc421.tar.gz
  tar xzf CMSSW_4_2_3_FWLITE-osx106_amd64_gcc421.tar.gz
  cd CMSSW_4_2_3_FWLITE
  ./install.sh
  ./cmsShow  http://cern.ch/fireworks/data-4.2.root 

explain how to get the two fwc files in the current directory

Getting Fireworks Code from CVS

If you wish to access the particle flow source code then you can grab this from the cvs repositories using the instructions below.

NB: It is assumed that you have installed the cvs software on your machine!

Firstly, two environment variables must be set so that your machine knows where and how to access the repositories. (If you only wish to have access to the cvs repositories but don't want the source code then this part is all you need to do)

   export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW
   export CVS_RSH=ssh

COLIN: the following should be part of the second recipe

Now that you have access to the repositories you simply need to grab the code!

   cd CMSSW_4_2_3_FWlLite/work/CMSSW_4_2_3_FWLite/src/
   cvs co Fireworks/ParticleFlow

That's it! The particle flow source code can now be found in the directory

CMSSW_4_2_3_FWlLite/work/CMSSW_4_2_3_FWLite/src/Fireworks/ParticleFlow

Compilation

COLIN: Put that in the second recipe

If you make any changes to the source code that you acquire then you will probably want to compile and see the affects of those changes.

NB: The compilation is done using the scram tool and hence, you should at least have some knowledge of it's basic useage.

In the 'CMSSW_4_2_3_FWLite' directory (e.g. ~/Documents/CMSSW_4_2_3_FWLite) run the following commands:

   . fwlite_setup.sh
   cd work/CMSSW_4_2_3_FWLite/src/
   scram b

How-to

How to get a display of PFCandidates and particle-flow based physics objects

Firstly, you must have access to the cvs repositories because you will be grabbing a configuration file from there. Once that is taken care of simply follow the steps below:

The first command is different depending upon the installation recipe that you used so please choose appropriately.

For cmsShow 4.2 (recipe 1):

 cd cmsShow-4.2/ 

COLIN: make the identation uniform

For FWLite (recipe 2):

 cd CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE/src/ 

   cvs co Fireworks/Core/macros/pflow.fwc
   mv Fireworks/Core/macros/pflow.fwc ../../../
   cd ../../../

COLIN: You should use symlinks, and not force people to change directory. and move that to the 2 recipes

ln -s Fireworks/Core/macros/pflow.fwc

You should now be back in the CMSSW_4_2_3 directory and ready to run cmsShow with your newly acquired configuration file.

   ./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root

Once acquired, the particle flow configuration file can also be loaded during runtime. In the main Fireworks interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window open pflow.fwc.

How to get a display of the particle flow inputs

  • Remind what are the particle flow inputs, and how the PF algorithm works. Links to the particle flow algorithm [COLIN]
  • Simple how-to showing how to start with another pflow_algo.fwc, to be created [SIMON]

In order to quickly display the particle flow inputs

  • ECAL and HCAL rechits
  • PFClusters
  • Tracks, with their extrapolated position in the calorimeters
  • PFBlocks

then you can use a method similar to the one shown in the previous section.

The first command is different depending upon the installation recipe that you used so please choose appropriately.

For cmsShow 4.2 (recipe 1):

 cd cmsShow-4.2/ 

For FWLite (recipe 2):

 cd CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE/src/ 

   cvs co Fireworks/Core/macros/pflow_algo.fwc
   mv Fireworks/Core/macros/pflow_algo.fwc ../../../
   cd ../../../

You should now be back in the CMSSW_4_2_3 directory and ready to run cmsShow with your newly acquired configuration file.

COLIN: only the following is necessary here. Add a screenshot of what people should get?

   ./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root

Wish-list & bug reports

-- ColinBernet - 08-Feb-2011

Edit | Attach | Watch | Print version | History: r33 | r18 < r17 < r16 < r15 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r16 - 2011-05-26 - ColinBernet


ESSENTIALS

ADVANCED TOPICS


 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    CMSPublic All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback