[u/mrichter/AliRoot.git] / html / AliRootHelp.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
   <TITLE> Users Guide for AliRoot </TITLE>
   <!-- Changed by: Yiota Foka, 18-Mar-1999 -->
   <STYLE TYPE="text/css">
      H1 { font-style: italic; color: green ; font-size: 24pt; align: center}
      H2 {                     color: red   ; font-size: 22pt               }
      H3 {                     color: blue  ; font-size: 20pt               }
      H4 {                     color: violet; font-size: 18pt               }
      H5 {                     color: olive ; font-size: 16pt               }
      H6 {                     color: maroon; font-size: 14pt               }
      TABLE { font-size: 14pt }
   </STYLE>
   <BASEFONT SIZE=4>
<!-- Header material -->
<hr>
<table border=0   cellpadding=5 cellspacing=0 width="100%">
  <tr bgcolor=#d0ffd0>
      <td align=left width=30%>
      <img alt="Alice" src="gif/Logo.gif" width="60" height="60" 
         align="absmiddle" border=1>
         <td align=center width=40%>
          <font size="+2">
           Alice Off-Line Project
      </font>
      <td align=right width=30% valign=bottom> 
          <font size="-1">
          <script language="JavaScript">
             document.write("Last modified "+ document.lastModified)
             // end of script -->
          </script></font>
      </td>
  </tr>
</table>
<hr>
</HEAD>


<BODY TEXT="#000000" BGCOLOR="#FFFFFF" 
LINK="#0000FF" VLINK="#551A8B" ALINK="#FF0000">

<BR>
<BR><H1> Users Guide for AliRoot</H1>
<P><HR>

<BR> The source code for all AliRoot classes is <A
HREF="roothtml/USER_Index.html">documented</A> and the html files are
automatically generated by ROOT.

<H2>Content</H2>

<OL>
<LI><A HREF="#1">How to run</A> AliRoot
<LI><A HREF="roothtml/USER_Index.html">AliRoot classes</A> 
</OL>

<HR>
<BR>
<H2><A NAME="1">1. How to run AliRoot</A></H2>

<P>To execute the Alice detector simulation program.

<UL>
<LI>Type: <KBD> $ aliroot </KBD> 

<BR> this starts AliRoot in interactive mode by default after few seconds
the <b>root</b> prompt apears 
<BR>you can now start a AliRoot
interactive session by either creating the standard menu

<LI>Type: <KBD> root[0] .x menu.C </KBD>  
<BR> or directly
<LI>Type: <KBD> root[1] gAlice->Run() </KBD>
<BR> or  
<LI>Type: <KBD> root[1] gAlice->RunLego() </KBD>
<BR>
<BR> to divert the long output generated by the AliRoot initialisation phase 
to an eg. AliRoot.log file 
<LI>Type: <KBD> root[3] .x menu.C > AliRoot.log </KBD>
<BR> or 
<LI>Type: <KBD> root[4] gAlice->Run(); > AliRoot.log </KBD>
</UL>

<P>The time for the initialisation phase of AliRoot is typicaly 30 seconds.

<P> By default the macro <A HREf="roothtml/examples/menu.C.html">menu.C</A>
invokes <A HREF="roothtml/AliRun.html">AliRun::Init</A> with the
configuration file <A HREF="roothtml/examples/Config.C.html">Config.C</A>.

<P>When the initialisation is finished the <b>root</b> prompt apears
again.
<BR>You also get back the Root control bar menu.

<P>You can now select options from the bar menu.

<UL>
<LI><B> Run </B>
<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> 
<BR><BR>
<LI><B> RunLego </B>    
<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.
<BR>To view the results when this command is finished type:
<br><br>
<KBD> root[0] .x <A HREF="roothtml/examples/lego.C.html">lego.C</A> </KBD>

<BR> 
<BR> to change the parameters if you do not want to run with the default ones
type:
<br><br><KBD> root[3] gAlice->RunLego (your list of parameters) </KBD> 
<br><BR> see 
<A HREF="roothtml/AliRun.html">AliRun::RunLego </A> for details     

<BR><BR>
<LI><B> Top, Front, Side view </B>
<BR> to generate the corresponding cut view of Alice detector. 
<BR> note that it takes a long time to execute a cut view typicaly 
of the order of about 30 sec. 
<BR><BR>
<LI><B> Menu Trees </B>
<BR> this shows a new menu from which you can draw the geometry tree for 
     most of Alice detectors.
<BR> double-clicking on an Alice detector generates its specifications.
<BR><BR>
<LI><B> Menu Pictures  </B>
<BR> this shows a new menu from which you can draw the major Alice detectors
     in shade mode. 
<BR><BR>
<LI><B> Other Options  </B>
<BR> allow to switch ON/OFF various drawing modes.
</UL>
    
<P>For more details on the functionality see the documentation of 
<A HREF="roothtml/AliRun.html">AliRun</A> and
<A HREF="roothtml/TGeant3.html">TGeant3</A> classes
<P>
A global varial <var> gAlice </var> 
can be used to invoke the AliRun class functions.
<BR>
A global varial <var>gMC</var> 
can be used to invoke the TGeant3 class functions.

<P> Note that several TGeant3 functions are also available by clicking with
the right button on a canvas while in the AliRoot session.

<P>
To quit AliRoot  
<UL>
<LI>Type: <KBD> root[3] .q </KBD> 
</UL


<!! ======================================================================>
<!! <BR><BR>
<!! <A NAME="2"><H2></H2> 

<!======================================================================>
<!! <BR>
<!! <A NAME="3"><H2></H2> 


<!!======================================================================>
<!! <BR><BR>
<!! <A NAME="4"><H2></H2> 


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