source/EICrecon/README.md

0001 [![CI status](https://github.com/eic/EICrecon/actions/workflows/linux-eic-shell.yml/badge.svg)](https://github.com/eic/EICrecon/actions/workflows/linux-eic-shell.yml)
0002 [![DOI](https://zenodo.org/badge/512187504.svg)](https://zenodo.org/badge/latestdoi/512187504)
0003
0004 # EICrecon
0005 JANA based reconstruction for the ePIC detector
0006
0007 The repository contains reconstruction source code for the ePIC detector. Its function
0008 is to take real or simulated data and reconstruct it into physical values
0009 for later analysis.
0010
0011 - [Documentation website](https://eic.github.io/EICrecon/#/)
0012 - [Getting started instruction with eic-shell](https://eic.github.io/EICrecon/#/get-started/eic-shell)
0013
0014
0015 If you are new to EIC software then you should start with the tutorials which
0016 can be found here:
0017 [https://indico.bnl.gov/category/443/](https://indico.bnl.gov/category/443/)
0018
0019 A tutorial on JANA2 is available
0020 [here](https://eic.github.io/EICrecon/#/tutorial/01-introduction)
0021
0022 ### Compilation
0023
0024 To configure, build, and install (to the `install` directory), use the following commands:
0025 ```bash
0026 cmake -B build -S . -DCMAKE_INSTALL_PREFIX=install
0027 cmake --build build
0028 cmake --install build
0029 ```
0030 To change the default build type, add for example `-DCMAKE_BUILD_TYPE=Debug` to the first CMake configure step.
0031
0032 To load, you can use the scripts in the `install` directory:
0033 ```bash
0034 source install/bin/eicrecon-this.sh
0035 ```