OLYMPUS Monte Carlo: Installation

The OLYMPUS Monte Carlo is based on GEANT4.

The current version used is GEANT4.9.3. GEANT4 is available from CERN but it also requires some other packages to be available. So it is necessary to install GEANT4

Installing GEANT4

For: Mac OS X, version 10.5.8 & SL5: Scientific Linux SL release 5.4 (Boron)

1. Prepare your system: build tools (X11 on Mac) and compiler (at least gcc version 4.0.1). At this point it is difficult to be more specific . You will see.

2. Install CLHEP (usually this part does not create any trouble), for both OSs:

download last version of source code from
http://wwwasd.web.cern.ch/wwwasd/lhc++/clhep/DISTRIBUTION/
when this text is written, the last release is: 2.1.0.0
on the chosen directory:
tar zxvf clhep-2.1.0.0.tgz
cd 2.1.0.0/CLHEP
./configure --prefix=<PRIVATE_CLHEP_INSTALLATION_DIRECTORY>

(default prefix is /usr/local)
make
make check
make install

3. Geant4.9.3 (other versions are not checked)

setup/create your PRIVATE_GEANT_INSTALLATION_DIRECTORY for Geant
setup/create your path to the Data files, usually it is good to have as:
PRIVATE_GEANT_INSTALLATION_DIRECTORY/data
download data files from
http://geant4.cern.ch/support/download.shtm
to your source directory (GEANT_SOURCE_DIR)
copy data files to proper directory:
cp G4NDL.3.13.tar.gz G4NDL.0.2.tar.gz G4EMLOW.6.9.tar.gz PhotonEvaporation.2.0.tar.gz G4RadioactiveDecay.3.2.tar.gz G4ABLA.3.0.tar.gz RealSurface.1.0.tar.gz PRIVATE_GEANT_INSTALLATION_DIRECTORY/data
cd PRIVATE_GEANT_INSTALLATION_DIRECTORY/data
start the loop (only zsh !)

foreach i (`ls *.gz`)
echo $i; tar zxvf $i
end

cd GEANT_SOURCE_DIR
download source of Geant from
http://geant4.cern.ch/support/download.shtml
tar zxvf geant4.9.3.p01.tar
cd geant4.9.3.p01
help, if you need more complicate set of options:
./Configure -h
start to build the Geant. During creation of configuration setup you have to provide some answers. In the next point are listed only those questions which should be answered differently than suggested by script or answered at all:

./Configure -build

...
OPTIONS FOR GEANT4 INSTALLATION PATHS*
...
Where should Geant4 be installed? [<GEANT_SOURCE_DIR>]
PRIVATE_GEANT_INSTALLATION_DIRECTORY <-- answer
...
CHECKS AND OPTIONS FOR GEANT4 PHYSICS DATA FILES*
Specify the path where the Geant4 data libraries are installed:
[<GEANT_SOURCE_DIR>/data]
PRIVATE_GEANT_INSTALLATION_DIRECTORY/data <-- answer
...
CLHEP_BASE_DIR:
PRIVATE_CLHEP_INSTALLATION_DIRECTORY <-- answer
...
OPTIONS FOR GEANT4 USER INTERFACE MODULES*
Enable building of User Interface (UI) modules? [y] y
...
Enable building of the X11-Motif (Xm) UI module? [n] y
...
OPTIONS FOR GEANT4 VISUALIZATION DRIVERS*
...
Enable building of the X11 OpenGL visualization driver? [n] y
Enable building of the X11-Motif OpenGL visualization driver? [n] y
Enable building of the X11 RayTracer visualization driver? [n] y
...

Once all of the questions have been answered, you will find the message:
"WARNING: the generated configuration file can be edited if necessary!
You can introduce any change to the configuration file
<GEANT_SOURCE_DIR>/geant4.9.3.p01/.config/bin/Linux-g++/config.sh before the final installation.
To do so, use a shell escape now (e.g. !vi <GEANT_SOURCE_DIR>/geant4.9.3.p01/.config/bin/Linux-g++/config.sh).

Press [Enter] to start installation or use a shell escape to edit config.sh:"

it is the last chance to change the configuration file. After pressing ENTER button, take a big coffee ...

If you made a mistake before, it is better to start the Geant installation from the very beginning, e.g. from removing your untared Geant directory and untar the Geant tarball geant4.9.3.p01.tar again .

if the build procedure is finished without errors, start the next step:
./Configure -install
after that, you have to create setup files that you will need to start in future sessions with OLYMPUS Monte Carlo software:
./Configure

You should find the following information:
"---------------------------------------------------
The Geant4 toolkit installation was found.
The files env.[c]sh will be copied to your current directory.
For setting Geant4 environments you should make:
source env.csh
or
. env.sh
It will also check G4WORKDIR setting and set it to your HOME if needed.
You can use these files also for further modifications (adding your own environments).
---------------------------------------------------
"
and two scripts: env.csh, env.sh . Use a proper one .

4. As the last point, it is very convenient to initialize all necessary software before your work with OLYMPUS MC, including Root, Geant and Clhep parts in one go. The script can looks like:
a) setup.sh for Mac OS:
------------
# CLHEP
export DYLD_LIBRARY_PATH=<PRIVATE_CLHEP_INSTALLATION_DIRECTORY>/lib
# GEANT
source <GEANT_SOURCE_DIR>/geant4.9.3.p01/env.sh
# Root:
ROOTSYS=<ROOT_INSTALLATION_DIR>/root_v5.27.04/root
export PATH=$ROOTSYS/bin:$PATH
export DYLD_LIBRARY_PATH=$ROOTSYS/lib:$DYLD_LIBRARY_PATH
------------

b) setup.sh for SL5 (for zsh):
------------
# CLHEP
export LD_LIBRARY_PATH=<PRIVATE_CLHEP_INSTALLATION_DIRECTORY>/lib
# Geant:
source <GEANT_SOURCE_DIR>/geant4.9.3.p01/.config/bin/Linux-g++/env.sh
# Root:
ROOTSYS=<ROOT_INSTALLATION_DIR>/root
export PATH=$ROOTSYS/bin:$PATH
export LD_LIBRARY_PATH=$ROOTSYS/lib:/opt/products/lib/:$LD_LIBRARY_PATH
------------

use the script as:
. setup.sh