/
README
49 lines (31 loc) · 1.88 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
J-PET Analysis Framework
What is it ?
------------
J-PET Analysis Framewore is a flexible analysis framework which serves as a backbone system for the reconstruction algorithms and calibration procedures used during the data processing and standardize the common operations, e.g: input/output process, access to the detector geometry parameters and more.
It is written in C++ using the object-oriented approach. It is based on the ROOT libraries combined with some BOOST packages. The quality of the code is assured by the automatized set of unit tests. The documentation of the code is generated by Doxygen.
The Latest Version
------------------
The latest stable version can be downloaded from the git repository. You must have git client istalled and have rights to access the repository. If it is the case you can just:
git clone ssh://yourUser@koza.if.uj.edu.pl/srv/git/j-pet-framework.git myFramework
cd myFramework
If you have already a directory with the code and you want to update it, just write:
git pull
If you dont have the access to the repository server, please contact:wojciech.krzemien@if.uj.edu.pl
Documentation
-------------
The program documentation will be added along the framework development.
The code documentation can be generated with Doxygen package using:
$> make documentation
in the build directory (see the INSTALL file).
The index.html file will be available in the html/ directory located inside the build directory.
Installation
------------
Please see the file called INSTALL.
Authors
-------
J-Pet analysis framework is being developed by Wojciech Krzemien, Karol Stola, Damian Trybek, Aleksander Gajos, Andrzej Gruntowski, Szymon Niedźwiecki, Oleksandr Rundel and Tomasz Kisielewski.
Bug Reporting & Contact
-----------------------
If you have any question or comment please write to:
wojciech.krzemien@if.uj.edu.pl
or better post it to the Redmine list.