# CeeRoot

**Repository Path**: CEESM/CeeRoot

## Basic Information

- **Project Name**: CeeRoot
- **Description**: CEERoot simulation and analysis package
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 15
- **Forks**: 37
- **Created**: 2019-05-07
- **Last Updated**: 2026-02-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CEEROOT

CEERoot is siumlation and data analysis code for CEE experiment.  
CEERoot is based on FairSoft and FairROOT. About FairSoft and FairROOT, please check following links out.

FairSoft: https://github.com/FairRootGroup/FairSoft

FairROOT: https://github.com/FairRootGroup/FairRoot

## Software Architecture

Software architecture description

## Installation

1. Install the dependencies of FairSoft 
* Install packages needed for RedHat-based OS (eg, CentOS, Scientific Linux):

sudo su 
yum install subversion git make cmake gcc-gfortran gcc-c++ binutils file patch redhat-lsb-core libX11-devel libXmu-devel libXpm-devel libXft-devel libXext-devel mesa-libGLU-devel libxml2-devel expat-devel zlib-devel postgresql-devel mysql-devel openssl-devel curl-devel automake libtool fftw3-devel

* Install packages needed for Debian-based OS (eg, Ubuntu):

sudo su apt-get install subversion git make cmake g++ gcc gfortran binutils patch lsb-release libx11-dev libxmu-dev libxpm-dev libxft-dev libxext-dev dpkg-dev xlibmesa-glu-dev libglew-dev libxml2-dev libexpat1-dev zlib1g-dev libpqxx-dev libmysqlclient-dev libssl-dev libcurl4-openssl-dev automake libtool fftw3-dev

2. Install FairSoft and FairROOT
* Install FairSoft "may18p1" version
* Install FairRoot "v18.0.6" version
* Run "autoinstall_framework.sh" script to install FairSoft and FairROOT 
--- HINT --- 
* Remove ROOT and Geant4 environment setting,  before the installation
------------ 

3. Install CeeRoot

*  git clone git@gitee.com:CEESM/CeeRoot.git
*  cd CeeRoot
*  mkdir build
*  cd build
*  cmake ..
*  make

4. Creat input geometry files
*  source build/config.sh
*  cd macro
*  source Create_allGeo.sh  
// After this step, you should see \*.root geometry files in "geometry" folder

5. Run a test example
*  cd macro
*  root -l run_sim.C  // you should see two files: "test.root" and "params.root"
*  quit root
*  root -l eventDisplay.C 
--- HINT ---  Keep following lines un-commented
** TString  InputFile     ="test.root";     
** TString  ParFile       ="params.root";    
------------

6. Instruction to use CEETPC Tracking tools

The CEETPC Tracker won't be compiled by default, therefore, if you want to use it, a detailed guideline for CEETPC tracking algorithm can be found at this [wiki page](https://gitee.com/CEESM/CeeRoot/wikis/The%20guideline%20for%20CEETPC_tracker).   


Additional Package to be installed before installing Tracking tools

(i) EIGEN  
This library makes heavy use of the excellent Eigen3 library for linear algebra operations and is thus a required dependency.  
https://eigen.tuxfamily.org/index.php?title=Main_Page

(ii) TrickTrack  
This is the Cellular automaton library.   
https://github.com/HSF/TrickTrack

(iii) GenFit  
This package is used for track fitting.  
https://github.com/GenFit/GenFit

For the user who are working on the CEE farm, follow the instruction below: 

```
export EIGEN3_INCLUDE_DIR=/PathToYourWorkarea/CeeRoot/ExtLib/eigen-3.4.0
go to /PathToYourWorkarea/CeeRoot/ExtLib/TrickTrack
sh build.sh    
export tricktrack_DIR=/PathToYourWorkarea/CeeRoot/ExtLib/TrickTrack/install/share/cmake/tricktrack
export genfit2_DIR=/PathToYourWorkarea/CeeRoot/GenFit-master/cmake
```

Open the CMakeLists.txt file in the CeeRoot directory, uncomment these two lines:

```
# find_package(tricktrack)
# add_subdirectory (CEETPC_Tracker)
```

To run the tracker package
<pre>```
cd CeeRoot
cd build
cmake ..
make 
source config.sh
cd ../macro
root -b run_Tracker_CA.C (for official geometry)
root -b run_Tracker_TB.C (for testbeam)
```</pre>

Those who are not using (or do not want to use) CEE-TPC tracker please do the following
modifications in CMakeLists.txt,

-- Comment   find_package(tricktrack)
-- comment   add_subdirectory (CEETPC_Tracker)