Installation

X-Git-Url: http://git.uio.no/git/?a=blobdiff_plain;f=html%2Finstallation.html;h=0ba35e927a571eb14e854877fac96d25c5e691ff;hb=50b0514498b6f7b8170195ebfacd14c94706cbcf;hp=dd377c3139ff0039a452c9b8f7b2ed0ddef5c85e;hpb=1f3e54b9c7df41a2afe33fd691f55c6485f4454d;p=u%2Fmrichter%2FAliRoot.git diff --git a/html/installation.html b/html/installation.html index dd377c3139f..0ba35e927a5 100644 --- a/html/installation.html +++ b/html/installation.html @@ -3,8 +3,11 @@ Installation - - - - +

@@ -30,7 +37,80 @@ COL, COLGROUP, TABLE, TBODY, TD, TR {

Installation

+ +

Prerequisites

+ +

Environment

+ +

The code is actively maintained on Linux and HP (both CC and aCC +compilers). It also runs on Compaq OSF1 and SunOS. We welcome feedback from +the installation on other systems and we will be happy to consider +modifications and corrections necessary to make the installation possible. + +

The disk space required for a full installation of AliRoot is 360MB for +the system itself and 120MB for the ROOT system. + +

gmake

+ +

The installation is performed via the + +gmake program. gmake is the +GNU version of make, it is free and, +if missing on your machine, it can be loaded from the GNU Internet site + +ftp://ftp.gnu.ai.mit.edu/pub/gnu/make. gmake is compatible +with the standard UNIX make and on the CERN ion WGS +make is aliased to gmake. The only files you need for +gmake are the executable gmake +and the script autoconf, therefore you can copy such files from +any site in a directory in your path. + +

ROOT

+ +

ROOT is available for many platforms, therefore in most cases +no ROOT installation is required. To install ROOT on your machine, +connect to the web site and follow the +link downloads. Usually you should get the latest release, unless +announced differently by the news of the Off-line Project. + +

All you need to do is download the compressed tar file, that usually is +called root_v...tar.gzuncompress and untar it (we supposed you +downloaded the tar file in your $HOME): + +

+$ gunzip root_v...tar.gz + $ cd directory # name of the directory where you want ROOT to sit + $ tar xvf ~/root_v...tar + + +

When tar ends, you will have the full root directory tree, with already +installed libraries for your platform. + +

The following shell variables should be defined in the login scripts: + +

+ + + + + + + + + +
variable value
ROOTSYS directory/root +
on all systems but HP-UX
LD_LIBRARY_PATH $LD_LIBRARY_PATH\:$ROOTSYS/lib
on HP-UX
SHLIB_PATH $SHLIB_PATH\:$ROOTSYS/lib
PATH $PATH\:$ROOTSYS/bin
+ + +

variable	value
ROOTSYS	directory/root +
on all systems but HP-UX
LD_LIBRARY_PATH	$LD_LIBRARY_PATH\:$ROOTSYS/lib
on HP-UX
SHLIB_PATH	$SHLIB_PATH\:$ROOTSYS/lib
PATH	$PATH\:$ROOTSYS/bin

Installation

Install ROOT and define the @@ -60,48 +140,53 @@ necessary variables correctly.
At this point you should logout, login again and check that the symbols are set correctly. -
Retrieve the AliRoot code. There are two ways to do this: - +

Retrieve the AliRoot code. This code is available under 3 main + versions (old, pro and new). Check the + Releases page to select the appropriate version and get + the corresponding CVS Tag. + There are two ways to retrieve the code: the + preferred way consists in retrieving a tar file on the ftp server and the + slow and network consuming way is checking out the whole cvs tree using + cvs. Cvsup may be available soon as an alternative. +

From a tar file. This is the preferred way for those who -do not have an internet connection to the cvs server from the -machine where the code has to be installed. The files containing the latest release -should be brought on the target machine. Three files are offered: - -

- - - - - - -
File Content
Either
AliOfflineMM.mm-pp.tar.gz - Code and the data files of ALICE Off-line
Or
AliLibsMM.mm-pp.tar.gz - Code and the data files of the auxiliary libraries
AliRootMM.mm-pp.tar.gz - All the code and the data files of the AliRoot system
- -

File	Content
Either
AliOfflineMM.mm-pp.tar.gz -	Code and the data files of ALICE Off-line
Or
AliLibsMM.mm-pp.tar.gz -	Code and the data files of the auxiliary libraries
AliRootMM.mm-pp.tar.gz -	All the code and the data files of the AliRoot system

MM.mm-pp is the number of the latest Major and -minor version and the patch number. Please refer to the -README file found in this directory for further information on file -content. The file(s) have to be unpacked into the $ALICE directory via the -command: - -

$ gtar xvfz Ali[...].tar.gz

- - -

From cvs remote cvs server. This method has the advantage -that new patches can be incrementally retrieved and installed via internet. -At the moment the problem is that the version of cvs currently installed at -CERN (1.09) does not support well binary files. Therefore some data files -will be missing with this download mechanism, and these will have to be -fetched by hand. The setup of the access to the remote cvs server -is described in the Code Development section. The -code is dowloaded via the command: - +
From a tar file. Tar files + for the different releases including an up-to-date file remade + every night are available on the + + Web server. The tar files include the + "CVS" subdirectories for the anonymous cvs user (login "cvs"). So after + getting the full tar file, it is possible to incrementally update + the code using cvs. + +
The tar file(s) can to be unpacked into the ALICE directory + via the command: + +
```
$ gtar xvfz V3.XX.tar.gz
```
+ +
A script changeCVSRoot + is available to convert a CVS tree under user "cvs" to another + user. For example,
```
 ChangeCVSRoot asmith 
```
+ +
From cvs remote cvs server. The setup for the access + to the remote cvs server is described in the + Code Development section. + The code can be downloaded via the following commands: +
```
 $ cd $ALICE
-$ cvsa co -d pro AliRoot
+$ setenv CVSROOT :pserver:cvs@alisoft.cern.ch:/soft/cvsroot
+$ cvs co -r Release-3-XX -d pro AliRoot
+
```
+ +
Update In both cases running a cvs update command + will update the latest changes to the code in the selected branch + (here branch "Release-3-XX"). So, for a full update, including + the automatic creation a new subdirectories, the commands are: +
```
+$ cd $ALICE/pro
+$ setenv CVSROOT :pserver:cvs@alisoft.cern.ch:/soft/cvsroot
+$ cvs update -d
 
```

@@ -122,6 +207,15 @@ $ gmake

Copy the file $ALICE_ROOT/.rootrc to your home directory +
For users with c-like shells, update your search path: + +
+
```
+$ rehash
+
```
+ +
This usually has to be done only once, after having defined the new PATH. +
Change to your home directory and run the code
@@ -135,13 +229,13 @@ root [1] .x menu.C

Code development and user environment

If the ALICE environment is set up correctly, the $ALICE_ROOT/lib/tgt_$ALICE_TARGET directory is in the shared libraries load path, and the $ALICE_ROOT/bin/tgt_$ALICE_TARGET -directory is in the PATH variable. This means that the command aliroot will -in fact correspond to the file +directory is in the PATH variable. This means that the command +aliroot will in fact correspond to the file $ALICE_ROOT/bin/tgt_$ALICE_TARGET/aliroot.

This is convenient for the normal user, but as soon as the user wants to @@ -154,10 +248,15 @@ executable will be ignored and the official version executed.

Therefore in order to develop one or more packages locally (let's say the TPC) and make modifications, the following steps should be -performed. We suppose here that the remote cvs server has been setup correctly -as explained in the code management section. - -

+performed. The remote cvs server use and setup is explained in the code development section. + +
+ + - + + - - - - + +
+

+ Preparation of the environment +

$ mkdir AliRoot create the working directory @@ -174,12 +273,20 @@ as explained in the code management section. $ ln -s $ALICE_ROOT/* ./ link all files here
$ rm lib + $ rm lib remove link for library, we need a local file here to containing the new TPC library
$ rm bin - remove link for bin directory, we need it to rebuild aliroot executable + remove bin, we need a local copy of the aliroot + executable +
$ mkdir bin + make a local bin directory +
$ rm CVS + remove the link to the CVS directory, we need a local one + to check-out files
$ rm TPC remove link for TPC subdirectory, we need the real files here @@ -188,11 +295,13 @@ as explained in the code management section. remove link to ALIROOT subdirectory, may be this is not really necessary on all systems, but we do it just to be on the safe side
$ cvsa co TPC - get from the cvs server the TPC files to be modified + $ cvs co -r Release-3-XX TPC + get from the cvs server the release version of the TPC files to be + modified
$ cvsa co ALIROOT - get from the server the ALIROOT files to recreate the executable + $ cvs co -r Release-3-XX ALIROOT + get from the server the release version of the ALIROOT files to recreate + the executable
$ mkdir -p lib/tgt_$ALICE_TARGET create library directory @@ -200,17 +309,23 @@ as explained in the code management section. $ cd lib/tgt_$ALICE_TARGET set default to the lib directory
$ ln -s $ALICE_ROOT/lib/* ./ + $ ln -s $ALICE_ROOT/lib/tgt_$ALICE_TARGET/* ./ link all libraries here
$ rm libTPC.sl + $ rm libTPC.sl (on HP) +
$ rm libTPC.so (on the other systems) remove link to TPC library, we need a real one
$ changeRoot $HOME/AliRoot - change the AliRoot root to $HOME/AliRoot + change the AliRoot root to $HOME/AliRoot via the changeRoot command
$ rehash make sure that the new PATH is taken into account by the shell +
+

+ Normal development cycle +

$ cd $ALICE_ROOT/TPC (1) set default to TPC directory @@ -238,6 +353,9 @@ as explained in the code management section.
$ aliroot (5) run aliroot +
+

+ + Preparation of the environment +
$ mkdir AliRoot	create the working directory @@ -174,12 +273,20 @@ as explained in the code management section.	$ ln -s $ALICE_ROOT/* ./	link all files here
$ rm lib +	$ rm lib	remove link for library, we need a local file here to containing the new TPC library
$ rm bin -	remove link for bin directory, we need it to rebuild aliroot executable +	remove bin, we need a local copy of the `aliroot` + executable +
$ mkdir bin +	make a local bin directory +
$ rm CVS +	remove the link to the CVS directory, we need a local one + to check-out files
$ rm TPC	remove link for TPC subdirectory, we need the real files here @@ -188,11 +295,13 @@ as explained in the code management section.	remove link to ALIROOT subdirectory, may be this is not really necessary on all systems, but we do it just to be on the safe side
$ cvsa co TPC -	get from the cvs server the TPC files to be modified +	$ cvs co -r Release-3-XX TPC +	get from the cvs server the release version of the TPC files to be + modified
$ cvsa co ALIROOT -	get from the server the ALIROOT files to recreate the executable +	$ cvs co -r Release-3-XX ALIROOT +	get from the server the release version of the ALIROOT files to recreate + the executable
$ mkdir -p lib/tgt_$ALICE_TARGET	create library directory @@ -200,17 +309,23 @@ as explained in the code management section.	$ cd lib/tgt_$ALICE_TARGET	set default to the lib directory
$ ln -s $ALICE_ROOT/lib/* ./ +	$ ln -s $ALICE_ROOT/lib/tgt_$ALICE_TARGET/* ./	link all libraries here
$ rm libTPC.sl +	$ rm libTPC.sl (on HP) + $ rm libTPC.so (on the other systems)	remove link to TPC library, we need a real one
$ changeRoot $HOME/AliRoot -	change the AliRoot root to $HOME/AliRoot +	change the AliRoot root to $HOME/AliRoot via the changeRoot command
$ rehash	make sure that the new PATH is taken into account by the shell +
+ + Normal development cycle +
$ cd $ALICE_ROOT/TPC	(1) set default to TPC directory @@ -238,6 +353,9 @@ as explained in the code management section.
$ aliroot	(5) run aliroot +
+

Steps 1-5 are the normal development cycle after the first pass through the @@ -246,10 +364,11 @@ procedure.

-by Federico Carminati +Please report problems to + webmaster@alisoft.cern.ch