added changelog for the release
[u/mrichter/AliRoot.git] / html / Installation.html
CommitLineData
fe4da5cc 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">
1439f98e 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 -->
1439f98e 17<body background="../picts/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%">
1439f98e 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
27Code 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">
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</HEAD>
41
42
43<BODY TEXT="#000000" BGCOLOR="#FFFFFF"
44LINK="#0000FF" VLINK="#551A8B" ALINK="#FF0000">
45
46<BR>
1439f98e 47<BR>
48<P>
fe4da5cc 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 as a set of files and headers assembled via a
63Makefile. We realise that this configuration is not satisfactory, and we
64will migrate to a more coherent code management scheme in due time.
65
66
67<!======================================================================>
68<BR><BR><HR>
69<A NAME="2">
70<H2>2. Release Policy</H2>
71
72<P>It is the responsibility of the different detector groups to maintain
73and develop the different modules describing the Alice detectors. The
74modular structure of the code has been developed to reflect this fact, and
75changes in one module should not affect the others.
76
77<P>New modules can be provided, incorporated and tested within the AliRoot
78framework. These should then be submitted and incorporated into the
79centrally maintained filebase.
80
81<P>Any query or proposal for a change in the code can be addressed to the
82<A HREF="mailto:alice-sim@alice-lb.cern.ch">Alice Simulation Mailing
83List</A>. Portions of code have to be sent to the <A
84HREF="mailto:Frederico.Carminati@cern.ch">current maintainer</A> who has
85the task to introduce them in the official code for the next release.
86
87<P>For the moment we do not use any version control for the code. It is
88expected that a version control mechanism will be soon put in place in the
89framework of the Alice Offline Software. Then AliRoot package will be
90maintained via this control mechanism.
91
92<P> We expect the code to evolve rapidly, as the TDR studies will require
93frequent modifications and updates, so we have decided to reserve the right
94to release a new version up to once a week.
95
96<P>The AliRoot framework will support an <A HREF="
97http://home.cern.ch/~ivana/AliceG4/AG4Presentations/AliceWeekMar99/index.html">
98interface</A> to Geant4. Reconstruction and analysis of simulated events
99are also supported by AliRoot.
100
101<!======================================================================>
102<BR><BR><HR>
103<A NAME="3">
104<H2>3. Status and availability</H2>
105
106<P>The code is installed at CERN on the
107<a href="http://wwwinfo.cern.ch/dis/ues/services/ion/service.html">ION
108Work Group Server</a>. The ALICE environment is automatically setup at login
109time, so users can immediately start using the code. Both a HP-UX and a Linux
110versions are installed.
111
112<p>All the code and the related material is available in the directory
113pointed by the variable $ALICE_ROOT. The AliRoot package needs the few
114packages and routines from the CERN Library. These are contained in a
115reduced subset of the CERN Library available from the ALICE distribution.
116
117<p>Users who do not have access to afs or who want to have a local installation
118of the ALICE software should install the code locally according to the
119procedure described in the next chapter.
120
121<p>As of writing the code has been tested on HP-UX 10.2, Linux 5.1 and
122Solaris. Porting to other platforms and compilers will take place.
123
124
125
126<!======================================================================>
127<BR><BR><HR>
128<A NAME="4"><H2>4. Installation Procedure </H2>
129
130<p>In order to install the code, the following steps should be performed:
131
132<br><ol>
133
134<p><li>Install <a href="http://root.cern.ch">ROOT</a> and define the necessary
135symbols correctly.
136
137<p><li>Decide in which directory you will install the ALICE sofware. We will
138indicate it with <i>directory</i>
139
140<p><li>Define the following global variables in the login script
141
142<p><table align=centre border=yes>
143<tr><th>variable</th><th>value</th></tr>
144<tr><td width=30%>ALICE </td><td> <i>directory</i>
145<tr><td>ALICE_LEVEL </td><td> pro </td></tr>
146<tr><td>ALICE_ROOT </td><td> $ALICE/$ALICE_LEVEL </td></tr>
147<tr><td>ALICE_TARGET </td><td> `uname`
148(i.e. result of the Unix <b>uname</b> command)</td></tr>
149<tr><td>
150LD_LIBRARY_PATH<BR>SHLIB_PATH </td>
151<td> $LD_LIBRARY_PATH\:$ALICE_ROOT/lib (on all systems) <br>
152$SHLIB_PATH\:$ALICE_ROOT/lib (on hpux) </td></tr>
153</td></tr>
154<tr><td>PATH </td><td> $PATH\:$ALICE_ROOT/bin </td></tr>
155</table>
156
157<p>At this point you should logout, login again and check that the symbols
158are set correctly.
159
1439f98e 160<p><li><u><b>Either</b></u>
161<p><ol type=i>
162<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>
fe4da5cc 163
164<p><li>Unpack it with
165
166<p>
167<pre>
168$ cd $ALICE
169$ gtar xvfz AliOffline3.01.tar.gz
170</pre>
1439f98e 171</ol>
172
173<p><u><b>Or</b></u>
174<p><ol type=i>
175
176<li>Get the files
177<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>
178<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>
179
180<p><li>Unpack them with
181
182<p>
183<pre>
184$ cd $ALICE
185$ gtar xvfz AliRoot3.01.tar.gz
186$ gtar xvfz AliLibs3.01.tar.gz
187</pre>
188</ol>
fe4da5cc 189
190<p><li>install the CERN library part
191
192<p><pre>
193$ cd $ALICE_ROOT
194$ gmake cernlibs
195</pre>
196
197<p><li>Install the ALICE specific software
198
199<p><pre>
200$ cd $ALICE_ROOT
201$ gmake
202</pre>
203
204<p><li>Copy the file $ALICE_ROOT/.rootrc to your home directory
205
206<p><li>Change to your home directory and run the code
207
208<p>
209<pre>
210$ cd
211$ aliroot
212
213<output from aliroot>
214
215root [1] .x menu.C
216</pre>
217</ol>
218
219
220<!===========================================================================>
221<P>
222<BR>
223<HR size=4>
224<BR>
225Page maintained by:
226<A HREF="mailto:Yiota.Foka@cern.ch">Yiota Foka</A>
227<BR>
228Back to:
229<A HREF="http://www1.cern.ch/ALICE">ALICE home,</A>
230<A HREF="http://www1.cern.ch/ALICE/Projects/offline">Offline home</A>
231</BODY>
232</HTML>
233
234
235