Difference: ParticleFlowFireWorks (1 vs. 33)

Revision 332019-09-09 - CiliciaUzzielPerez

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Line: 31 to 31
 

A Quick Example

Changed:
<
<
You can quickly run a sample dataset. If you are using a conda environment (see other ways to run Fireworks here) run the following commands. The
 --no-version-check 
is applied so that we can safely ignore the CMSSW version that produced it.
>
>
You can quickly run a sample dataset. In this workbook we'll be using CMSSW_10_2_X data. Follow the instructions for installation here. Do not forget to install the header files.

Once installed run

 
Changed:
<
<
conda activate fireworks cmsShow.exe --no-version-check http://cern.ch/fireworks/data-4.2.root
>
>
./cmsShow data.root
 
Deleted:
<
<
In this case the root file here was produced with CMSSW_4_2_2 while we are using CMSSW_10_6_1.
 At the top of the window, you can change navigate the different event by changing the event number. There is also a filter field that allows you to select for example events with muons whose transverse momentum is greater than 20 GeV. You can click on the filter button and type in the event filter expression as "$Muons.pt()>20". If you apply "$Tracks.pt()>1$", you will see that only 9 out of the 15 events are left.

At the left side of the window you should see a summary of the object collections that are shown on the event display. You can check and uncheck the tick boxes to control which collections get displayed. You can also click on the "Add collection" in order to display more collections not currently shown.

Line: 105 to 106
 
META FILEATTACHMENT attachment="pflow_algo_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow_algo.fwc config file" date="1306426602" name="pflow_algo_fwc.png" path="pflow_algo_fwc.png" size="210198" stream="pflow_algo_fwc.png" tmpFilename="/usr/tmp/CGItemp34359" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="AddCollection_AltCand.png" attr="" comment="Add Collection dialog for Alt Candidates" date="1311675802" name="AddCollection_AltCand.png" path="AddCollection_AltCand.png" size="153631" stream="AddCollection_AltCand.png" tmpFilename="/usr/tmp/CGItemp48667" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="altCandidate_display.png" attr="" comment="Alternative Candidate display" date="1311675823" name="altCandidate_display.png" path="altCandidate_display.png" size="149059" stream="altCandidate_display.png" tmpFilename="/usr/tmp/CGItemp48673" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
Added:
>
>
META FILEATTACHMENT attachment="pflow.fwc" attr="" comment="" date="1568000403" name="pflow.fwc" path="pflow.fwc" size="52855" user="ciperez" version="1"
META FILEATTACHMENT attachment="pflow_algo.fwc" attr="" comment="" date="1568000440" name="pflow_algo.fwc" path="pflow_algo.fwc" size="52549" user="ciperez" version="1"

Revision 322019-08-24 - CiliciaUzzielPerez

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Line: 7 to 7
 
Changed:
<
<
This page is under construction. An archive of an older version is found in in this page.
>
>
This page is under construction. An archive of an older version is found in [https://twiki.cern.ch/twiki/bin/view/CMSPublic/ParticleFlowFireWorks?rev=27][in this page]].
 

Overview

Line: 44 to 44
  At the left side of the window you should see a summary of the object collections that are shown on the event display. You can check and uncheck the tick boxes to control which collections get displayed. You can also click on the "Add collection" in order to display more collections not currently shown.
Added:
>
>
The different viewing windows show the rho-z, rho-phi, and eta-phi projections. Once you are happy with the configurations, you have the option to save the images by clicking on the information button.
 

How to load a config file at runtime

Revision 312019-08-24 - CiliciaUzzielPerez

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Line: 30 to 30
 

A Quick Example

Deleted:
<
<

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

 
Changed:
<
<
You can take a look at the attached screenshots (pflow.fwc & pflow_algo.fwc) so that you know what to expect when loading Fireworks with the particle flow config files.
>
>
You can quickly run a sample dataset. If you are using a conda environment (see other ways to run Fireworks here) run the following commands. The
 --no-version-check 
is applied so that we can safely ignore the CMSSW version that produced it.
 
Deleted:
<
<
cmsShow 4.2-2

In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2-2/) run the following command:

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

FWLite 4_2_3

In the main FWLite directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE) run the following commands:

   source ../../fwlite_setup.sh
   cmsenv
   cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root

NB: These instructions already assume that you have acquired the necessary particle flow configuration files (i.e. pflow.fwc & pflow_algo.fwc) by following the installation instructions.

How to get a display of the particle flow inputs

cmsShow 4.2-2

In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2-2/) run the following command:

 
Changed:
<
<
./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
conda activate fireworks cmsShow.exe --no-version-check http://cern.ch/fireworks/data-4.2.root
 
Changed:
<
<
FWLite 4_2_3

In the main FWLite directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE) run the following commands:

   source ../../fwlite_setup.sh
   cmsenv
   cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
In this case the root file here was produced with CMSSW_4_2_2 while we are using CMSSW_10_6_1.
 
Changed:
<
<

How to get an alternative Candidate display

>
>
At the top of the window, you can change navigate the different event by changing the event number. There is also a filter field that allows you to select for example events with muons whose transverse momentum is greater than 20 GeV. You can click on the filter button and type in the event filter expression as "$Muons.pt()>20". If you apply "$Tracks.pt()>1$", you will see that only 9 out of the 15 events are left.
 
Changed:
<
<
This how-to is only for those users that have followed the second installation recipe (FWLite 4_2_3).
>
>
At the left side of the window you should see a summary of the object collections that are shown on the event display. You can check and uncheck the tick boxes to control which collections get displayed. You can also click on the "Add collection" in order to display more collections not currently shown.
 
Deleted:
<
<
  1. The first thing to do is start cmsShow. You may have already done this following the instructions in one of the previous how-to's
  2. Once the application is running you should use the add collection dialog box to (the button to open this is on the left hand side of the main view) search for 'Alt Candidates', as shown here.
  3. You should now have an alternative display of the Candidates in the RhoPhi and RhoZ views (see the screenshot here).

An example set of instructions are shown below (these assume that you are in the main FWLite directory e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE):

   source ../../fwlite_setup.sh
   cmsenv
   cmsShow http://cern.ch/fireworks/data-4.2.root
From this point you can simply add the 'Alt Candidates' collection using the add collection dialog box.
 

How to load a config file at runtime

Revision 302019-08-17 - CiliciaUzzielPerez

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Line: 7 to 7
 
Added:
>
>
This page is under construction. An archive of an older version is found in in this page.
 

Overview

This page explains how to set up an experimental version of Fireworks, to study the particle flow reconstruction. This version of Fireworks can be used to create a display of the particles created by the particle flow algorithm:

Line: 19 to 21
 
  • Tracks, with their extrapolated position in the calorimeters
  • PFBlocks
Changed:
<
<

Installation recipes

>
>

Installation recipes and Examples

  You can find the latest recipes to install FireWorks here.
Changed:
<
<
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).
    • The second recipe also allows you to fix some of the known bugs by updating and re-compiling with the latest source code

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.

>
>
You can also find the instructions on how to run FireWorks there.
 

How-to

Added:
>
>

A Quick Example

 

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

You can take a look at the attached screenshots (pflow.fwc & pflow_algo.fwc) so that you know what to expect when loading Fireworks with the particle flow config files.

Revision 292019-07-27 - CiliciaUzzielPerez

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Line: 21 to 21
 

Installation recipes

Added:
>
>
You can find the latest recipes to install FireWorks here.
 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).
Line: 28 to 30
  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.
Deleted:
<
<
You can find the latest recipes to install FireWorks here.
 

How-to

Revision 282019-06-22 - CiliciaUzzielPerez

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Line: 28 to 28
  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.
