J-PET Analysis Framework
C++ CMake C Shell Perl Python Objective-C
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Core Merge branch 'develop' into master Dec 22, 2017
DataObjects Change JPetEvent::getHits to return a reference Apr 9, 2018
Options Fix tests Nov 20, 2017
ParamObjects Change ../ to ./ in includes Nov 19, 2017
ParametersTools nullpointers in Manager header Dec 21, 2017
Tasks Merge branch 'develop' into master Dec 22, 2017
Unpacker2 @ dc3344d Switch back to the most recent submodule Unpacker2 version Sep 4, 2017
cmake Change generate_root_dictionaries to take include_dirs as parameter Nov 19, 2017
extras Git hooks for automatic prettyfying of code Oct 11, 2016
hooks Git hooks for automatic prettyfying of code Oct 11, 2016
manual Second stage of rebasing cmake-separate onto develop. Jan 13, 2016
unitTestUtils Delete unused code Nov 20, 2017
.gitignore Update .gitignore to do not ignore PetDict.h Nov 19, 2017
.gitmodules Change Unpacker2 submodule path to official JPET repo Dec 12, 2016
.travis.yml remove DB credentials handling from Travis Nov 20, 2017
CMakeLists.txt - removing useless comments in CMakeLists.txt Dec 12, 2017
Doxyfile.in Add the 'documentation' target to CMakeLists. Update README and INSTA… Feb 8, 2016
INSTALL - remove libpqxx dependency; remove DBHandler; no getting params from… Dec 10, 2017
LICENSE Add licensing information Feb 2, 2016
NOTICE Update author list. Update year in notice. Nov 18, 2017
README Update author list. Update year in notice. Nov 18, 2017
download_data.sh make wget less verbose Nov 20, 2017
linkdef.h Second stage of rebasing cmake-separate onto develop. Jan 13, 2016
logo.png Second stage of rebasing cmake-separate onto develop. Jan 13, 2016
version.h.in Update copyright header Sep 18, 2017

README

     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 github repository. You must have git client istalled and do:

git clone --recursive https://github.com/JPETTomography/j-pet-framework.git myFramework

Documentation
-------------

The program documentation is being 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, Aleksander Gajos, Kamil Rakoczy, Szymon Niedźwiecki and Krzysztof Kacprzak.
The former developers are Karol Stola, Damian Trybek, Andrzej Gruntowski, Klara Muzalewska, Oleksandr Rundel and Tomasz Kisielewski.

Citation:
---------

In case you want to refer to J-PET Analysis Framework you can use this reference:
W. Krzemien et al.
Analysis framework for the J-PET scanner 
Acta Phys.Polon. A127 (2015) 1491-1494
DOI: 10.12693/APhysPolA.127.1491
e-Print: arXiv:1503.00465

Bug Reporting & Contact
-----------------------

If you have any question or comment please write to: 
wojciech.krzemien@ncbj.gov.pl
or better post it to the Redmine list.