PAR: includes from previously enabled PARfiles
[u/mrichter/AliRoot.git] / doc / README
1 $Id$
2
3 AliRoot
4 -------
5
6 ########################### Release version 3.02 ##########################
7
8 Last update Tue Nov  9 08:26:53 CET 1999 - Federico Carminati
9
10 This is the Version 3.02 of the ALICE simulation and reconstruction
11 software. It is intended to offer a general purpose framework for ALICE
12 simulation and reconstruction. The program should not be considered
13 complete, and we are relying on the feed-back from users to correct bugs
14 and provide improvements.
15
16 The simulation program is based on GEANT3.21. A special version of the
17 GEANT library and a mini-CERN Library are included in the distribution.
18
19 Up-to-date information on installation and use of this code can be found at
20 http://www.cern.ch/alice/Projects/offline. This README is a very condensed
21 summary of the information contained there.
22
23
24 Installation
25 ------------
26
27 - Install ROOT and define the ROOTSYS symbol correctly.
28
29 - Decide in which directory you will install the ALICE sofware. We will
30 indicate it with <directory>
31
32 - Define the following global variables in the login script
33
34 ALICE                   = <directory>
35 ALICE_LEVEL             = pro
36 ALICE_ROOT              = $ALICE/$ALICE_LEVEL
37 ALICE_TARGET            = `uname`
38 LD_LIBRARY_PATH         = $ALICE_ROOT/lib/tgt_${ALICE_TARGET}\:$LD_LIBRARY_PATH (on all systems)
39 SHLIB_PATH              = $ALICE_ROOT/lib/tgt_${ALICE_TARGET}\:$SHLIB_PATH (on hpux)
40 PATH                    = $PATH\:$ALICE_ROOT/bin/tgt_${ALICE_TARGET}
41
42 At this point you should logout, login again and check that the symbols are
43 set correctly
44
45 EITHER
46 ======
47
48 - Get the file 
49               /afs/cern.ch/alice/offline/dist/AliOffline3.02.tar.gz
50   or the file 
51               ftp://pcepaip01.cern.ch/pub/AliOffline3.02.tar.gz
52
53 - Unpack it with
54
55 $ cd $ALICE
56 $ gtar xvfz AliOffline3.02pre.tar.gz
57
58 OR
59 ==
60
61 - Get the files
62
63       /afs/cern.ch/alice/offline/dist/AliRoot3.02.tar.gz (AliRoot code)
64       /afs/cern.ch/alice/offline/dist/AliLibs3.02.tar.gz (minicern code)
65
66 or the files
67
68       ftp://pcepaip01.cern.ch/pub/AliRoot3.02.tar.gz (AliRoot code)
69       ftp://pcepaip01.cern.ch/pub/AliLibs3.02.tar.gz (minicern code)
70
71 THEN PROCEED WITH
72 =================
73
74 - install the CERN library part
75
76 $ cd $ALICE_ROOT
77 $ gmake cernlibs
78
79 - Install the ALICE specific software
80
81 $ cd $ALICE_ROOT
82 $ gmake
83
84 - Copy the file $ALICE_ROOT/.rootrc to your home directory
85
86 - run the code
87
88 $ aliroot
89
90 root [1] .x menu.C
91
92