Use tgt_ prefix for binary target directories
[u/mrichter/AliRoot.git] / html / Installation.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
2 <HTML>
3 <HEAD>
4    <TITLE> Code Management and Installation for AliRoot </TITLE>
5    <!-- Changed by: Yiota Foka, 19-Mar-1999 -->
6    <STYLE TYPE="text/css">
7       
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 <body background="../picts/back.gif" text=black>
18 <basefont face="verdana,arial,helvetica,sans-serif">
19
20 <!-- Header material -->
21 <table border=0   cellpadding=5 cellspacing=0 width="100%">
22   <tr bgcolor=#eab575>
23       <td align=left width=20%> <img src="../picts/MadHatter.jpg" HEIGHT=130 WIDTH=130> &nbsp;
24       <td align=center>
25       <font size="+4"><b>
26
27 Code Management and Installation for AliRoot  
28      <td align=right width=20%> <img src="../picts/Logo.gif"> &nbsp;
29   </tr>
30
31   <tr>
32       <td colspan=3 align=right><font size="-1">
33           <script language="JavaScript">
34              document.write("Last modified "+ document.lastModified)
35              // end of script -->
36           </script></font>
37       </td>
38   </tr>
39 </table>
40 </HEAD>
41
42
43 <BODY TEXT="#000000" BGCOLOR="#FFFFFF" 
44 LINK="#0000FF" VLINK="#551A8B" ALINK="#FF0000">
45
46 <BR>
47 <BR>
48 <P>
49 <H2>Content</H2>
50
51 <OL>
52 <LI><A HREF="#1">Code management</A>
53 <LI><A HREF="#2">Release Policy</A>
54 <LI><A HREF="#3">Porting and availability</A>
55 <LI><A HREF="#4">Installation</A>
56 </OL>
57
58 <HR>
59 <BR>
60 <H2><A NAME="1">1. Code Management</A></H2>
61
62 <P>The code is maintained under <a href="http://www.cyclic.com/">cvs</a>. 
63 The cvs repository will be made public soon.
64
65
66 <!======================================================================>
67 <BR><BR><HR>
68 <A NAME="2">
69 <H2>2. Release Policy</H2> 
70
71 <P>It is the responsibility of the different detector groups to maintain
72 and develop the different modules describing the Alice detectors. The
73 modular structure of the code has been developed to reflect this fact, and
74 changes in one module should not affect the others.
75
76 <P>New modules can be provided, incorporated and tested within the AliRoot
77 framework. These should then be submitted and incorporated into the
78 centrally maintained filebase.
79
80 <P>Any query or proposal for a change in the code can be addressed to the
81 <A HREF="mailto:alice-sim@alice-lb.cern.ch">Alice Simulation Mailing
82 List</A>. Portions of code have to be sent to the <A
83 HREF="mailto:Frederico.Carminati@cern.ch">current maintainer</A> who has
84 the task to introduce them in the official code for the next release.
85
86 <P>For the moment we do not use any version control for the code. It is
87 expected that a version control mechanism will be soon put in place in the
88 framework of the Alice Offline Software.  Then AliRoot package will be
89 maintained via this control mechanism.
90
91 <P> We expect the code to evolve rapidly, as the TDR studies will require
92 frequent modifications and updates, so we have decided to reserve the right
93 to release a new version up to once a week.
94
95 <P>The AliRoot framework will support an <A HREF="
96 http://home.cern.ch/~ivana/AliceG4/AG4Presentations/AliceWeekMar99/index.html">
97 interface</A> to Geant4.  Reconstruction and analysis of simulated events
98 are also supported by AliRoot.
99
100 <!======================================================================>
101 <BR><BR><HR>
102 <A NAME="3">
103 <H2>3. Status and availability</H2> 
104
105 <P>The code is installed at CERN on the
106 <a href="http://wwwinfo.cern.ch/dis/ues/services/ion/service.html">ION
107 Work Group Server</a>. The ALICE environment is automatically setup at login
108 time, so users can immediately start using the code. Both a HP-UX and a Linux
109 versions are installed.
110
111 <p>All the code and the related material is available in the directory
112 pointed by the variable $ALICE_ROOT. The AliRoot package needs the few
113 packages and routines from the CERN Library. These are contained in a
114 reduced subset of the CERN Library available from the ALICE distribution.
115
116 <p>Users who do not have access to afs or who want to have a local installation
117 of the ALICE software should install the code locally according to the 
118 procedure described in the next chapter.
119
120 <p>As of writing the code has been tested on HP-UX 10.2, Linux 5.1, DEC OSF
121 and Solaris. Porting to other platforms and compilers will take place.
122
123
124
125 <!======================================================================>
126 <BR><BR><HR>
127 <A NAME="4"><H2>4. Installation Procedure </H2> 
128
129 <p>In order to install the code, the following steps should be performed:
130
131 <br><ol>
132
133 <p><li>Install <a href="http://root.cern.ch">ROOT</a> and define the necessary
134 symbols correctly.
135
136 <p><li>Decide in which directory you will install the ALICE sofware. We will
137 indicate it with <i>directory</i>
138
139 <p><li>Define the following global variables in the login script
140
141 <p><table align=centre border=yes>
142 <tr><th>variable</th><th>value</th></tr>
143 <tr><td width=30%>ALICE        </td><td> <i>directory</i>
144 <tr><td>ALICE_LEVEL             </td><td> pro </td></tr>
145 <tr><td>ALICE_ROOT              </td><td> $ALICE/$ALICE_LEVEL </td></tr>
146 <tr><td>ALICE_TARGET            </td><td> `uname` 
147 (i.e. result of the Unix <b>uname</b> command)</td></tr>
148 <tr><td>
149 LD_LIBRARY_PATH<BR>SHLIB_PATH   </td>
150 <td> $ALICE_ROOT/lib/tgt_${ALICE_TARGET}\:$LD_LIBRARY_PATH (on all systems) <br>
151 $ALICE_ROOT/lib/tgt_${ALICE_TARGET}\:$SHLIB_PATH (on hpux) </td></tr>
152 </td></tr>
153 <tr><td>PATH                    </td><td> $PATH\:$ALICE_ROOT/bin/tgt_${ALICE_TARGET} </td></tr>
154 </table>
155
156 <p>At this point you should logout, login again and check that the symbols
157 are set correctly.
158
159 <p><li><u><b>Either</b></u>
160 <p><ol type=i>
161 <li>Get the file <a href="file:/afs/cern.ch/alice/offline/dist/AliOffline3.01.tar.gz">/afs/cern.ch/alice/offline/dist/AliOffline3.01.tar.gz</a>
162
163 <p><li>Unpack it with
164
165 <p>
166 <pre>
167 $ cd $ALICE
168 $ gtar xvfz AliOffline3.01.tar.gz
169 </pre>
170 </ol>
171
172 <p><u><b>Or</b></u>
173 <p><ol type=i>
174
175 <li>Get the files
176 <p><a href="file:/afs/cern.ch/alice/offline/dist/AliRoot3.01.tar.gz">/afs/cern.ch/alice/offline/dist/AliRoot3.01.tar.gz</a>
177 <br><a href="file:/afs/cern.ch/alice/offline/dist/AliLibs3.01.tar.gz">/afs/cern.ch/alice/offline/dist/AliLibs3.01.tar.gz</a>
178
179 <p><li>Unpack them with
180
181 <p>
182 <pre>
183 $ cd $ALICE
184 $ gtar xvfz AliRoot3.01.tar.gz
185 $ gtar xvfz AliLibs3.01.tar.gz
186 </pre>
187 </ol>
188
189 <p><li>install the CERN library part
190
191 <p><pre>
192 $ cd $ALICE_ROOT
193 $ gmake cernlibs
194 </pre>
195
196 <p><li>Install the ALICE specific software
197
198 <p><pre>
199 $ cd $ALICE_ROOT
200 $ gmake
201 </pre>
202
203 <p><li>Copy the file $ALICE_ROOT/.rootrc to your home directory
204
205 <p><li>Change to your home directory and run the code
206
207 <p>
208 <pre>
209 $ cd
210 $ aliroot
211
212 <output from aliroot>
213
214 root [1] .x menu.C
215 </pre>
216 </ol>
217
218 <h3>Notice for Linux users</h3>
219
220 <p>AliRoot requires the compiler system egcs 1.1.1 or later. Unfortunately
221 the location of the include files is dependent on the compiler version on
222 Linux.  While g++ knows the location of the files relative to its own
223 version, but this is not the case for the makedepend, that should be told
224 where include files are. This is accomplished by the DEPINC variable in the
225 file $ALIROOT/conf.
226
227 <p>In case several error message appear during the make phase, complaining
228 for include files not found, the list of include directories in DEPINC
229 should be compared with the standard list of the compiler, that can be
230 found out with the following commands:
231
232 <p><pre>
233 touch dummy.cxx
234 g++ -v dummy.cxx
235 </pre>
236
237 <p>and looking at the output between the lines:
238
239 <p><pre>
240 #include <...> search starts here:
241 .
242 .
243 .
244 .
245 End of search list.
246 </pre>
247
248
249 <!===========================================================================>
250 <P>
251 <BR>
252 <HR size=4>
253 <BR>
254 Page maintained by: 
255 <A HREF="mailto:Yiota.Foka@cern.ch">Yiota Foka</A>
256 <BR>
257 Back to: 
258 <A HREF="http://www1.cern.ch/ALICE">ALICE home,</A>
259 <A HREF="http://www1.cern.ch/ALICE/Projects/offline">Offline home</A>
260 </BODY>
261 </HTML>
262
263
264