Changed:
<
<

Prerequisite: Setting up CVS

In order to grab the particle flow configuration file, as well as any source code, you need to have access to the cvs repositories.

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

So that your machine knows where and how to access the repositories, two environment variables must be set.

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

That's it!

Installation Recipe 1 - cmsShow 4.2-2

Linux 64-bit:

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

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

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

   tar xzf cmsShow-4.2-2.linux.tar.gz
   cd cmsShow-4.2-2/src
   find ../ -name 'pflow.fwc' -exec rm {} \;
   find ../ -name 'pflow_algo.fwc' -exec rm {} \;
   cvs co Fireworks/Core/macros/pflow.fwc
   cvs co Fireworks/Core/macros/pflow_algo.fwc
   ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc
   ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc
   cd ..

Mac:

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

 curl -OL http://cmsshow.web.cern.ch/cmsshow/cmsShow-4.2-2.mac.tar.gz 

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

   tar xzf cmsShow-4.2-2.mac.tar.gz
   cd cmsShow-4.2-2/src
   find ../ -name 'pflow.fwc' -exec rm {} \;
   find ../ -name 'pflow_algo.fwc' -exec rm {} \;
   cvs co Fireworks/Core/macros/pflow.fwc
   cvs co Fireworks/Core/macros/pflow_algo.fwc
   ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc
   ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc
   cd ..

Instructions on how to run cmsShow can be found in the 'How-to' section.

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.

The Installation

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

NB: Step 1 is different on Linux and Mac but steps 2 and 3 should be followed for both!

Linux:

1.

  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

Mac:

1.

  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


2. Assuming that you have followed the cvs prerequisites for this recipe, you now need to grab the code (Note: For the program to use this code you need to follow the compilation instructions).
   cd work/CMSSW_4_2_3_FWLITE/src/
   cvs co Fireworks/ParticleFlow
   cvs co Fireworks/Candidates

3. In order to get a display of either the particle flow based physics objects, or the particle flow inputs, you need to acquire the particle flow configuration files.

   cvs co Fireworks/Core/macros/pflow.fwc
   cvs co Fireworks/Core/macros/pflow_algo.fwc
   ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc
   ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc

Instructions on how to run FWLite can be found in the 'How-to' section.

User Code - Alternative Candidate Display

This section is optional but recommended. The following instructions show you how to acquire some additional code that allows you to display Candidates in an alternative way to the standard display. These alternative Candidates will be displayed as straight line objects which have lengths proportional to either pt or energy, depending upon the scaling options set in the Fireworks views.

   cvs co UserCode/sharris
   mv UserCode/sharris/Fireworks/AltCandidates Fireworks/
   rm -rf UserCode

Information on setting up an alternative Candidate display can be found in the 'How-To' section.

Compilation

In order for the newly acquired source code to actually be used, it is necessary to re-compile the program.

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

In the 'src' directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSW_4_2_3_FWLITE/src) run the following commands:

   . ../../../fwlite_setup.sh
   scram b
>
>
You can find the latest recipes to install FireWorks here.
 

How-to

Line: 257 to 129
 
<!-- Add your review status in this table structure with 2 columns delineated by three vertical bars; please DON'T remove the spaces between the vertical bars and the asterisks in the first line; it would break the PDF rendering! -->

Reviewer/Editor and Date (copy from screen) Comments
Added:
>
>
Uzziel Perez - 22 June 2019 Minor updates to installation recipes
 
AntonioMorelosPineda - 17 Apr 2013 Upgrade to workbook style
AljaMrakTadel -11 Jul 2011 Created.

Revision 272013-04-17 - AntonioMorelosPineda

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

3.4.4 Studying Particle Flow with Fireworks

Added:
>
>
Complete: 5
 

Overview

Line: 248 to 251
  -- ColinBernet - 08-Feb-2011
Added:
>
>

Review status

<!-- Add your review status in this table structure with 2 columns delineated by three vertical bars; please DON'T remove the spaces between the vertical bars and the asterisks in the first line; it would break the PDF rendering! -->

Reviewer/Editor and Date (copy from screen)
<!-- -->
Sorted ascending
Comments
AntonioMorelosPineda - 17 Apr 2013 Upgrade to workbook style
AljaMrakTadel -11 Jul 2011 Created.

<!--/twistyPlugin twikiMakeVisibleInline-->

Upgrade to workbook style, A.Morelos,17-Apr-2013

<!--/twistyPlugin-->

Responsible: AljaMrakTadel

<!-- Last reviewed by: AljaMrakTadel - 11 Jul 2012 -->
Last reviewed by: AntonioMorelosPineda - 17 Apr 2013
 
META FILEATTACHMENT attachment="pflow_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow.fwc config file" date="1306423462" name="pflow_fwc.png" path="pflow_fwc.png" size="223652" stream="pflow_fwc.png" tmpFilename="/usr/tmp/CGItemp30269" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="pflow_algo_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow_algo.fwc config file" date="1306426602" name="pflow_algo_fwc.png" path="pflow_algo_fwc.png" size="210198" stream="pflow_algo_fwc.png" tmpFilename="/usr/tmp/CGItemp34359" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="AddCollection_AltCand.png" attr="" comment="Add Collection dialog for Alt Candidates" date="1311675802" name="AddCollection_AltCand.png" path="AddCollection_AltCand.png" size="153631" stream="AddCollection_AltCand.png" tmpFilename="/usr/tmp/CGItemp48667" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"

Revision 252011-07-29 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 116 to 116
 2. Assuming that you have followed the cvs prerequisites for this recipe, you now need to grab the code (Note: For the program to use this code you need to follow the compilation instructions).
   cd work/CMSSW_4_2_3_FWLITE/src/
   cvs co Fireworks/ParticleFlow

Added:
>
>
cvs co Fireworks/Candidates
 

3. In order to get a display of either the particle flow based physics objects, or the particle flow inputs, you need to acquire the particle flow configuration files.

Revision 242011-07-26 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 113 to 113
 


Changed:
<
<
2. Assuming that you have followed the cvs prerequisites for this recipe, you now need to grab the code (Note: For the program to use this code you need to follow the compilation instructions in the next section).
>
>
2. Assuming that you have followed the cvs prerequisites for this recipe, you now need to grab the code (Note: For the program to use this code you need to follow the compilation instructions).
 
   cd work/CMSSW_4_2_3_FWLITE/src/
   cvs co Fireworks/ParticleFlow
Line: 128 to 128
  Instructions on how to run FWLite can be found in the 'How-to' section.
Added:
>
>

User Code - Alternative Candidate Display

This section is optional but recommended. The following instructions show you how to acquire some additional code that allows you to display Candidates in an alternative way to the standard display. These alternative Candidates will be displayed as straight line objects which have lengths proportional to either pt or energy, depending upon the scaling options set in the Fireworks views.

   cvs co UserCode/sharris
   mv UserCode/sharris/Fireworks/AltCandidates Fireworks/
   rm -rf UserCode

Information on setting up an alternative Candidate display can be found in the 'How-To' section.

 

Compilation

In order for the newly acquired source code to actually be used, it is necessary to re-compile the program.

Line: 183 to 197
  cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
Added:
>
>

How to get an alternative Candidate display

This how-to is only for those users that have followed the second installation recipe (FWLite 4_2_3).

  1. The first thing to do is start cmsShow. You may have already done this following the instructions in one of the previous how-to's
  2. Once the application is running you should use the add collection dialog box to (the button to open this is on the left hand side of the main view) search for 'Alt Candidates', as shown here.
  3. You should now have an alternative display of the Candidates in the RhoPhi and RhoZ views (see the screenshot here).

