[u/mrichter/AliRoot.git] / JETAN / README_FASTJET


------------------------------------------------

Instructions to interface FastJet in AliRoot

Rafael.Diaz.Valdes@cern.ch
------------------------------------------------


The following steps help you interface Aliroot with Fastjet 

1- Install fastjet-2.3.4 from http://www.lpthe.jussieu.fr/~salam/fastjet 

2- Modify Fastjet installation (temporary)
   Root can not read the fastjet classes due to a bug in the CINT interprete (see report: https://savannah.cern.ch/bugs/?41608#attached ).
   Therefore, once you've installed fastjet, go to the installation include location and then do

   sed -i -e 's/^FASTJET_BEGIN_NAMESPACE/namespace fastjet \{/' \
       -e 's/^FASTJET_END_NAMESPACE.*/\} \/\/ fastjet namespace /' \
       -e 's/^#define FASTJET/\/\/ #define FASTJET/' \
       fastjet/*.hh fastjet/*/*.hh 
  
  
3- Setup the following environment variables

   #if you have CGAL 
   setenv CGAL_MAKEFILE /path to CGAL makefile  (this is mandatory for Fastjet)
   setenv CGAL_LIB /path to CGAL libraries 
   setenv LD_LIBRARY_PATH $CGAL_LIB\:$LD_LIBRARY_PATH

   #Fastjet 
   setenv FASTJET /path to Fastjet installation directory
   setenv LD_LIBRARY_PATH $FASTJET/lib\:$LD_LIBRARY_PATH

4- Update $ALICE_ROOT/JETAN module with the new Alice Fastjet classes

   AliFastJetFinder.h .cxx
   AliFastJetHeader.h .cxx
   
   Note: as soon as the SVN AliRoot/JETAN is updated you don't have to do it anymore   

5- Recompile JETAN module in AliRoot
   
   cd $ALICE_ROOT
   make

6- Test if the interface is working.
   Run the following test macro to check that you can call Fastjet algorithms from AliRoot. 
   
   % aliroot
   root [0] .x testFastJet.C

7- Now you are ready to use Fastjet within the Alice Analysis framework (by the moment with local ESD files) using the AliAnalysisTaskJets class. Here is an example of configuration file for Fastjet.

   ConfigJetAnalysisFastjet.C 
   
   
 NOTES: 
 - The following interface can be used for all the jet algorithms present in Fastjet. The interface with the SiSCone plug-in will be included soon. 
 
 - The defaults set up parameters are not optimized, we are working on it.
Commit	Line	Data
8f4b89b8	1
	2	------------------------------------------------
	3
	4	Instructions to interface FastJet in AliRoot
	5
	6	Rafael.Diaz.Valdes@cern.ch
	7	------------------------------------------------
	8
	9
	10	The following steps help you interface Aliroot with Fastjet
	11
	12	1- Install fastjet-2.3.4 from http://www.lpthe.jussieu.fr/~salam/fastjet
	13
	14	2- Modify Fastjet installation (temporary)
	15	Root can not read the fastjet classes due to a bug in the CINT interprete (see report: https://savannah.cern.ch/bugs/?41608#attached ).
	16	Therefore, once you've installed fastjet, go to the installation include location and then do
	17
	18	sed -i -e 's/^FASTJET_BEGIN_NAMESPACE/namespace fastjet \{/' \
	19	-e 's/^FASTJET_END_NAMESPACE.*/\} \/\/ fastjet namespace /' \
	20	-e 's/^#define FASTJET/\/\/ #define FASTJET/' \
	21	fastjet/.hh fastjet//*.hh
	22
	23
	24	3- Setup the following environment variables
	25
	26	#if you have CGAL
	27	setenv CGAL_MAKEFILE /path to CGAL makefile (this is mandatory for Fastjet)
	28	setenv CGAL_LIB /path to CGAL libraries
	29	setenv LD_LIBRARY_PATH $CGAL_LIB\:$LD_LIBRARY_PATH
	30
	31	#Fastjet
	32	setenv FASTJET /path to Fastjet installation directory
	33	setenv LD_LIBRARY_PATH $FASTJET/lib\:$LD_LIBRARY_PATH
	34
	35	4- Update $ALICE_ROOT/JETAN module with the new Alice Fastjet classes
	36
	37	AliFastJetFinder.h .cxx
	38	AliFastJetHeader.h .cxx
	39
	40	Note: as soon as the SVN AliRoot/JETAN is updated you don't have to do it anymore
	41
	42	5- Recompile JETAN module in AliRoot
	43
	44	cd $ALICE_ROOT
	45	make
	46
	47	6- Test if the interface is working.
	48	Run the following test macro to check that you can call Fastjet algorithms from AliRoot.
	49
	50	% aliroot
	51	root [0] .x testFastJet.C
	52
	53	7- Now you are ready to use Fastjet within the Alice Analysis framework (by the moment with local ESD files) using the AliAnalysisTaskJets class. Here is an example of configuration file for Fastjet.
	54
	55	ConfigJetAnalysisFastjet.C
	56
	57
	58
	59	NOTES:
	60	- The following interface can be used for all the jet algorithms present in Fastjet. The interface with the SiSCone plug-in will be included soon.
	61
	62	- The defaults set up parameters are not optimized, we are working on it.
	63
	64