[u/mrichter/AliRoot.git] / README

AliRoot
-------

########################### Release version 3.01 ##############################

Last update Tue Jun 15 08:10:40 1999 - Federico Carminati

This is the Version 3.01 of the ALICE simulation and reconstruction
software. This code will be released after the May ALICE Offline
Meeting. It is intended to offer a general purpose framework for ALICE
simulation and reconstruction. The program should not be considered
complete, and we are relying on the feed-back from users to correct bugs
and provide improvements.

The simulation program is based on GEANT3.21. A special version of the
GEANT library and a mini-CERN Library are needed to run this code.

Installation
------------

- Install ROOT and define the ROOTSYS symbol correctly.

- Decide in which directory you will install the ALICE sofware. We will
indicate it with <directory>

- Define the following global variables in the login script

ALICE			= <directory>
ALICE_LEVEL		= pro
ALICE_ROOT		= $ALICE/$ALICE_LEVEL
ALICE_TARGET		= `uname`
LD_LIBRARY_PATH 	= $LD_LIBRARY_PATH\:$ALICE_ROOT/lib (on all systems)
SHLIB_PATH		= $SHLIB_PATH\:$ALICE_ROOT/lib (on hpux)
PATH			= $PATH\:$ALICE_ROOT/bin

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

EITHER
======

- Get the file /afs/cern.ch/alice/offline/dist/AliOffline3.01.tar.gz

- Unpack it with

$ cd $ALICE
$ gtar xvfz AliOffline3.01.tar.gz

OR
==

- Get the files

      /afs/cern.ch/alice/offline/dist/AliRoot3.01.tar.gz (AliRoot code)
      /afs/cern.ch/alice/offline/dist/AliLibs3.01.tar.gz (minicern code)

THEN PROCEED WITH
=================

- install the CERN library part

$ cd $ALICE_ROOT
$ gmake cernlibs

- Install the ALICE specific software

$ cd $ALICE_ROOT
$ gmake

- Copy the file $ALICE_ROOT/.rootrc to your home directory

- run the code

$ aliroot

root [1] .x menu.C


Notice for Linux users
======================

AliRoot requires the compiler system egcs 1.1.1 or later. Unfortunately the 
location of the include files is dependent on the compiler version on Linux.
While g++ knows the location of the files relative to its own version, but 
this is not the case for the makedepend, that should be told where include
files are. This is accomplished by the DEPINC variable in the file
$ALIROOT/conf.

In case several error message appear during the make phase, complaining for
include files not found, the list of include directories in DEPINC should
be compared with the standard list of the compiler, that can be found out
with the following commands:

touch dummy.cxx
g++ -v dummy.cxx

and looking at the output between the lines:

#include <...> search starts here:
.
.
.
.
End of search list.
Commit	Line	Data
fe4da5cc	1	AliRoot
	2	-------
	3
5d141f13	4	########################### Release version 3.01 ##############################
fe4da5cc	5
06d167b9	6	Last update Tue Jun 15 08:10:40 1999 - Federico Carminati
fe4da5cc	7
	8	This is the Version 3.01 of the ALICE simulation and reconstruction
	9	software. This code will be released after the May ALICE Offline
	10	Meeting. It is intended to offer a general purpose framework for ALICE
	11	simulation and reconstruction. The program should not be considered
	12	complete, and we are relying on the feed-back from users to correct bugs
	13	and provide improvements.
	14
	15	The simulation program is based on GEANT3.21. A special version of the
	16	GEANT library and a mini-CERN Library are needed to run this code.
	17
	18	Installation
	19	------------
	20
	21	- Install ROOT and define the ROOTSYS symbol correctly.
	22
	23	- Decide in which directory you will install the ALICE sofware. We will
	24	indicate it with <directory>
	25
	26	- Define the following global variables in the login script
	27
	28	ALICE = <directory>
	29	ALICE_LEVEL = pro
	30	ALICE_ROOT = $ALICE/$ALICE_LEVEL
	31	ALICE_TARGET = `uname`
	32	LD_LIBRARY_PATH = $LD_LIBRARY_PATH\:$ALICE_ROOT/lib (on all systems)
	33	SHLIB_PATH = $SHLIB_PATH\:$ALICE_ROOT/lib (on hpux)
	34	PATH = $PATH\:$ALICE_ROOT/bin
	35
	36	At this point you should logout, login again and check that the symbols are
	37	set correctly
	38
5d141f13	39	EITHER
	40	======
	41
06d167b9	42	- Get the file /afs/cern.ch/alice/offline/dist/AliOffline3.01.tar.gz
fe4da5cc	43
	44	- Unpack it with
	45
	46	$ cd $ALICE
	47	$ gtar xvfz AliOffline3.01.tar.gz
	48
5d141f13	49	OR
	50	==
	51
	52	- Get the files
	53
	54	/afs/cern.ch/alice/offline/dist/AliRoot3.01.tar.gz (AliRoot code)
	55	/afs/cern.ch/alice/offline/dist/AliLibs3.01.tar.gz (minicern code)
	56
	57	THEN PROCEED WITH
	58	=================
	59
fe4da5cc	60	- install the CERN library part
	61
	62	$ cd $ALICE_ROOT
	63	$ gmake cernlibs
	64
	65	- Install the ALICE specific software
	66
	67	$ cd $ALICE_ROOT
	68	$ gmake
	69
	70	- Copy the file $ALICE_ROOT/.rootrc to your home directory
	71
	72	- run the code
	73
	74	$ aliroot
	75
	76	root [1] .x menu.C
	77
	78
2938d1f5	79	Notice for Linux users
	80	======================
	81
	82	AliRoot requires the compiler system egcs 1.1.1 or later. Unfortunately the
	83	location of the include files is dependent on the compiler version on Linux.
	84	While g++ knows the location of the files relative to its own version, but
	85	this is not the case for the makedepend, that should be told where include
	86	files are. This is accomplished by the DEPINC variable in the file
	87	$ALIROOT/conf.
	88
	89	In case several error message appear during the make phase, complaining for
	90	include files not found, the list of include directories in DEPINC should
	91	be compared with the standard list of the compiler, that can be found out
	92	with the following commands:
	93
	94	touch dummy.cxx
	95	g++ -v dummy.cxx
	96
	97	and looking at the output between the lines:
	98
	99	#include <...> search starts here:
	100	.
	101	.
	102	.
	103	.
	104	End of search list.
	105