An example set of instructions are shown below (these assume that you are in the main FWLite directory e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE):

   source ../../fwlite_setup.sh
   cmsenv
   cmsShow http://cern.ch/fireworks/data-4.2.root
From this point you can simply add the 'Alt Candidates' collection using the add collection dialog box.
 

How to load a config file at runtime

In the main interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window navigate to, and then open the desired config file (e.g. pflow.fwc or pflow_algo.fwc).

Line: 217 to 249
 
META FILEATTACHMENT attachment="pflow_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow.fwc config file" date="1306423462" name="pflow_fwc.png" path="pflow_fwc.png" size="223652" stream="pflow_fwc.png" tmpFilename="/usr/tmp/CGItemp30269" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="pflow_algo_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow_algo.fwc config file" date="1306426602" name="pflow_algo_fwc.png" path="pflow_algo_fwc.png" size="210198" stream="pflow_algo_fwc.png" tmpFilename="/usr/tmp/CGItemp34359" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
Added:
>
>
META FILEATTACHMENT attachment="AddCollection_AltCand.png" attr="" comment="Add Collection dialog for Alt Candidates" date="1311675802" name="AddCollection_AltCand.png" path="AddCollection_AltCand.png" size="153631" stream="AddCollection_AltCand.png" tmpFilename="/usr/tmp/CGItemp48667" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="altCandidate_display.png" attr="" comment="Alternative Candidate display" date="1311675823" name="altCandidate_display.png" path="altCandidate_display.png" size="149059" stream="altCandidate_display.png" tmpFilename="/usr/tmp/CGItemp48673" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"

Revision 232011-06-20 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 199 to 199
 

Known Bugs

  • Some of the track objects aren't extrapolated far enough to reach the endcaps
Deleted:
<
<
  • The Ecal Cluster components of a PFBlock aren't displayed at the true/accurate Ecal radius (they use the standard Fireworks display radius)
 
  • Ecal Rechit display in PF Rho Phi view isn't updated correctly after a filter is applied
  • If PFBlock's are displayed with PFTrack and/or PFCluster objects then object overlap may occur. This will make it difficult to select between these objects. See the How-to for information on studying PFBlocks.

Revision 222011-06-06 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 38 to 38
  That's it!
Changed:
<
<

Installation Recipe 1 - cmsShow 4.2

>
>

Installation Recipe 1 - cmsShow 4.2-2

 
Changed:
<
<
Linux:
>
>
Linux 64-bit:
 
Changed:
<
<
1. Use the download link here or in a terminal run
 wget http://cern.ch/cmsshow/cmsShow-4.2.linux.tar.gz 
>
>
1. Use the download link here or in a terminal run
 wget http://cmsshow.web.cern.ch/cmsshow/cmsShow-4.2-2.linux.tar.gz 
  2. Run the following commands in the directory to which you just downloaded the tarball:
Added:
>
>
 
Changed:
<
<
tar xzf cmsShow-4.2.linux.tar.gz cd cmsShow-4.2/src
>
>
tar xzf cmsShow-4.2-2.linux.tar.gz cd cmsShow-4.2-2/src
  find ../ -name 'pflow.fwc' -exec rm {} \; find ../ -name 'pflow_algo.fwc' -exec rm {} \; cvs co Fireworks/Core/macros/pflow.fwc cvs co Fireworks/Core/macros/pflow_algo.fwc ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc
Changed:
<
<
cd ..
>
>
cd ..
  Mac:
Changed:
<
<
1. Use the download link here or in a terminal run
 wget http://cern.ch/cmsshow/cmsShow-4.2.mac.tar.gz 
>
>
1. Use the download link here or in a terminal run
 curl -OL http://cmsshow.web.cern.ch/cmsshow/cmsShow-4.2-2.mac.tar.gz 
  2. Run the following commands in the directory to which you just downloaded the tarball:
Added:
>
>
 
Changed:
<
<
tar xzf cmsShow-4.2.mac.tar.gz cd cmsShow-4.2/src
>
>
tar xzf cmsShow-4.2-2.mac.tar.gz cd cmsShow-4.2-2/src
  find ../ -name 'pflow.fwc' -exec rm {} \; find ../ -name 'pflow_algo.fwc' -exec rm {} \; cvs co Fireworks/Core/macros/pflow.fwc cvs co Fireworks/Core/macros/pflow_algo.fwc ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc
Changed:
<
<
cd ../
>
>
cd ..
 

Instructions on how to run cmsShow can be found in the 'How-to' section.

Line: 144 to 147
  You can take a look at the attached screenshots (pflow.fwc & pflow_algo.fwc) so that you know what to expect when loading Fireworks with the particle flow config files.
Changed:
<
<
cmsShow 4.2
>
>
cmsShow 4.2-2
 
Changed:
<
<
In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
>
>
In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2-2/) run the following command:
 
   ./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
Line: 164 to 167
 

How to get a display of the particle flow inputs

Changed:
<
<
cmsShow 4.2
>
>
cmsShow 4.2-2
 
Changed:
<
<
In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
>
>
In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2-2/) run the following command:
 
   ./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root

Revision 212011-05-30 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 185 to 185
 In the main interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window navigate to, and then open the desired config file (e.g. pflow.fwc or pflow_algo.fwc).

How to study PFBlocks

Added:
>
>
In order to study the PF Block objects clearly it's best if you don't display them at the same time as the PF Clusters and/or PF Tracks. Use the collection controller on the left hand side of the main Fireworks window in order to change a collections visibility. This is done by either ticking or un-ticking the box at the side of the relevant collection. In this case, you should un-tick the boxes by the side of "PF Tracks", "PF Cluster - ECAL" and "PF Cluster - HCAL" when displaying PF Block objects.

The visibility options are changed because drawing conflicts occur if the aforementioned objects are displayed together i.e. objects will overlap and it will become difficult to select/view any one in particular.

 

Wish-list & bug reports

Revision 202011-05-30 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 76 to 76
 

Instructions on how to run cmsShow can be found in the 'How-to' section.

Changed:
<
<
>
>
 

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.

Line: 183 to 183
 

How to load a config file at runtime

In the main interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window navigate to, and then open the desired config file (e.g. pflow.fwc or pflow_algo.fwc).

Added:
>
>

How to study PFBlocks

 

Wish-list & bug reports

This section is used to list bugs that are currently known as well as features that we are currently working towards getting implemented.

Changed:
<
<

Know Bugs

>
>

Known Bugs

  • Some of the track objects aren't extrapolated far enough to reach the endcaps
  • The Ecal Cluster components of a PFBlock aren't displayed at the true/accurate Ecal radius (they use the standard Fireworks display radius)
  • Ecal Rechit display in PF Rho Phi view isn't updated correctly after a filter is applied
  • If PFBlock's are displayed with PFTrack and/or PFCluster objects then object overlap may occur. This will make it difficult to select between these objects. See the How-to for information on studying PFBlocks.

Bug Fixes

This is a list of known bugs that can be fixed if you use the second installation recipe and compile the source code acquired from cvs.
 
Changed:
<
<

The Wish-list

>
>

The Wish-list (feature requests)

 
<!--
Preferences Variables

Revision 192011-05-30 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 6 to 6
 

Overview

Changed:
<
<
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:
>
>
This page explains how to set up an experimental version of Fireworks, to study the particle flow reconstruction. This version of Fireworks can be used to create a display of the particles created by the particle flow algorithm:
 
  • PFCandidates
  • PFJets
Changed:
<
<
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:
>
>
In addition to this, you can also 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
Line: 27 to 27
 

