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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
   <TITLE> Code Management and Installation for AliRoot </TITLE>
   <!-- Changed by: Yiota Foka, 19-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>Installation & Distribution</H1>
<P><HR>
<H2>Content</H2>

<OL>
<LI><A HREF="#1">Code management</A>
<LI><A HREF="#2">Release Policy</A>
<LI><A HREF="#3">Porting and availability</A>
<LI><A HREF="#4">Installation</A>
</OL>

<HR>
<BR>
<H2><A NAME="1">1. Code Management</A></H2>

<P>The code is maintained as a set of files and headers assembled via a
Makefile.  We realise that this configuration is not satisfactory, and we
will migrate to a more coherent code management scheme in due time.


<!======================================================================>
<BR><BR><HR>
<A NAME="2">
<H2>2. Release Policy</H2> 

<P>It is the responsibility of the different detector groups to maintain
and develop the different modules describing the Alice detectors. The
modular structure of the code has been developed to reflect this fact, and
changes in one module should not affect the others.

<P>New modules can be provided, incorporated and tested within the AliRoot
framework. These should then be submitted and incorporated into the
centrally maintained filebase.

<P>Any query or proposal for a change in the code can be addressed to the
<A HREF="mailto:alice-sim@alice-lb.cern.ch">Alice Simulation Mailing
List</A>. Portions of code have to be sent to the <A
HREF="mailto:Frederico.Carminati@cern.ch">current maintainer</A> who has
the task to introduce them in the official code for the next release.

<P>For the moment we do not use any version control for the code. It is
expected that a version control mechanism will be soon put in place in the
framework of the Alice Offline Software.  Then AliRoot package will be
maintained via this control mechanism.

<P> We expect the code to evolve rapidly, as the TDR studies will require
frequent modifications and updates, so we have decided to reserve the right
to release a new version up to once a week.

<P>The AliRoot framework will support an <A HREF="
http://home.cern.ch/~ivana/AliceG4/AG4Presentations/AliceWeekMar99/index.html">
interface</A> to Geant4.  Reconstruction and analysis of simulated events
are also supported by AliRoot.

<!======================================================================>
<BR><BR><HR>
<A NAME="3">
<H2>3. Status and availability</H2> 

<P>The code is installed at CERN on the
<a href="http://wwwinfo.cern.ch/dis/ues/services/ion/service.html">ION
Work Group Server</a>. The ALICE environment is automatically setup at login
time, so users can immediately start using the code. Both a HP-UX and a Linux
versions are installed.

<p>All the code and the related material is available in the directory
pointed by the variable $ALICE_ROOT. The AliRoot package needs the few
packages and routines from the CERN Library. These are contained in a
reduced subset of the CERN Library available from the ALICE distribution.

<p>Users who do not have access to afs or who want to have a local installation
of the ALICE software should install the code locally according to the 
procedure described in the next chapter.

<p>As of writing the code has been tested on HP-UX 10.2, Linux 5.1 and 
Solaris. Porting to other platforms and compilers will take place.


<!======================================================================>
<BR><BR><HR>
<A NAME="4"><H2>4. Installation Procedure </H2> 

<p>In order to install the code, the following steps should be performed:

<br><ol>

<p><li>Install <a href="http://root.cern.ch">ROOT</a> and define the necessary
symbols correctly.

<p><li>Decide in which directory you will install the ALICE sofware. We will
indicate it with <i>directory</i>

<p><li>Define the following global variables in the login script

<p><table align=centre border=yes>
<tr><th>variable</th><th>value</th></tr>
<tr><td width=30%>ALICE	       </td><td> <i>directory</i>
<tr><td>ALICE_LEVEL		</td><td> pro </td></tr>
<tr><td>ALICE_ROOT		</td><td> $ALICE/$ALICE_LEVEL </td></tr>
<tr><td>ALICE_TARGET		</td><td> `uname` 
(i.e. result of the Unix <b>uname</b> command)</td></tr>
<tr><td>
LD_LIBRARY_PATH<BR>SHLIB_PATH 	</td>
<td> $LD_LIBRARY_PATH\:$ALICE_ROOT/lib (on all systems) <br>
$SHLIB_PATH\:$ALICE_ROOT/lib (on hpux) </td></tr>
</td></tr>
<tr><td>PATH			</td><td> $PATH\:$ALICE_ROOT/bin </td></tr>
</table>

<p>At this point you should logout, login again and check that the symbols
are set correctly.

<p><li>Get the file <a href="file:/afs/cern.ch/alice/offline/AliOffline3.01.tar.gz">/afs/cern.ch/alice/offline/AliOffline3.01.tar.gz</a>

<p><li>Unpack it with

<p>
<pre>
$ cd $ALICE
$ gtar xvfz AliOffline3.01.tar.gz
</pre>

<p><li>install the CERN library part

<p><pre>
$ cd $ALICE_ROOT
$ gmake cernlibs
</pre>

<p><li>Install the ALICE specific software

<p><pre>
$ cd $ALICE_ROOT
$ gmake
</pre>

<p><li>Copy the file $ALICE_ROOT/.rootrc to your home directory

<p><li>Change to your home directory and run the code

<p>
<pre>
$ cd
$ aliroot

<output from aliroot>

root [1] .x menu.C
</pre>
</ol>


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