***********************************************************************
***********************************************************************
***** SpartyJet v3.4                                              *****
*****    A generic framework for running multiple jet algorithms  *****
*****    last updated: March 03, 2010                             *****
*****-------------------------------------------------------------*****
*****-------------------------------------------------------------*****
*****    currently supports                                       *****
*****           ATLAS   - fastkt                                  *****
*****                     fastkt aachen                           *****
*****                     cone                                    *****
*****	          CDF     - JetClustering                           *****
*****                     MidPoint                                *****
*****                       second pass                           *****
*****           D0      - improved legacy cone algorithm          *****
*****			                (midpoint)                              *****
*****           FastJet - fastjet kt                              *****
*****                     fastjet kt with aachen                  *****
*****                     SISCone plugin (seedless)               *****
*****           Pythia  - CellJet                                 *****
***********************************************************************
***********************************************************************

***********************************************************************
LICENSE:
***********************************************************************	
This Software is under GNU General Public License v2.


***********************************************************************
AUTHORS:
***********************************************************************	
Original software from:
Pierre-Antoine Delsart		    Université de Montréal / IN2P3, LPSC Grenoble
Kurtis L. Geerlings		    Michigan State University
Joey Huston 			    Michigan State University
Brian T. Martin 		    Michigan State University

Recent Contributors :
Chris Vermillon

------------------------------------
Third party jet algorithms :
------------------------------------
FastJet : Matteo Cacciari and Gavin Salam, LPTHE, Paris 6 & 7 
          Gregory Soyez CERN/IPhT
	  http://www.lpthe.jussieu.fr/~salam/fastjet
ATLAS collaboration
CDF collaboration
CellJet : From Pythia 8, http://www.thep.lu.se/~torbjorn/Pythia.html
D0 collaboration
	Improved Legacy Cone Algorithm is from Lars Sonnenschein
------------------------------------




***********************************************************************
INSTALLATION:
***********************************************************************	

  -  Just type:
        make 

     in spartyjet/ directory. 

  -  This will build a list of libraries in  spartyjet/libs that
        you can load from a python/ROOT session or you can link to from an executable.
	libraries :
		libs/libJetCore.so 			 : all algorithms
		libs/libJetTools.so			 : many jet tools
		libs/libCDFJet.so  			 : CDF JetClustering and MidPoint	
		libs/libD0Jet.so	 			 : D0 Run II Cone
		libs/libATLASJet.so			 : ATLAS algorithms
		libs/libCellJet.so 			 : CellJet algorithm
		libs/libFastJet.so 			 : FastJet and SISCone 
		libs/libEventshape.so 	 : Eventshape tools
		libs/libSpartyDisplay.so : SpartyJet GUI

Compile Options: (Set in MakefileCommonOpt)
 - Link to external fastjet installation
   (default is to use version shipped with spartyjet)
	 To use different version uncomment and define
	 FASTJETDIR variable in MakefileCommonOpt
 - Specify fortan compiler (only needed to compile third-party stdhep libraries)
 	 Edit F77 variable in MakefileCommonOpt.  If you experience problems with stdhep
   compilation you may disable it by commenting out DO_STDHEP in MakefileCommonOpt


***********************************************************************
RUNNING:
***********************************************************************	
SpartyJet can be run from a python script, ROOT script or compiled C++ program.
Via a Python script is the recommended way of running.

########### SpartyJet Examples ###########

==== Python examples ====
>	 source setup.sh
>  cd examples_py
>  ./simpleExample.py
=========================

==== ROOT examples =====
>  cd examples_ROOT
>  root -l simple.C
=========================

===== C++ examples ======
>  cd examples_C
>  make
>  ./simpleExample.exe
=========================

Input:
All input can be found in: data

Output:
By default output is saved to: data/output

Full documentation can be found at: 
http://projects.hepforge.org/spartyjet/SJ_doc/index.html
or in spartyjet/docs/