Prerequisite: Setting up CVS

Changed:
<
<
In order to grab the particle flow configuration fle as well as any source code you need to have access to the cvs repositories.
>
>
In order to grab the particle flow configuration file, as well as any source code, you need to have access to the cvs repositories.
  NB: It is assumed that you have installed the cvs software on your machine!

So that your machine knows where and how to access the repositories, two environment variables must be set.

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

Changed:
<
<
export CVS_RSH=ssh

</pre>

>
>
export CVS_RSH=ssh
  That's it!
Line: 76 to 75
  cd ../
Changed:
<
<
Instructions on how to run cmsShow can be found in the 'How-to' section.
>
>
Instructions on how to run cmsShow can be found in the 'How-to' section.
 

Installation Recipe 2 - Current release with FWlite: 4_2_3

Line: 90 to 89
  To install simply follow the instructions below. More information on the installation can be found at the standard Fireworks page.
Added:
>
>
NB: Step 1 is different on Linux and Mac but steps 2 and 3 should be followed for both!
 Linux:

1.

Line: 109 to 110
 


Changed:
<
<
2. Assuming that you have followed the cvs prerequisites for this recipe, you now simply need to grab the code!
>
>
2. Assuming that you have followed the cvs prerequisites for this recipe, you now need to grab the code (Note: For the program to use this code you need to follow the compilation instructions in the next section).
 
   cd work/CMSSW_4_2_3_FWLITE/src/
   cvs co Fireworks/ParticleFlow
Line: 122 to 123
  ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc
Changed:
<
<
Instructions on how to run FWLite can be found in the 'How-to' section.
>
>
Instructions on how to run FWLite can be found in the 'How-to' section.
 

Compilation

Line: 141 to 142
 

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

Changed:
<
<
You can take a look at the attached screenshots so that you know what to expect when loading Fireworks with the particle flow config files.
>
>
You can take a look at the attached screenshots (pflow.fwc & pflow_algo.fwc) so that you know what to expect when loading Fireworks with the particle flow config files.
 
Changed:
<
<

cmsShow 4.2

>
>
cmsShow 4.2
  In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
   ./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
Changed:
<
<

FWLite 4_2_3

>
>
FWLite 4_2_3
  In the main FWLite directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE) run the following commands:
Line: 163 to 164
 

How to get a display of the particle flow inputs

Changed:
<
<

cmsShow 4.2

>
>
cmsShow 4.2
  In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
   ./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
Changed:
<
<

FWLite 4_2_3

>
>
FWLite 4_2_3
  In the main FWLite directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE) run the following commands:

Revision 182011-05-27 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 18 to 18
 

Installation recipes

Changed:
<
<
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).
>
>
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).
    • The second recipe also allows you to fix some of the known bugs by updating and re-compiling with the latest source code
  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.
Added:
>
>

Prerequisite: Setting up CVS

In order to grab the particle flow configuration fle as well as any source code you need to have access to the cvs repositories.

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

So that your machine knows where and how to access the repositories, two environment variables must be set.

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

</pre>

That's it!

 

Installation Recipe 1 - cmsShow 4.2

Added:
>
>
Linux:
 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
Changed:
<
<
cd cmsShow-4.2 ln -s src/Fireworks/Core/macros/pflow_algo.fwc pflow_algo.fwc
>
>
cd cmsShow-4.2/src find ../ -name 'pflow.fwc' -exec rm {} \; find ../ -name 'pflow_algo.fwc' -exec rm {} \; cvs co Fireworks/Core/macros/pflow.fwc cvs co Fireworks/Core/macros/pflow_algo.fwc ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc cd ..
 
Changed:
<
<
3. Run Fireworks with pflow.fwc to get the a display of PFCandidates and particle flow objects or, use pflow_algo.fwc to get a display of particle flow inputs
   ./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
OR
>
>
Mac:

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

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

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

 
Changed:
<
<
./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
tar xzf cmsShow-4.2.mac.tar.gz cd cmsShow-4.2/src find ../ -name 'pflow.fwc' -exec rm {} \; find ../ -name 'pflow_algo.fwc' -exec rm {} \; cvs co Fireworks/Core/macros/pflow.fwc cvs co Fireworks/Core/macros/pflow_algo.fwc ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc cd ../
 
Added:
>
>
Instructions on how to run cmsShow can be found in the 'How-to' section.
 

Installation Recipe 2 - Current release with FWlite: 4_2_3

Changed:
<
<
>
>
 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.
Deleted:
<
<
You will also need to have access to the CVS repositories which is explained in the next section.

Prerequisite: Setting up CVS

In order to grab the particle flow configuration fle as well as any source code you need to have access to the cvs repositories.

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

So that your machine knows where and how to access the repositories, two environment variables must be set.

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

That's it!

 

The Installation

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

Linux:

Added:
>
>
1.
 
  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

Deleted:
<
<
./cmsShow http://cern.ch/fireworks/data-4.2.root
 

Mac:

Added:
>
>
1.
 
  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

Deleted:
<
<
./cmsShow http://cern.ch/fireworks/data-4.2.root
 
Changed:
<
<
Assuming that you have followed the cvs prerequisites for this recipe, you now simply need to grab the code!
   cd CMSSW_4_2_3_FWlLite/work/CMSSW_4_2_3_FWLite/src/

>
>

2. Assuming that you have followed the cvs prerequisites for this recipe, you now simply need to grab the code!
   cd work/CMSSW_4_2_3_FWLITE/src/

  cvs co Fireworks/ParticleFlow
Changed:
<
<
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

There is one last step. In order to get a display of either the particle flow based physics objects or the particle flow inputs, you need to follow the procedures below.

>
>
3. In order to get a display of either the particle flow based physics objects, or the particle flow inputs, you need to acquire the particle flow configuration files.
 
   cvs co Fireworks/Core/macros/pflow.fwc
   cvs co Fireworks/Core/macros/pflow_algo.fwc
Changed:
<
<
ln -s Fireworks/Core/macros/pflow.fwc pflow.fwc ln -s Fireworks/Core/macros/pflow_algo.fwc pflow_algo.fwc To display particle flow based physics objects (e.g. PFCandidates) do
   cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
or for the particle flow input display
   cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
ln -s src/Fireworks/Core/macros/pflow.fwc ../pflow.fwc ln -s src/Fireworks/Core/macros/pflow_algo.fwc ../pflow_algo.fwc
 
Added:
>
>
Instructions on how to run FWLite can be found in the 'How-to' section.
 

Compilation

Changed:
<
<
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.
>
>
In order for the newly acquired source code to actually be used, it is necessary to re-compile the program.
  NB: The compilation is done using the scram tool and hence, you should at least have some knowledge of it's basic usage.
Changed:
<
<
In the 'CMSSW_4_2_3_FWLite' directory (e.g. ~/Documents/CMSSW_4_2_3_FWLite) run the following commands:
>
>
In the 'src' directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSW_4_2_3_FWLITE/src) run the following commands:
 
Changed:
<
<
. fwlite_setup.sh cd work/CMSSW_4_2_3_FWLite/src/
>
>
. ../../../fwlite_setup.sh
  scram b

How-to

Changed:
<
<

How to load a config file at runtime

In the main interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window navigate to, and then open the desired config file (e.g. pflow.fwc or pflow_algo.fwc).

>
>
 

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

Added:
>
>
 You can take a look at the attached screenshots so that you know what to expect when loading Fireworks with the particle flow config files.

cmsShow 4.2

Line: 135 to 144
 You can take a look at the attached screenshots so that you know what to expect when loading Fireworks with the particle flow config files.

cmsShow 4.2

Added:
>
>
 In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
