source/jana2/README.md

0001
0002
0003 ![Dependency matrix tests](https://github.com/JeffersonLab/JANA2/actions/workflows/test_dependency_matrix.yml/badge.svg)
0004
0005 <br>
0006
0007 ![ePIC integration tests](https://github.com/JeffersonLab/JANA2/actions/workflows/test_integration_epic.yml/badge.svg)
0008
0009 <br>
0010
0011 ![GlueX integration tests](https://github.com/JeffersonLab/JANA2/actions/workflows/test_integration_gluex.yml/badge.svg)
0012 <br>
0013
0014 [![DOI](https://zenodo.org/badge/117695469.svg)](https://zenodo.org/badge/latestdoi/117695469)
0015 ## Welcome to JANA!
0016
0017 JANA is a C++ framework for multi-threaded HENP (High Energy and Nuclear Physics) event reconstruction.
0018 Please see the [JANA website](https://jeffersonlab.github.io/JANA2/) for full documentation.
0019
0020 JANA2 is a complete rewrite retaining successful features from the original while modernizing the framework for a new generation of experiments. The code is under active development, but is ready for use as is. You are welcome to
0021 check it out and give feedback to help us improve it.
0022
0023 Just to whet your appetite a little, the code snippet below is the most common signature of JANA. A large fraction of end users won't really need to know much more than this.
0024
0025 ```c++
0026 auto tracks = jevent->Get<DTrack>();
0027
0028 for(auto t : tracks){
0029   // ... do something with a track
0030 }
0031 ```
0032
0033 To quickly download, build, install, and test on your system:
0034
0035 ```bash
0036 git clone https://github.com/JeffersonLab/JANA2
0037 cd JANA2
0038 mkdir build
0039 cmake -S . -B build -DCMAKE_INSTALL_PREFIX=`pwd`
0040 cmake --build build --target install -j 8
0041 bin/jana -Pplugins=JTest -Pjana:nevents=100
0042 ```
0043
0044 For a closer look, see our [tutorial](https://jeffersonlab.github.io/JANA2/#/tutorial).
0045
0046