README.md 3.35 KB
Newer Older
Riccardo Longo's avatar
Riccardo Longo committed
1
#### Joint Calorimeter Prototype Analysis --- JCaPA           
2
3
4
5
#### Created by Y.Kulinich, R.Longo and C.Lantz on 12/12/2018 ####                                                                                                    
                                                                                                                                                 
Basic structure defined and discussed during the Thursday meeting on 12/13/2018 

Riccardo Longo's avatar
Riccardo Longo committed
6
JCaPA   
Riccardo Longo's avatar
Riccardo Longo committed
7
     Analysis   
Riccardo Longo's avatar
Riccardo Longo committed
8
9
10
          include    
          src   
          userFunctions   
Riccardo Longo's avatar
Riccardo Longo committed
11
     MC (to be implemented)    
Riccardo Longo's avatar
Riccardo Longo committed
12
     2018_Utils (empty for the moment)    
13

Riccardo Longo's avatar
Riccardo Longo committed
14
15
16
17
18
The project is cmake based, so you need a reasonably new cmake version ( version > 2.8 )   
The standalone Analysis part requires only a root installation (https://root.cern.ch)   
The MC part will be conditional since it requires additional software as Geant4 and all its dependencies   
The corresponding README part will be written once MC will be included.    
The 2018_Utils folder will be meant to contain useful files for 2018 test beam analysis (e.g. Summary of various scans etc)   
19
20
21
22
23
24

#### CMake and installation ####
To install the software using cmake will be trivial. 
In the same folder where you have JCaPA, just do

mkdir JCaPA_BUILD
Riccardo Longo's avatar
Riccardo Longo committed
25

26
27
28
mkdir JCaPA_INSTALL 

at this stage, remember to add to your environment
Riccardo Longo's avatar
Riccardo Longo committed
29

30
31
32
export JCaPA=/path/to/your/JCaPA_INSTALL

cd JCaPA_BUILD
Riccardo Longo's avatar
Riccardo Longo committed
33

34
cmake -DCMAKE_INSTALL_PREFIX=../JCaPA_INSTALL/ ../JCaPA
Riccardo Longo's avatar
Riccardo Longo committed
35

36
make -j8 
Riccardo Longo's avatar
Riccardo Longo committed
37

38
39
40
41
42
43
44
45
46
47
48
make install 

please remember to re-make & make install every time you change the source code 

#### Analysis ####
Each user can implement his/her own analysis creating a new userFunction.cpp in Analysis/userFunctions folder. 
Please check AnalysisExample.cpp if you're looking for a basic template. 

Two main classes are provided at the moment: 
- DataReader 
- WFAnalysis (inherits from Analysis.h)
Riccardo Longo's avatar
Riccardo Longo committed
49
50
They are well commented by Yakov for each available method.   
A doxygen documentation can also be created following the instruction below.     
51

52
53
54
55
56
57
58
59
60
61
62
63
64
65
#### Monte Carlo ####
Monte Carlo folder added on 12/19/2018.    
What's there at the moment is exactly what has been done so far by Mike Phipps (michael.william.phipps@cern.ch). 
The only modifications implemented were to ensure the compatibility with newer Geant4 versions (>= 10.4.3).   
Such changes have been implemented in order to allow also for backward compatibility with older Geant4 versions. 

Please note that MonteCarlo support is *DISABLED* by default. This choice is meant to avoid people not interested in MC to install Geant4 and the other dependencies. 
In order to enable it, add the option 

-DJCaPA_ENABLE_MC=YES 

while cmaking. Please note that you need the Geant4 toolkit (and the corresponding dependencies) to successfully enable the MC support. 
More details will come in the future. 

66
#### Doxygen documentation ####
Riccardo Longo's avatar
Riccardo Longo committed
67
68
69
70
71
72
73
74
75
76
First, check that doxygen is installed on your machine.   
If it's not the case, just check it out using   
By default a folder "doxygen" will also be installed in your JCaPA_INSTALL folder.   
To obtain the documentation, just execute   

doxygen JCaPA_doxy.cnf   

This will generate for you  $JCaPA/html and $JCaPA/latex folder.  
If you start $JCaPA/html/index.html with your browser, you will get your doxygen docs (surfable).   
Alternatively, you can compile the latex static documentation in $JCaPA/latex 
77
78
79
80