Changed:
<
<
./cmsShow -c src/Fireworks/Core/macros/pflow.fwc http://cern.ch/fireworks/data-4.2.root
>
>
./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
 

FWLite 4_2_3

Line: 145 to 156
 
   source ../../fwlite_setup.sh
   cmsenv
Changed:
<
<
cmsShow -c src/Fireworks/Core/macros/pflow.fwc http://cern.ch/fireworks/data-4.2.root
>
>
cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
 
Changed:
<
<
NB: These instructions already assume that you have acquired the necessary particle flow scripts using the installation instructions.
>
>
NB: These instructions already assume that you have acquired the necessary particle flow configuration files (i.e. pflow.fwc & pflow_algo.fwc) by following the installation instructions.
 

How to get a display of the particle flow inputs

Line: 153 to 164
 

How to get a display of the particle flow inputs

cmsShow 4.2

Added:
>
>
 In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
Changed:
<
<
./cmsShow -c src/Fireworks/Core/macros/pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 

FWLite 4_2_3

Line: 163 to 176
 
   source ../../fwlite_setup.sh
   cmsenv
Changed:
<
<
cmsShow -c src/Fireworks/Core/macros/pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 
Added:
>
>

How to load a config file at runtime

In the main interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window navigate to, and then open the desired config file (e.g. pflow.fwc or pflow_algo.fwc).

 

Wish-list & bug reports

This section is used to list bugs that are currently known as well as features that we are currently working towards getting implemented.

Revision 172011-05-26 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Deleted:
<
<
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:

Line: 23 to 22
  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.
Deleted:
<
<
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

Line: 34 to 31
 
   tar xzf cmsShow-4.2.linux.tar.gz
   cd cmsShow-4.2
Changed:
<
<
./cmsShow data.root
>
>
ln -s src/Fireworks/Core/macros/pflow_algo.fwc pflow_algo.fwc
 
Changed:
<
<
explain how to get the two fwc files in the current directory.
>
>
3. Run Fireworks with pflow.fwc to get the a display of PFCandidates and particle flow objects or, use pflow_algo.fwc to get a display of particle flow inputs
   ./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
OR
   ./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 

Installation Recipe 2 - Current release with FWlite: 4_2_3

Changed:
<
<
>
>
 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.
Added:
>
>
You will also need to have access to the CVS repositories which is explained in the next section.

Prerequisite: Setting up CVS

In order to grab the particle flow configuration fle as well as any source code you need to have access to the cvs repositories.

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

So that your machine knows where and how to access the repositories, two environment variables must be set.

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

That's it!

The Installation

  To install simply follow the instructions below. More information on the installation can be found at the standard Fireworks page.
Line: 65 to 86
  ./cmsShow http://cern.ch/fireworks/data-4.2.root
Changed:
<
<
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.

>
>
Assuming that you have followed the cvs prerequisites for this recipe, you now simply need to grab the code!
   cd CMSSW_4_2_3_FWlLite/work/CMSSW_4_2_3_FWLite/src/
   cvs co Fireworks/ParticleFlow
 
Changed:
<
<
NB: It is assumed that you have installed the cvs software on your machine!
>
>
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
 
Changed:
<
<
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)
>
>
There is one last step. In order to get a display of either the particle flow based physics objects or the particle flow inputs, you need to follow the procedures below.
 
Changed:
<
<
export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW export CVS_RSH=ssh
>
>
cvs co Fireworks/Core/macros/pflow.fwc cvs co Fireworks/Core/macros/pflow_algo.fwc ln -s Fireworks/Core/macros/pflow.fwc pflow.fwc ln -s Fireworks/Core/macros/pflow_algo.fwc pflow_algo.fwc
 
Changed:
<
<
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!

>
>
To display particle flow based physics objects (e.g. PFCandidates) do
 
Changed:
<
<
cd CMSSW_4_2_3_FWlLite/work/CMSSW_4_2_3_FWLite/src/ cvs co Fireworks/ParticleFlow
>
>
cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root or for the particle flow input display
   cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 
Deleted:
<
<
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

 
Changed:
<
<
COLIN: Put that in the second recipe
>
>

Compilation

 
Changed:
<
<
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.
>
>
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.
 
Changed:
<
<
NB: The compilation is done using the scram tool and hence, you should at least have some knowledge of it's basic useage.
>
>
NB: The compilation is done using the scram tool and hence, you should at least have some knowledge of it's basic usage.
  In the 'CMSSW_4_2_3_FWLite' directory (e.g. ~/Documents/CMSSW_4_2_3_FWLite) run the following commands:
Line: 107 to 127
 

How-to

Changed:
<
<

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:

>
>

How to load a config file at runtime

 
Changed:
<
<
The first command is different depending upon the installation recipe that you used so please choose appropriately.
>
>
In the main interface go to File and select Load Configuration OR, press Ctrl and l simultaneously. In the new window navigate to, and then open the desired config file (e.g. pflow.fwc or pflow_algo.fwc).
 
Changed:
<
<
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/ 
>
>

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

You can take a look at the attached screenshots so that you know what to expect when loading Fireworks with the particle flow config files.
 
Changed:
<
<
cvs co Fireworks/Core/macros/pflow.fwc mv Fireworks/Core/macros/pflow.fwc ../../../ cd ../../../
>
>

cmsShow 4.2

In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
   ./cmsShow -c src/Fireworks/Core/macros/pflow.fwc http://cern.ch/fireworks/data-4.2.root
 
Changed:
<
<
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.

>
>

FWLite 4_2_3

In the main FWLite directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE) run the following commands:
 
Changed:
<
<
./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
>
>
source ../../fwlite_setup.sh cmsenv cmsShow -c src/Fireworks/Core/macros/pflow.fwc http://cern.ch/fireworks/data-4.2.root
 
Changed:
<
<
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.
>
>
NB: These instructions already assume that you have acquired the necessary particle flow scripts using the installation instructions.
 

How to get a display of the particle flow inputs

Changed:
<
<
  • 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 ../../../
>
>

cmsShow 4.2

In the main cmsShow directory (e.g. ~/Documents/cmsShow-4.2/) run the following command:
   ./cmsShow -c src/Fireworks/Core/macros/pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 
Changed:
<
<
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?

>
>

FWLite 4_2_3

In the main FWLite directory (e.g. ~/Documents/CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE) run the following commands:
 
Changed:
<
<
./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
>
>
source ../../fwlite_setup.sh cmsenv cmsShow -c src/Fireworks/Core/macros/pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 
Added:
>
>
 

Wish-list & bug reports

Added:
>
>
This section is used to list bugs that are currently known as well as features that we are currently working towards getting implemented.

Know Bugs

The Wish-list

 
<!--
Preferences Variables  
Line: 178 to 181
 
-->

-- ColinBernet - 08-Feb-2011 \ No newline at end of file

Added:
>
>
META FILEATTACHMENT attachment="pflow_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow.fwc config file" date="1306423462" name="pflow_fwc.png" path="pflow_fwc.png" size="223652" stream="pflow_fwc.png" tmpFilename="/usr/tmp/CGItemp30269" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"
META FILEATTACHMENT attachment="pflow_algo_fwc.png" attr="" comment="A screenshot after loading Fireworks with the pflow_algo.fwc config file" date="1306426602" name="pflow_algo_fwc.png" path="pflow_algo_fwc.png" size="210198" stream="pflow_algo_fwc.png" tmpFilename="/usr/tmp/CGItemp34359" user="simon_2ephilip_2ecolin_2eharris_40cern_2ech" version="1"

Revision 162011-05-26 - ColinBernet

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

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

Overview

