[u/mrichter/AliRoot.git] / README

AliRoot
-------

########################### Pre-release version ###############################
########################### Use at your onw risk ##############################

Last update Mon Jun  7 11:49:05 - 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

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

- Unpack it with

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

- 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.


List of changes
===============

Sun Mar 21 12:38:38 CET 1999 ==================================================

-------------------------------------------------------------------------------
AliRun.cxx
removed AliDetector::FinishEvent call from AliRun::FinishRun

-------------------------------------------------------------------------------
Makefile.hpux
added +Onolimit to the optimisation on the hp to avoid warning messages

-------------------------------------------------------------------------------
TOPDIR changed to ALITOP as it should be in this README file. 

Wed Mar 24 15:44:49 CET 1999 ==================================================

-------------------------------------------------------------------------------
SGI Makefile corrected

-------------------------------------------------------------------------------
Make-macros corrected to include the ITS*.det files in the distribution

-------------------------------------------------------------------------------
Code of PHOSv2 introduced, thanks to M. Volkov

Thu Mar 25 21:19:52 CET 1999 ==================================================

-------------------------------------------------------------------------------
Change the load order in Make-macros

Wed Apr  7 09:25:51 CEST 1999 =================================================

-------------------------------------------------------------------------------
AliTPC.cxx, AliTPCv2.cxx, AliTPCSecGeo.h, GeantPatch.F

The drift gas parameters updated using the recent numbers from A.Sharma.
M.Kowalski

Thu Apr  8 16:08:12 CEST 1999 =================================================

-------------------------------------------------------------------------------
Slight changes to M.Volkov files to correct some syntactical problems

-------------------------------------------------------------------------------
Changed common_ to G..._t in TGeant3.h to be compatible with P.Murat, CDF.

Fri Apr  9 08:06:21 CEST 1999 =================================================

-------------------------------------------------------------------------------
Restructuration of TGeant3. Common addresses are now returned by access
functions and they are all private.

Fri Apr 20 08:06:21 CEST 1999 =================================================

-------------------------------------------------------------------------------
Introduction of the cvs repository. Now all changes are maintained via cvs.
Commit	Line	Data
	1	AliRoot
	2	-------
	3
	4	########################### Pre-release version ###############################
	5	########################### Use at your onw risk ##############################
	6
	7	Last update Mon Jun 7 11:49:05 - Federico Carminati
	8
	9	This is the Version 3.01 of the ALICE simulation and reconstruction
	10	software. This code will be released after the May ALICE Offline
	11	Meeting. 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 needed to run this code.
	18
	19	Installation
	20	------------
	21
	22	- Install ROOT and define the ROOTSYS symbol correctly.
	23
	24	- Decide in which directory you will install the ALICE sofware. We will
	25	indicate it with <directory>
	26
	27	- Define the following global variables in the login script
	28
	29	ALICE = <directory>
	30	ALICE_LEVEL = pro
	31	ALICE_ROOT = $ALICE/$ALICE_LEVEL
	32	ALICE_TARGET = `uname`
	33	LD_LIBRARY_PATH = $LD_LIBRARY_PATH\:$ALICE_ROOT/lib (on all systems)
	34	SHLIB_PATH = $SHLIB_PATH\:$ALICE_ROOT/lib (on hpux)
	35	PATH = $PATH\:$ALICE_ROOT/bin
	36
	37	At this point you should logout, login again and check that the symbols are
	38	set correctly
	39
	40	- Get the file /afs/cern.ch/alice/offline/AliOffline3.01.tar.gz
	41
	42	- Unpack it with
	43
	44	$ cd $ALICE
	45	$ gtar xvfz AliOffline3.01.tar.gz
	46
	47	- install the CERN library part
	48
	49	$ cd $ALICE_ROOT
	50	$ gmake cernlibs
	51
	52	- Install the ALICE specific software
	53
	54	$ cd $ALICE_ROOT
	55	$ gmake
	56
	57	- Copy the file $ALICE_ROOT/.rootrc to your home directory
	58
	59	- run the code
	60
	61	$ aliroot
	62
	63	root [1] .x menu.C
	64
	65
	66	Notice for Linux users
	67	======================
	68
	69	AliRoot requires the compiler system egcs 1.1.1 or later. Unfortunately the
	70	location of the include files is dependent on the compiler version on Linux.
	71	While g++ knows the location of the files relative to its own version, but
	72	this is not the case for the makedepend, that should be told where include
	73	files are. This is accomplished by the DEPINC variable in the file
	74	$ALIROOT/conf.
	75
	76	In case several error message appear during the make phase, complaining for
	77	include files not found, the list of include directories in DEPINC should
	78	be compared with the standard list of the compiler, that can be found out
	79	with the following commands:
	80
	81	touch dummy.cxx
	82	g++ -v dummy.cxx
	83
	84	and looking at the output between the lines:
	85
	86	#include <...> search starts here:
	87	.
	88	.
	89	.
	90	.
	91	End of search list.
	92
	93
	94	List of changes
	95	===============
	96
	97	Sun Mar 21 12:38:38 CET 1999 ==================================================
	98
	99	-------------------------------------------------------------------------------
	100	AliRun.cxx
	101	removed AliDetector::FinishEvent call from AliRun::FinishRun
	102
	103	-------------------------------------------------------------------------------
	104	Makefile.hpux
	105	added +Onolimit to the optimisation on the hp to avoid warning messages
	106
	107	-------------------------------------------------------------------------------
	108	TOPDIR changed to ALITOP as it should be in this README file.
	109
	110	Wed Mar 24 15:44:49 CET 1999 ==================================================
	111
	112	-------------------------------------------------------------------------------
	113	SGI Makefile corrected
	114
	115	-------------------------------------------------------------------------------
	116	Make-macros corrected to include the ITS*.det files in the distribution
	117
	118	-------------------------------------------------------------------------------
	119	Code of PHOSv2 introduced, thanks to M. Volkov
	120
	121	Thu Mar 25 21:19:52 CET 1999 ==================================================
	122
	123	-------------------------------------------------------------------------------
	124	Change the load order in Make-macros
	125
	126	Wed Apr 7 09:25:51 CEST 1999 =================================================
	127
	128	-------------------------------------------------------------------------------
	129	AliTPC.cxx, AliTPCv2.cxx, AliTPCSecGeo.h, GeantPatch.F
	130
	131	The drift gas parameters updated using the recent numbers from A.Sharma.
	132	M.Kowalski
	133
	134	Thu Apr 8 16:08:12 CEST 1999 =================================================
	135
	136	-------------------------------------------------------------------------------
	137	Slight changes to M.Volkov files to correct some syntactical problems
	138
	139	-------------------------------------------------------------------------------
	140	Changed common_ to G..._t in TGeant3.h to be compatible with P.Murat, CDF.
	141
	142	Fri Apr 9 08:06:21 CEST 1999 =================================================
	143
	144	-------------------------------------------------------------------------------
	145	Restructuration of TGeant3. Common addresses are now returned by access
	146	functions and they are all private.
	147
	148	Fri Apr 20 08:06:21 CEST 1999 =================================================
	149
	150	-------------------------------------------------------------------------------
	151	Introduction of the cvs repository. Now all changes are maintained via cvs.