[u/mrichter/AliRoot.git] / PWGLF / FORWARD / trains / README

	A Simplified Way of Defining Analysis Trains
	============================================

Introduction:
-------------

    The code in this directory presents a simplified way of defining
    an analysis train.  The idea is that the user defines a class that
    derives from TrainSetup:
    
        #include "TrainSetup.C"
        
        class MyTrain : public TrainSetup
        {
        public:
          MyTrain(const char* name="myTest") : TrainSetup(name) 
          { 
          }
          void CreateTasks(AliAnalysisManager* mgr)
          {
            LoadLibrary("MyAnalysis");
            
 	    CoupleCar("AddTaskMyAnalysis.C");
          }
          const char* ClassName() const { return "MyTrain"; }
        };
        
    which then can be executed using either the program "runTrain":
    
        runTrain --class=MyTrain --name=myTrain --url=URL [OPTIONS]
    
    or the script "RunTrain.C": 
    
        > aliroot
        Root> .L $ALICE_ROOT/PWGLF/FORWARD/trains/RunTrain.C
        Root> RunTrain("myTrain", "MyTrain", URL, OPTIONS)
    
    The execution environment and input is specified in the URL
    string, while general parameters for the job (including the
    task(s)) can be specified in OPTIONS.
    
Code Organization:
-------------------


    TrainSetup		      - Base class
    Helper		      - Base class for URL
        LocalHelper	      - Local analysis URLs
    	ProofHelper	      - Proof URLs
    	    LiteHelper	      - Proof-lite URLs
    	    AAFHelper	      - AAF URLs (no AliEn)
        PluginHelper	      - Base class for URLs
     	    AAFPluginHelper   - AAF URLs (w/AliEn)
    	    GridHelper        - Grid URLs
    Option  		      - Option handling
    AvailableSoftware	      - Find SW on AAF/Grid
    ChainBuilder	      - Build local/lite chain
    OutputUtilities	      - Special output
    ParUtilities	      - PAR utilities
    RunTrain		      - Script to run train
    MyAnalysis		      - Example task
    MyTrain		      - Example train
    QATrain		      - Full QA train example
    CreateFileCollection      - Utility
    trainMain		      - The runTrain utility
    
Local Variables:
  mode: text
End:

LocalWords:  TrainSetup RunTrain MyTrain myTrain PWGLF aliroot url QA
LocalWords:  runTrain AddTaskMyAnalysis AliAnalysisManager gROOT AAF
LocalWords:  CreateTasks LoadLibrary MyAnalysis const ClassName AliEn
LocalWords:  LocalHelper ProofHelper LiteHelper AAFHelper GridHelper
LocalWords:  PluginHelper AAFPluginHelper AvailableSoftware QATrain
LocalWords:  ChainBuilder OutputUtilities ParUtilities trainMain
LocalWords:  CreateFileCollection
Commit	Line	Data
b5d461ff	1	A Simplified Way of Defining Analysis Trains
	2	============================================
	3
	4	Introduction:
	5	-------------
	6
	7	The code in this directory presents a simplified way of defining
	8	an analysis train. The idea is that the user defines a class that
	9	derives from TrainSetup:
	10
	11	#include "TrainSetup.C"
	12
	13	class MyTrain : public TrainSetup
	14	{
	15	public:
	16	MyTrain(const char* name="myTest") : TrainSetup(name)
	17	{
	18	}
	19	void CreateTasks(AliAnalysisManager* mgr)
	20	{
	21	LoadLibrary("MyAnalysis");
	22
ba144d92	23	CoupleCar("AddTaskMyAnalysis.C");
b5d461ff	24	}
	25	const char* ClassName() const { return "MyTrain"; }
	26	};
	27
	28	which then can be executed using either the program "runTrain":
	29
	30	runTrain --class=MyTrain --name=myTrain --url=URL [OPTIONS]
	31
	32	or the script "RunTrain.C":
	33
	34	> aliroot
	35	Root> .L $ALICE_ROOT/PWGLF/FORWARD/trains/RunTrain.C
	36	Root> RunTrain("myTrain", "MyTrain", URL, OPTIONS)
	37
	38	The execution environment and input is specified in the URL
	39	string, while general parameters for the job (including the
	40	task(s)) can be specified in OPTIONS.
	41
	42	Code Organization:
	43	-------------------
	44
	45
	46	TrainSetup - Base class
	47	Helper - Base class for URL
	48	LocalHelper - Local analysis URLs
	49	ProofHelper - Proof URLs
	50	LiteHelper - Proof-lite URLs
	51	AAFHelper - AAF URLs (no AliEn)
	52	PluginHelper - Base class for URLs
	53	AAFPluginHelper - AAF URLs (w/AliEn)
	54	GridHelper - Grid URLs
	55	Option - Option handling
	56	AvailableSoftware - Find SW on AAF/Grid
	57	ChainBuilder - Build local/lite chain
	58	OutputUtilities - Special output
	59	ParUtilities - PAR utilities
	60	RunTrain - Script to run train
	61	MyAnalysis - Example task
	62	MyTrain - Example train
	63	QATrain - Full QA train example
	64	CreateFileCollection - Utility
	65	trainMain - The runTrain utility
	66
	67	Local Variables:
	68	mode: text
	69	End:
	70
	71	LocalWords: TrainSetup RunTrain MyTrain myTrain PWGLF aliroot url QA
	72	LocalWords: runTrain AddTaskMyAnalysis AliAnalysisManager gROOT AAF
	73	LocalWords: CreateTasks LoadLibrary MyAnalysis const ClassName AliEn
	74	LocalWords: LocalHelper ProofHelper LiteHelper AAFHelper GridHelper
	75	LocalWords: PluginHelper AAFPluginHelper AvailableSoftware QATrain
	76	LocalWords: ChainBuilder OutputUtilities ParUtilities trainMain
	77	LocalWords: CreateFileCollection