Changed:
<
<
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:
>
>
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
Changed:
<
<
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:
>
>
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

Deleted:
<
<
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).
 
Changed:
<
<
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.
>
>
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.

 
Added:
>
>
Start by explaining how to set up cvs

Prerequisite: setting up CVS

 

Installation Recipe 1 - cmsShow 4.2

Changed:
<
<
1. Use the download link here or in a terminal run
 wget http://cern.ch/cmsshow/cmsShow-4.2.linux.tar.gz 
>
>
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
Line: 37 to 37
  ./cmsShow data.root
Added:
>
>
explain how to get the two fwc files in the current directory.
 

Installation Recipe 2 - Current release with FWlite: 4_2_3

Added:
>
>
 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,
Line: 62 to 65
  ./cmsShow http://cern.ch/fireworks/data-4.2.root
Added:
>
>
explain how to get the two fwc files in the current directory
 

Getting Fireworks Code from CVS

Added:
>
>
  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!

Line: 67 to 73
  NB: It is assumed that you have installed the cvs software on your machine!
Changed:
<
<
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)
>
>
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
Added:
>
>
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
Changed:
<
<
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
>
>
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

Added:
>
>
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.

Line: 97 to 109
 

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

Changed:
<
<
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:
>
>
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.
Changed:
<
<
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/ 
>
>
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 ../../../
Added:
>
>
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
Changed:
<
<
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.
>
>
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

Line: 131 to 152
  The first command is different depending upon the installation recipe that you used so please choose appropriately.
Changed:
<
<
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/ 
>
>
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 ../../../
Line: 138 to 162
  mv Fireworks/Core/macros/pflow_algo.fwc ../../../ cd ../../../
Added:
>
>
 You should now be back in the CMSSW_4_2_3 directory and ready to run cmsShow with your newly acquired configuration file.
Added:
>
>
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
Added:
>
>

Wish-list & bug reports

 
<!--
Preferences Variables

Revision 152011-05-25 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 38 to 38
 

Installation Recipe 2 - Current release with FWlite: 4_2_3

Added:
>
>
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.
 
Changed:
<
<
This recipe is about:
  • installing FWLite
  • getting the FW code from cvs
  • compiling

More information about this can be found at the standard Fireworks twiki page but the basic instructions for installation are shown below.

>
>
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

Line: 62 to 62
  ./cmsShow http://cern.ch/fireworks/data-4.2.root
Added:
>
>

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.
 
Changed:
<
<
The ParticleFlow package is included in this release and so you should have access to the ParticleFlow functionality without doing anything in addition to the above steps.
>
>
NB: It is assumed that you have installed the cvs software on your machine!
 
Changed:
<
<

How-to

>
>
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
 
Changed:
<
<

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

>
>
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
 
Changed:
<
<
  • Simple common how to for both recipes
  • Each recipe should explain how to get the pflow.fwc file (use links) [SIMON, in particular review pflow.fwc]
>
>

Compilation

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.
 
Changed:
<
<

How to get a display of the particle flow inputs

>
>
NB: The compilation is done using the scram tool and hence, you should at least have some knowledge of it's basic useage.
 
Changed:
<
<
  • 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 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

 
Changed:
<
<
If you wish to start Fireworks with the PF configuration file then a few more steps need to be followed. Firstly, you will need access to the CMSSW repositories.
>
>
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:
 
Changed:
<
<
Now, in the 'src' directory (CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE/src/) run the following commands:
>
>
The first command is different depending upon the installation recipe that you used so please choose appropriately.
 
Added:
>
>
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.fwc
   mv Fireworks/Core/macros/pflow.fwc ../../../
Line: 92 to 113
 
   ./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
Deleted:
<
<
This method can also be used to pass other configuration files to Fireworks upon start-up. e.g.
   ./cmsShow -c example.fwc data.root 
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.
 
Added:
>
>
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.
 
Changed:
<
<

Compiling 4_2_3_FWLite Release

>
>

How to get a display of the particle flow inputs

 
Changed:
<
<
Most of that is part of the second recipe
>
>
  • 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]
 
Changed:
<
<
In order compile there are a few prerequisites; you are either:
  • working on a mac with xcode installed,
  • using an slc5 terminal, have access to an slc5 terminal (e.g. ssh USERNAME@lxplus.cern.ch)
  • using the chroot method explained here.
You must also have setup environment variables that point to the CMSSW repositories (see Acessing CMSSW Repositories ).
>
>
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.
 
Changed:
<
<
In the 'CMSSW_4_2_3_FWLite' directory(e.g. ~/Documents/CMSSW_4_2_3_FWLite) run the following commands:
>
>
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/ 
 
Changed:
<
<
. fwlite_setup.sh cd work/CMSSW_4_2_3_FWLite/src/ cvs co Fireworks/ParticleFlow scram b
>
>
cvs co Fireworks/Core/macros/pflow_algo.fwc mv Fireworks/Core/macros/pflow_algo.fwc ../../../ cd ../../../
 
Changed:
<
<
Information on scram

Accessing CMSSW Repositories

Also part of the second recipe

In order to access the CMSSW repositories you must set two environment variables NB: It is assumed that you have installed the cvs software on your machine!

>
>
You should now be back in the CMSSW_4_2_3 directory and ready to run cmsShow with your newly acquired configuration file.
 
Changed:
<
<
export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW export CVS_RSH=ssh
>
>
./cmsShow -c pflow_algo.fwc http://cern.ch/fireworks/data-4.2.root
 

<!--
Preferences Variables  
Added:
>
>
 
-->

-- ColinBernet - 08-Feb-2011

Revision 142011-05-25 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 7 to 7
 

Overview

This page explains how to set up an experimental version of Fireworks, to study the particle flow reconstruction.

Changed:
<
<
The modified version of Fireworks is able to display
>
>
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
Deleted:
<
<
  • PFCandidates
  • PFJets
It is a tool to understand how the particle flow algorithm identifies and reconstructs particles, using these inputs.

To display the particles created by the particle flow algorithm, just use the standard version of Fireworks.

 

Installation recipes

Added:
>
>
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).
 
Changed:
<
<
Two recipes
  • getting the binaries
    • advantages
    • disadvantages
  • getting the source
    • advantages
    • disadvantages

cmsShow 4.2

>
>
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.
 
Changed:
<
<
1. Download the latest stable version of Fireworks, follow the standard installation instructions and test program execution. The following is assumed:
  • 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.
>
>

Installation Recipe 1 - cmsShow 4.2

 
Changed:
<
<
2. The ParticleFlow package is included in the cmsShow 4.2 release so you should now be able to run Fireworks as normal and have access to all ParticleFlow functionality. Enjoy!
>
>
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
 
Changed:
<
<

Current release with FWlite: 4_2_3

>
>

Installation Recipe 2 - Current release with FWlite: 4_2_3

  This recipe is about:
  • installing FWLite
  • getting the FW code from cvs
  • compiling
Changed:
<
<
Most information about this can be found at the standard Fireworks twiki page but the basic instructions for installation are also shown below.
>
>
More information about this can be found at the standard Fireworks twiki page but the basic instructions for installation are shown below.
  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

Revision 132011-05-25 - ColinBernet

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 21 to 21
 To display the particles created by the particle flow algorithm, just use the standard version of Fireworks.

Installation recipes

Added:
>
>
Two recipes
  • getting the binaries
    • advantages
    • disadvantages
  • getting the source
    • advantages
    • disadvantages
 

cmsShow 4.2

1. Download the latest stable version of Fireworks, follow the standard installation instructions and test program execution. The following is assumed:

