Add new background and header. D.Picard
[u/mrichter/AliRoot.git] / html / AliRootHelp.html
CommitLineData
fe4da5cc 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
2<HTML>
3<HEAD>
4 <TITLE> Users Guide for AliRoot </TITLE>
5 <!-- Changed by: Yiota Foka, 18-Mar-1999 -->
6 <STYLE TYPE="text/css">
717fd520 7
fe4da5cc 8 H2 { color: red ; font-size: 22pt }
9 H3 { color: blue ; font-size: 20pt }
10 H4 { color: violet; font-size: 18pt }
11 H5 { color: olive ; font-size: 16pt }
12 H6 { color: maroon; font-size: 14pt }
13 TABLE { font-size: 14pt }
14 </STYLE>
15 <BASEFONT SIZE=4>
16<!-- Header material -->
717fd520 17<body background="../pictures/back.gif" text=black>
18<basefont face="verdana,arial,helvetica,sans-serif">
19
20<!-- Header material -->
fe4da5cc 21<table border=0 cellpadding=5 cellspacing=0 width="100%">
717fd520 22 <tr bgcolor=#eab575>
23 <td align=left width=20%> <img src="../pictures/MadHatter.jpg" HEIGHT=130 WIDTH=130> &nbsp;
24 <td align=center>
25 <font size="+4"><b>
26
27Users Guide for AliRoot
28 <td align=right width=20%> <img src="../pictures/Logo.gif"> &nbsp;
29 </tr>
30
31 <tr>
32 <td colspan=3 align=right><font size="-1">
fe4da5cc 33 <script language="JavaScript">
34 document.write("Last modified "+ document.lastModified)
35 // end of script -->
36 </script></font>
37 </td>
38 </tr>
39</table>
fe4da5cc 40
41<BODY TEXT="#000000" BGCOLOR="#FFFFFF"
42LINK="#0000FF" VLINK="#551A8B" ALINK="#FF0000">
43
44<BR>
fe4da5cc 45
46<BR> The source code for all AliRoot classes is <A
47HREF="roothtml/USER_Index.html">documented</A> and the html files are
48automatically generated by ROOT.
49
50<H2>Content</H2>
51
52<OL>
53<LI><A HREF="#1">How to run</A> AliRoot
54<LI><A HREF="roothtml/USER_Index.html">AliRoot classes</A>
55</OL>
56
57<HR>
58<BR>
59<H2><A NAME="1">1. How to run AliRoot</A></H2>
60
61<P>To execute the Alice detector simulation program.
62
63<UL>
64<LI>Type: <KBD> $ aliroot </KBD>
65
66<BR> this starts AliRoot in interactive mode by default after few seconds
67the <b>root</b> prompt apears
68<BR>you can now start a AliRoot
69interactive session by either creating the standard menu
70
71<LI>Type: <KBD> root[0] .x menu.C </KBD>
72<BR> or directly
73<LI>Type: <KBD> root[1] gAlice->Run() </KBD>
74<BR> or
75<LI>Type: <KBD> root[1] gAlice->RunLego() </KBD>
76<BR>
77<BR> to divert the long output generated by the AliRoot initialisation phase
78to an eg. AliRoot.log file
79<LI>Type: <KBD> root[3] .x menu.C > AliRoot.log </KBD>
80<BR> or
81<LI>Type: <KBD> root[4] gAlice->Run(); > AliRoot.log </KBD>
82</UL>
83
84<P>The time for the initialisation phase of AliRoot is typicaly 30 seconds.
85
86<P> By default the macro <A HREf="roothtml/examples/menu.C.html">menu.C</A>
87invokes <A HREF="roothtml/AliRun.html">AliRun::Init</A> with the
88configuration file <A HREF="roothtml/examples/Config.C.html">Config.C</A>.
89
90<P>When the initialisation is finished the <b>root</b> prompt apears
91again.
92<BR>You also get back the Root control bar menu.
93
94<P>You can now select options from the bar menu.
95
96<UL>
97<LI><B> Run </B>
98<BR> to generate an event with the number of tracks and the configuration as specified in <A HREF="roothtml/examples/Config.C.html"> Config.C </A>
99<BR><BR>
100<LI><B> RunLego </B>
101<BR> to generate the standard lego plots for radiation and absorption length. By default the granularity is 60 rays in theta and 60 rays in phi.
102<BR>To view the results when this command is finished type:
103<br><br>
104<KBD> root[0] .x <A HREF="roothtml/examples/lego.C.html">lego.C</A> </KBD>
105
106<BR>
107<BR> to change the parameters if you do not want to run with the default ones
108type:
109<br><br><KBD> root[3] gAlice->RunLego (your list of parameters) </KBD>
110<br><BR> see
111<A HREF="roothtml/AliRun.html">AliRun::RunLego </A> for details
112
113<BR><BR>
114<LI><B> Top, Front, Side view </B>
115<BR> to generate the corresponding cut view of Alice detector.
116<BR> note that it takes a long time to execute a cut view typicaly
117of the order of about 30 sec.
118<BR><BR>
119<LI><B> Menu Trees </B>
120<BR> this shows a new menu from which you can draw the geometry tree for
121 most of Alice detectors.
122<BR> double-clicking on an Alice detector generates its specifications.
123<BR><BR>
124<LI><B> Menu Pictures </B>
125<BR> this shows a new menu from which you can draw the major Alice detectors
126 in shade mode.
127<BR><BR>
128<LI><B> Other Options </B>
129<BR> allow to switch ON/OFF various drawing modes.
130</UL>
131
132<P>For more details on the functionality see the documentation of
133<A HREF="roothtml/AliRun.html">AliRun</A> and
134<A HREF="roothtml/TGeant3.html">TGeant3</A> classes
135<P>
136A global varial <var> gAlice </var>
137can be used to invoke the AliRun class functions.
138<BR>
139A global varial <var>gMC</var>
140can be used to invoke the TGeant3 class functions.
141
142<P> Note that several TGeant3 functions are also available by clicking with
143the right button on a canvas while in the AliRoot session.
144
145<P>
146To quit AliRoot
147<UL>
148<LI>Type: <KBD> root[3] .q </KBD>
149</UL
150
151
152<!! ======================================================================>
153<!! <BR><BR>
154<!! <A NAME="2"><H2></H2>
155
156<!======================================================================>
157<!! <BR>
158<!! <A NAME="3"><H2></H2>
159
160
161<!!======================================================================>
162<!! <BR><BR>
163<!! <A NAME="4"><H2></H2>
164
165
166<!===========================================================================>
167<P>
168<BR>
169<HR size=4>
170<BR>
171Page maintained by:
172<A HREF="mailto:Yiota.Foka@cern.ch">Yiota Foka</A>
173<BR>
174Back to:
175<A HREF="http://www1.cern.ch/ALICE">
176ALICE home, </A>
177<A HREF="http://www1.cern.ch/ALICE/Projects/offline">
178Offline home</A>
179</BODY>
180</HTML>
181
182
183