Finish the move RICH to HMPID
[u/mrichter/AliRoot.git] / man / man4 / alirun.4
CommitLineData
9e1a0ddb 1.TH alirun 4 "" "ALICE Reference Manual"
2.ad b
3.SH NAME
4alirun - a shell script to run AliRoot
5.SH DESCRIPTION
6$Log$
8b1c76de 7Revision 1.1 2001/05/16 14:57:29 alibrary
8New files for folders and Stack
9
9e1a0ddb 10
11Revision 1.5 2001/02/23 17:33:40 buncic
12Added alifs wrapper for CASTOR and alirun modified accordingly.
13
14Revision 1.4 2001/02/08 18:55:43 buncic
15Support for writing to remote file systems (shift/castor).
16
17Revision 1.3 2001/02/01 18:00:23 buncic
18Use bash in place of sh for compatibility
19
20Revision 1.2 2001/02/01 17:46:26 buncic
21Fixed mktemp on HP and Sun
22
23Revision 1.1 2001/01/26 21:22:02 hristov
24Major upgrade of AliRoot code
25
26
27.SH SYNOPSIS
28alirun [[-d <TPC+ITS+..>|-all]]
29 [-f <hits file>]
30 [-o <output directory>]
31 [-split]
32 [-C <Config.C>]
33 [-p <particle#>]
34 [-seed <seed for random number generator>]
35 [-n <event #>]
36 <-c <command ...>>
37
38.SH DESCRIPTION
39This script is a wrapper for AliRoot and provides a command line interface suitable for running in batch mode.
40
41.SH CONFIGURATION OPTIONS
42The following options are used to configure AliRoot session.
43
44-c <command1 command2 ...>
45 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:
46
47 - Hits ................ simulation
48 - Digits .............. digitisation
49 - SDigits ............. creation of sumable digits
50 - SDigits2Digits ...... conversion SDigits->Digits
51 - Reco ................ reconstruction
52
53-d <TPC+ITS+..> | -d all | -all
8b1c76de 54 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+HMPID+TOF+ITS+TPC+PHOS+PMD+CASTOR+TRD. Detectors are processed in order as they appear on the command line.
9e1a0ddb 55
56-f <file>
57 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.
58
59-o <directory>
60 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:
61
62 o) if file name begins with rfio:, shift:, castor:, hpss:, /shift, /castor, /hpss => rfio (remote file i/o) protocol (requires rfiod on server side)
63 o) if file name begins with root:, roots: => root and secure root protocol (requires rootd on server side)
64 o) if file name begins with http: => HTTP protocol (requires modified apache server on server side)
65
66-split
67 If specified, this option will tell AliRoot to divert branches of Root trees into separate files.
68
69 The layout of output directory is the following:
70
71 <directory>
72 |-- Digits.<detector>.root
73 |-- SDigits.<detector>.root
74 |-- Hits.root
75 |-- Kine.root
76 |-- Reco.root
77 `-- galice.root
78
79-C <macro.C>
80 An alternative to Config.C macro which contains AliRoot configuration.
81
82-p <n>
83 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.
84
85-seed <n>
86 Seed for random number generator (used to initialise TRandom3(n)).
87
88-n <n>
89 Number of events to generate (not yet implemented).
90
91.SH RUN OPTIONS
92These options define run time appearance of the AliRoot session.
93
94-help
95 Display usage.
96
97-verbose
98 Switch verbose screen output on.
99
100-quiet
101 Switch verbose output off. Output is redirected to a file which is shown on standard output only if <command> returns non zero status.
102
103-fork
104 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.
105
106-trace
107 Show trace of execution of shell commands.
108
109-debug
110 Execute AliRoot under gdb.
111
112-debugger <command_name>
113 Execute AliRoot under debugger other than gdb.
114
115-debuglevel <level>
116 Set AliRoot debug flag to <level>.
117
118-break <breakpoint>
119 Execute AliRoot under gdb and set <breakpoint>.
120
121-makeman
122 Create man page for alirun.
123
124.SH EXAMPLES
125 Run sumulation for 1 event, 100 particles and store output in file galice.root in /tmp/event.1 directory:
126
127 alirun -o /tmp/event.1 -p 100 -c Hits
128
129 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:
130
131 alirun -o /tmp/event.2 -f test.root -split -p 100 -c Hits
132
8b1c76de 133 Use output from first step and create TOF and HMPID digits. Output is in the same direcory and in file test.root
9e1a0ddb 134
8b1c76de 135 alirun -d TOF+HMPID -o /tmp/event.1 -c Digits
9e1a0ddb 136
137 Use output from second step and create digits for all detectors. Output is in the same direcory and branches are diverted to separate files:
138
139 alirun -d all -o /tmp/event.2 -f test.root -split -c Digits
140
141.SH AUTHOR
142 Predrag Buncic, e-mail: Predrag.Buncic@cern.ch
143
144.SH CREATION DATE
145 06-Nov-2000
146