Line: 32 to 41
 2. The ParticleFlow package is included in the cmsShow 4.2 release so you should now be able to run Fireworks as normal and have access to all ParticleFlow functionality. Enjoy!

Current release with FWlite: 4_2_3

Added:
>
>
This recipe is about:
  • installing FWLite
  • getting the FW code from cvs
  • compiling
 Most information about this can be found at the standard Fireworks twiki page but the basic instructions for installation are also shown below.

Linux:

Line: 54 to 69
 The ParticleFlow package is included in this release and so you should have access to the ParticleFlow functionality without doing anything in addition to the above steps.

How-to

Added:
>
>

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

  • Simple common how to for both recipes
  • Each recipe should explain how to get the pflow.fwc file (use links) [SIMON, in particular review 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]
 If you wish to start Fireworks with the PF configuration file then a few more steps need to be followed. Firstly, you will need access to the CMSSW repositories.
Line: 75 to 101
 

Compiling 4_2_3_FWLite Release

Added:
>
>
Most of that is part of the second recipe
 In order compile there are a few prerequisites; you are either:
  • working on a mac with xcode installed,
  • using an slc5 terminal, have access to an slc5 terminal (e.g. ssh USERNAME@lxplus.cern.ch)
Line: 92 to 121
 Information on scram

Accessing CMSSW Repositories

Added:
>
>
Also part of the second recipe
  In order to access the CMSSW repositories you must set two environment variables NB: It is assumed that you have installed the cvs software on your machine!

Revision 122011-05-23 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 54 to 54
 The ParticleFlow package is included in this release and so you should have access to the ParticleFlow functionality without doing anything in addition to the above steps.

How-to

Changed:
<
<
If you wish to start Fireworks with the PF configuration file then a new command line argument must be passed.
>
>
If you wish to start Fireworks with the PF configuration file then a few more steps need to be followed. Firstly, you will need access to the CMSSW repositories.
 
Added:
>
>
Now, in the 'src' directory (CMSSW_4_2_3_FWLITE/work/CMSSW_4_2_3_FWLITE/src/) run the following commands:

   cvs co Fireworks/Core/macros/pflow.fwc
   mv Fireworks/Core/macros/pflow.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.

 
Changed:
<
<
./cmsShow -c pflow.fwc data.root
>
>
./cmsShow -c pflow.fwc http://cern.ch/fireworks/data-4.2.root
  This method can also be used to pass other configuration files to Fireworks upon start-up. e.g.
   ./cmsShow -c example.fwc data.root 
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.
Added:
>
>

Compiling 4_2_3_FWLite Release

In order compile there are a few prerequisites; you are either:
  • working on a mac with xcode installed,
  • using an slc5 terminal, have access to an slc5 terminal (e.g. ssh USERNAME@lxplus.cern.ch)
  • using the chroot method explained here.
You must also have setup environment variables that point to the CMSSW repositories (see Acessing CMSSW Repositories ).

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/
   cvs co Fireworks/ParticleFlow
   scram b

Information on scram

Accessing CMSSW Repositories

In order to access the CMSSW repositories you must set two environment variables NB: It is assumed that you have installed the cvs software on your machine!

   export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW
   export CVS_RSH=ssh
 
<!--
Preferences Variables  

Revision 112011-05-16 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 21 to 21
 To display the particles created by the particle flow algorithm, just use the standard version of Fireworks.

Installation recipes

Changed:
<
<

cmsShow 4.1

>
>

cmsShow 4.2

 
Changed:
<
<
1. Download the latest stable version of Fireworks, follow the standard installing instructions and test program execution. The following is assumed:
  • Your fireworks directory is ~/Documents/cmsShow-vNum
>
>
1. Download the latest stable version of Fireworks, follow the standard installation instructions and test program execution. The following is assumed:
 
  • You are either:
    • working on a mac with xcode installed,
Changed:
<
<
    • using an slc5 terminal, have access to an slc5 terminal (e.g. ssh username@lxplus5.cern.ch)
>
>
    • using an slc5 terminal or have access to an slc5 terminal (e.g. ssh username@lxplus.cern.ch)
 
    • using the chroot method explained here.
Changed:
<
<
2. Assuming successful execution, a CVS environment will now need to be set up in order to obtain the latest particle flow source code. In your fireworks directory (e.g. ~/Documents/cmsShow-vNum) run the following commands:
  cd src/
  export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW
  export CVS_RSH=ssh
  rm -rf Fireworks/ParticleFlow
  cvs co Fireworks/ParticleFlow

3. Recompile with the new source code.

  cd ../
  make

4. You should now be able to run Fireworks as normal

>
>
2. The ParticleFlow package is included in the cmsShow 4.2 release so you should now be able to run Fireworks as normal and have access to all ParticleFlow functionality. Enjoy!
 
Changed:
<
<

Current release with FWlite: 4_1_3

>
>

Current release with FWlite: 4_2_3

 Most information about this can be found at the standard Fireworks twiki page but the basic instructions for installation are also shown below.

Linux:

Changed:
<
<
  wget http://cmsrep.cern.ch/cms/cpt/Software/download/cms/TARS/slc5_amd64_gcc434/CMSSW_4_1_3_FWLITE-slc5_amd64_gcc434.tar.gz
  tar xzf CMSSW_4_1_3_FWLITE-slc5_amd64_gcc434.tar.gz
  cd CMSSW_4_1_3_FWLITE

>
>
  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
Changed:
<
<
./cmsShow http://cern.ch/fireworks/Run2011A-MuHad-AOD-PromptReco-v1.root
>
>
./cmsShow http://cern.ch/fireworks/data-4.2.root
 

Mac:

Changed:
<
<
  curl -OL http://cmsrep.cern.ch/cms/cpt/Software/download/cms/TARS/osx106_amd64_gcc421/CMSSW_4_1_3_FWLITE-osx106_amd64_gcc421.tar.gz
  tar xzf CMSSW_4_1_3_FWLITE-osx106_amd64_gcc421.tar.gz
  cd CMSSW_4_1_3_FWLITE

>
>
  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
Changed:
<
<
./cmsShow http://cern.ch/fireworks/Run2011A-MuHad-AOD-PromptReco-v1.root
>
>
./cmsShow http://cern.ch/fireworks/data-4.2.root
 
Deleted:
<
<

ParticleFlow plugins

The ParticleFlow plugins are not built in to this release and hence need to be added.

  cd wherever-you-installed-fwlite-
  . fwlite_setup.sh
  cd work/CMSSW_4_1_3_FWLITE/src
  cmsenv
  cvs co Fireworks/ParticleFlow

If you get any problems when running the last line of instruction (e.g. "cvs checkout: CVSROOT is set for a GSSAPI access method but your CVS executable doesn't support it.") then try the following instead:

  export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW
  export CVS_RSH=ssh
  cvs co Fireworks/ParticleFlow
 
Changed:
<
<
Note: The environment has to be setup like this every time you want to use this module.
>
>
The ParticleFlow package is included in this release and so you should have access to the ParticleFlow functionality without doing anything in addition to the above steps.
 

How-to

If you wish to start Fireworks with the PF configuration file then a new command line argument must be passed.

Revision 92011-04-22 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 20 to 20
  To display the particles created by the particle flow algorithm, just use the standard version of Fireworks.
Changed:
<
<

Installation recipe

>
>

Installation recipes

cmsShow 4.1

  1. Download the latest stable version of Fireworks, follow the standard installing instructions and test program execution. The following is assumed:
  • Your fireworks directory is ~/Documents/cmsShow-vNum
Line: 31 to 31
 
    • using the chroot method explained here.

