From de2f9c0d6b56413433178da5df758ccad297b810 Mon Sep 17 00:00:00 2001 From: Wudr-1995 <wudr@ihep.ac.cn> Date: Thu, 28 Sep 2023 11:00:17 +0800 Subject: [PATCH] update README --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 50ec59c..6a2ad91 100644 --- a/README.md +++ b/README.md @@ -8,37 +8,47 @@ Similar to JUNO Offline, two main structures exist: one is named **`algorithm`** ## How to use existing method ```bash -source setup.sh // in the spmtOffline folder +# The first time +git clone https://code.ihep.ac.cn/wudr/SPMTOfflineForCommissioning.git +cd SPMTOfflineForCommissioning +source setup.sh +./build.sh +``` + +```bash +# If the software was already compiled, only need to config the environment +source setup.sh # in the SPMTOfflineForCommissioning folder ``` ### Convert binary to ROOT ```bash -python $SHAREROOT/convert.py --input [path of binary file list] --output [output path] +python $SHAREROOT/convert.py --input [path of binary file list] --output [output path (folder only)] +# example: python $SHAREROOT/convert.py --input ./rootList --output ./ROOT/ ``` ### Get charge spectrum ```bash -python $SHAREROOT/getChargeSpec.py --input [path of ROOT file list] --output [output path] +python $SHAREROOT/getChargeSpec.py --input [path of ROOT file list] --output [output path (folder only)] ``` ### Get hit rate ```bash -python $SHAREROOT/getHitRate.py --input [path of ROOT file list] --output [output path] +python $SHAREROOT/getHitRate.py --input [path of ROOT file list] --output [output path (folder only)] ``` ### Get hit rate distribution in xoy ```bash -python $SHAREROOT/getHitRateDis.py --input [path of ROOT file list] --output [output path] +python $SHAREROOT/getHitRateDis.py --input [path of ROOT file list] --output [output path (folder only)] ``` ### Get time interval ```bash -python $SHAREROOT/getTimeInterval.py --input [path of ROOT file list] --output [output path] +python $SHAREROOT/getTimeInterval.py --input [path of ROOT file list] --output [output path (folder only)] ``` ### Get noise per channel ```bash -python $SHAREROOT/getNoise.py --input [path of ROOT file list] --output [output path] +python $SHAREROOT/getNoise.py --input [path of ROOT file list] --output [output path (folder only)] ``` ## Create your own algorithm -- GitLab