1678ce2523156342877e7c1b6c7dceebb317a1f2
[u/mrichter/AliRoot.git] / man / man4 / alirun.4
1 .TH alirun 4 "" "ALICE Reference Manual"
2 .ad b
3 .SH NAME
4 alirun - a shell script to run AliRoot
5 .SH DESCRIPTION
6 $Log$
7
8 Revision 1.5  2001/02/23 17:33:40  buncic
9 Added alifs wrapper for CASTOR and alirun modified accordingly.
10
11 Revision 1.4  2001/02/08 18:55:43  buncic
12 Support for writing to remote file systems (shift/castor).
13
14 Revision 1.3  2001/02/01 18:00:23  buncic
15 Use bash in place of sh for compatibility
16
17 Revision 1.2  2001/02/01 17:46:26  buncic
18 Fixed mktemp on HP and Sun
19
20 Revision 1.1  2001/01/26 21:22:02  hristov
21 Major upgrade of AliRoot code
22
23
24 .SH SYNOPSIS
25 alirun [[-d <TPC+ITS+..>|-all]]
26         [-f <hits file>]
27         [-o <output directory>]
28         [-split]
29         [-C <Config.C>]
30         [-p <particle#>]
31         [-seed <seed for random number generator>]
32         [-n <event #>]
33         <-c <command ...>>
34
35 .SH DESCRIPTION
36 This script is a wrapper for AliRoot and provides a command line interface suitable for running in batch mode.
37
38 .SH CONFIGURATION OPTIONS
39 The following options are used to configure AliRoot session.
40
41 -c <command1 command2 ...>
42    This option must be the last one on alirun command line and specifies the sequence of alirun commands to be executed. At present, the following commands are supported:
43
44     - Hits ................ simulation 
45     - Digits .............. digitisation
46     - SDigits ............. creation of sumable digits
47     - SDigits2Digits ...... conversion SDigits->Digits 
48     - Reco ................ reconstruction
49
50 -d <TPC+ITS+..> | -d all | -all 
51    Selects detector for which <command> will be run. If none of these options was specified, an internal loop in AliRoot over all active detectors is assumed.  Otherwise, for each detector, input file(s) are re-opened in update mode, command (or macro) is executed and the file is closed. Option -all is equivalent to MUON+RICH+TOF+ITS+TPC+PHOS+PMD+CASTOR+TRD. Detectors are processed in order as they appear on the command line.   
52
53 -f <file>
54    Name of the top level Root file where Root trees will be stored (branches may reside in the same file or be diverted to separate files (see -split option). By default, file is named galice.root.
55
56 -o <directory> 
57    A directory where output file(s) will be stored. If does not exist, it will be created. If not specified, current directory is used. One can prefix the directory name with a string indicting file transport protocols (as supported by ROOT). In addition, some file transport protocols are selected by name signatures. At present the following methods are available:
58
59  o) if file name begins with rfio:, shift:, castor:, hpss:, /shift, /castor, /hpss => rfio (remote file i/o) protocol (requires rfiod on server side)
60  o) if file name begins with root:, roots: =>  root and secure root protocol (requires rootd on server side)
61  o) if file name begins with http: => HTTP protocol (requires modified apache server on server side)
62
63 -split
64    If specified, this option will tell AliRoot to divert branches of Root trees into separate files.
65
66    The layout of output directory is the following:
67    
68    <directory>
69     |-- Digits.<detector>.root
70     |-- SDigits.<detector>.root
71     |-- Hits.root
72     |-- Kine.root
73     |-- Reco.root
74     `-- galice.root
75
76 -C <macro.C>
77    An alternative to Config.C macro which contains AliRoot configuration. 
78
79 -p <n> 
80    Number of primary particles to be generated by selected event generator. Required for Hits command, Ignored by Digits command (digitisation is performed for all particles found in input file). Default value is 50. 
81   
82 -seed <n> 
83    Seed for random number generator (used to initialise TRandom3(n)).  
84   
85 -n <n>
86    Number of events to generate (not yet implemented).  
87
88 .SH RUN OPTIONS
89 These options define run time appearance of the AliRoot session.
90
91 -help
92    Display usage.
93
94 -verbose
95    Switch verbose screen output on. 
96
97 -quiet
98    Switch verbose output off. Output is redirected to a file which is shown on standard output only if <command> returns non zero status.
99
100 -fork
101    Forks all digitisation processes in background, using LSF if available, in order to speed up execution. It cannot be used in present design where only tree branches are diverted to separate files as top level Root file must be kept open in update mode.
102
103 -trace
104    Show trace of execution of shell commands.
105   
106 -debug
107    Execute AliRoot under gdb. 
108
109 -debugger <command_name>
110    Execute AliRoot under debugger other than gdb. 
111
112 -debuglevel <level>
113    Set AliRoot debug flag to <level>.
114
115 -break <breakpoint>
116    Execute AliRoot under gdb and set <breakpoint>.
117
118 -makeman
119    Create man page for alirun. 
120   
121 .SH EXAMPLES
122    Run sumulation for 1 event, 100 particles and store output in file galice.root in /tmp/event.1 directory:
123
124    alirun -o /tmp/event.1 -p 100 -c Hits
125
126    Run sumulation for 1 event, 100 particles and store output in file test.root in /tmp/event.2 directory. In adition, divert branches of TreeD,TreeR and TreeK into separate files:
127    
128    alirun -o /tmp/event.2 -f test.root -split -p 100 -c Hits
129
130   Use output from first step and create TOF and RICH digits. Output is in the same direcory and in file test.root
131
132    alirun -d TOF+RICH -o /tmp/event.1 -c Digits
133
134   Use output from second step and create digits for all detectors. Output is in the same direcory and branches are diverted to separate files:
135
136    alirun -d all -o /tmp/event.2 -f test.root -split -c Digits
137
138 .SH AUTHOR
139    Predrag Buncic, e-mail: Predrag.Buncic@cern.ch 
140
141 .SH CREATION DATE
142    06-Nov-2000
143