2. Assuming successful execution, a CVS environment will now need to be set up in order to obtain the latest particle flow source code. In your fireworks directory (e.g. ~/Documents/cmsShow-vNum) run the following commands:

Changed:
<
<
>
>

  cd src/ export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW export CVS_RSH=ssh rm -rf Fireworks/ParticleFlow cvs co Fireworks/ParticleFlow
Changed:
<
<
>
>
  3. Recompile with the new source code.
Changed:
<
<
>
>

  cd ../ make
Changed:
<
<
>
>
  4. You should now be able to run Fireworks as normal
Added:
>
>

Current release with FWlite: 4_1_3

Most information about this can be found at the standard Fireworks twiki page but the basic instructions for installation are also shown below.

Linux:

  wget http://cmsrep.cern.ch/cms/cpt/Software/download/cms/TARS/slc5_amd64_gcc434/CMSSW_4_1_3_FWLITE-slc5_amd64_gcc434.tar.gz
  tar xzf CMSSW_4_1_3_FWLITE-slc5_amd64_gcc434.tar.gz
  cd CMSSW_4_1_3_FWLITE
  ./install.sh
  ./cmsShow http://cern.ch/fireworks/Run2011A-MuHad-AOD-PromptReco-v1.root

Mac:

  curl -OL http://cmsrep.cern.ch/cms/cpt/Software/download/cms/TARS/osx106_amd64_gcc421/CMSSW_4_1_3_FWLITE-osx106_amd64_gcc421.tar.gz
  tar xzf CMSSW_4_1_3_FWLITE-osx106_amd64_gcc421.tar.gz
  cd CMSSW_4_1_3_FWLITE
  ./install.sh
  ./cmsShow http://cern.ch/fireworks/Run2011A-MuHad-AOD-PromptReco-v1.root

ParticleFlow plugins

The ParticleFlow plugins are not built in to this release and hence need to be added.

  cd wherever-you-installed-fwlite-
  . fwlite_setup.sh
  cd work/CMSSW_4_1_3_FWLITE/src
  cmsenv
  cvs co Fireworks/ParticleFlow

If you get any problems when running the last line of instruction (e.g. "cvs checkout: CVSROOT is set for a GSSAPI access method but your CVS executable doesn't support it.") then try the following instead:

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

Note: The environment has to be setup like this every time you want to use this module.

 

How-to

If you wish to start Fireworks with the PF configuration file then a new command line argument must be passed.

Revision 82011-03-07 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 12 to 12
 
  • ECAL and HCAL rechits
  • PFClusters
  • Tracks, with their extrapolated position in the calorimeters
Changed:
<
<
  • Blocks
>
>
  • PFBlocks
 
  • PFCandidates
  • PFJets
It is a tool to understand how the particle flow algorithm

Revision 72011-02-10 - ColinBernet

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 22 to 22
 

Installation recipe

Deleted:
<
<
Linux
 
Changed:
<
<
The following is assumed:
>
>
1. Download the latest stable version of Fireworks, follow the standard installing instructions and test program execution. The following is assumed:
 
  • Your fireworks directory is ~/Documents/cmsShow-vNum
Changed:
<
<
  • You are using an slc5 terminal, have access to an slc5 terminal (e.g. ssh username@lxplus5.cern.ch) or are using the chroot method explained here.

1. Download the latest stable version of Fireworks, follow the standard installing instructions and test program execution.

>
>
  • You are either:
    • working on a mac with xcode installed,
    • using an slc5 terminal, have access to an slc5 terminal (e.g. ssh username@lxplus5.cern.ch)
    • using the chroot method explained here.
  2. Assuming successful execution, a CVS environment will now need to be set up in order to obtain the latest particle flow source code. In your fireworks directory (e.g. ~/Documents/cmsShow-vNum) run the following commands:
Line: 47 to 47
  4. You should now be able to run Fireworks as normal
Deleted:
<
<
Mac
 

How-to

If you wish to start Fireworks with the PF configuration file then a new command line argument must be passed.

Revision 62011-02-10 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 13 to 13
 
  • PFClusters
  • Tracks, with their extrapolated position in the calorimeters
  • Blocks
Changed:
<
<
  • ...
>
>
  • PFCandidates
  • PFJets
 It is a tool to understand how the particle flow algorithm identifies and reconstructs particles, using these inputs.
Line: 56 to 57
  This method can also be used to pass other configuration files to Fireworks upon start-up. e.g.
   ./cmsShow -c example.fwc data.root 
Changed:
<
<
A 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.
>
>
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.
 
<!--
Preferences Variables

Revision 52011-02-09 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 49 to 49
 Mac

How-to

Added:
>
>
If you wish to start Fireworks with the PF configuration file then a new command line argument must be passed.

   ./cmsShow -c pflow.fwc data.root
This method can also be used to pass other configuration files to Fireworks upon start-up. e.g.
   ./cmsShow -c example.fwc data.root 
A 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.
 
Deleted:
<
<

How-to ...

 
<!--
Preferences Variables  

Revision 42011-02-09 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 46 to 46
  4. You should now be able to run Fireworks as normal
Added:
>
>
Mac
 

How-to

How-to ...

Revision 32011-02-08 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Line: 11 to 11
 The modified version of Fireworks is able to display
  • ECAL and HCAL rechits
  • PFClusters
Changed:
<
<
  • tracks, with their extrapolated position in the calorimeters
  • blocks
>
>
  • Tracks, with their extrapolated position in the calorimeters
  • Blocks
 
  • ...
It is a tool to understand how the particle flow algorithm identifies and reconstructs particles, using these inputs.
Line: 21 to 21
 

Installation recipe

Changed:
<
<
Here, set up a recipe that mac users and linux users can easily copy/paste to their shell. You need to explain them how to set up cvs on their machine.
>
>
Linux

The following is assumed:

  • Your fireworks directory is ~/Documents/cmsShow-vNum
  • You are using an slc5 terminal, have access to an slc5 terminal (e.g. ssh username@lxplus5.cern.ch) or are using the chroot method explained here.

1. Download the latest stable version of Fireworks, follow the standard installing instructions and test program execution.

2. Assuming successful execution, a CVS environment will now need to be set up in order to obtain the latest particle flow source code. In your fireworks directory (e.g. ~/Documents/cmsShow-vNum) run the following commands:

    cd src/
    export CVSROOT=:ext:YOURUSERNAME@cmssw.cvs.cern.ch:/cvs/CMSSW
    export CVS_RSH=ssh
    rm -rf Fireworks/ParticleFlow
    cvs co Fireworks/ParticleFlow

3. Recompile with the new source code.

    cd ../
    make

4. You should now be able to run Fireworks as normal

 

How-to

How-to ...

Changed:
<
<
>
>
<!--
Preferences Variables
 
Added:
>
>
-->
  -- ColinBernet - 08-Feb-2011 \ No newline at end of file

Revision 22011-02-08 - unknown

Line: 1 to 1
 
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Revision 12011-02-08 - ColinBernet

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="WorkBookParticleFlow"

Studying Particle Flow with Fireworks

Overview

This page explains how to set up an experimental version of Fireworks, to study the particle flow reconstruction.

The modified version of Fireworks is able to display

  • ECAL and HCAL rechits
  • PFClusters
  • tracks, with their extrapolated position in the calorimeters
  • blocks
  • ...
It is a tool to understand how the particle flow algorithm identifies and reconstructs particles, using these inputs.

To display the particles created by the particle flow algorithm, just use the standard version of Fireworks.

Installation recipe

Here, set up a recipe that mac users and linux users can easily copy/paste to their shell. You need to explain them how to set up cvs on their machine.

How-to

How-to ...

-- ColinBernet - 08-Feb-2011

 
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