README.md 2.2 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
8
9
10
11
12
     Analysis   
        include    
        src   
        userFunctions   
     MC (to be implemented)    
     2018_Utils (to be added)    
13
14

The project is cmake based, so you need a reasonably new cmake version ( version > 2.8 )
Riccardo Longo's avatar
Riccardo Longo committed
15

16
The standalone Analysis part requires only a root installation (https://root.cern.ch)
Riccardo Longo's avatar
Riccardo Longo committed
17

18
The MC part will be conditional since it requires additional software as Geant4 and all its dependencies
Riccardo Longo's avatar
Riccardo Longo committed
19

20
The corresponding README part will be written once MC will be included. 
Riccardo Longo's avatar
Riccardo Longo committed
21

22
23
24
25
26
27
28
The 2018_Utils folder will be meant to contain useful files for 2018 test beam analysis (e.g. Summary of various scans etc)

#### 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
29

30
31
32
mkdir JCaPA_INSTALL 

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

34
35
36
export JCaPA=/path/to/your/JCaPA_INSTALL

cd JCaPA_BUILD
Riccardo Longo's avatar
Riccardo Longo committed
37

38
cmake -DCMAKE_INSTALL_PREFIX=../JCaPA_INSTALL/ ../JCaPA
Riccardo Longo's avatar
Riccardo Longo committed
39

40
make -j8 
Riccardo Longo's avatar
Riccardo Longo committed
41

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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)
They are well commented by Yakov for each available method. 
A doxygen documentation can also be created following the instruction below 

#### Doxygen documentation ####
Riccardo Longo's avatar
Riccardo Longo committed
57
58
59
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. 
60
61
62
63