New default values for baselines (F.Prino)
[u/mrichter/AliRoot.git] / TFluka / documents / README
1 TFLUKA
2 ======
3
4 TFluka is the FLUKA implementation of the Virtual MC. For the time
5 being it uses the GEANT4 geometry through Flugg. The geometry itself
6 is built to the GEANT4 geometry through geant4_vmc. Please be aware
7 that this is still a development project and that many things might
8 not work as expected. Fill free to fix them or suggest improvements.
9
10 HOW TO BUILD TFLUKA
11 ===================
12
13 0) Download (if you read this you have probably already done that) and
14 install the default AliRoot.
15
16 1) External packages needed:
17
18   * Download FLUKA from http://pcfluka.mi.infn.it/ and install it
19
20   * Download geant4_vmc and install it (together with GEANT4, CLHEP, etc)
21     See http://root.cern.ch/root/vmc/VirtualMC.html
22     NOTE: All the geant4_vmc headers are assumed to be in 
23     $ALICE/geant4_vmc/include. To put them there execute `gmake includes`
24     in the geant4_vmc/source directory
25
26 2) Set your environment:
27
28   * Set the path to FLUKA in the environment variable FLUPRO
29
30   * Set your GEANT4 environment in the usual way.
31
32   * Make sure that your LD_LIBRARY_PATH includes the path to CLHEP, GEANT4 
33     and geant4_vmc libraries
34
35 3) Compile TFluka and Flugg. In AliRoot do: 
36
37   * gmake all-TFluka
38
39   * gmake all-Flugg
40
41
42
43 HOW TO USE TFLUKA
44 ================== 
45
46 An small script ($ALICE_ROOT/TFluka/scripts/runalifluka.csh) is
47 provided that handles the creation of temporary files that FLUKA
48 expects as input. A ROOT macro loads all the needed libraries. Then,
49 one should proceed as in any other implementation of the Virtual MC.
50 So:
51
52 1) Execute the $ALICE_ROOT/TFluka/scripts/runalifluka.csh
53
54 2) [root] .x $ALICE_ROOT/TFluka/macro/loadlibs.C
55
56 3) [root] gAlice->RunMC();
57
58
59 This will run 50 particles from TGenerator.
60
61 NOTE: FLUKA uses and external input file to define the materials and
62 to assign them to a given region (volume). Whenever you run AliRoot
63 with TFluka a temporary directory ('tmp') will be created with, among
64 others, a file call flukaMat.inp. The contents of this file should be
65 included into $ALICE_ROOT/TFluka/input/alice.inp just after the GEOEND
66 card. Then rerun AliRoot with TFluka, since only now the results can
67 be meaningful. Please be aware that NEON and SCANDIUM are not
68 supported for low energy neutrons and therefore special tricks might be
69 needed to run TFluka with them. Also PHOSPHOR should be renamed to
70 PHOSPHO. For this last two cases contact A. Fasso on how to solve the
71 problem.
72
73 LIST OF DEVELOPERS AND CONTRIBUTORS
74 ===================================
75 F. Carminati
76 A. Fasso
77 E. Futto
78 I. Gonzalez Caballero
79 I. Hrivnacova
80 A. Morsch