瀏覽代碼

Merge branch 'master' of git.fangmeier.tech:caleb/EGamma_ElectronTrackingValidation

Caleb Fangmeier 7 年之前
父節點
當前提交
b9076a1308
共有 1 個文件被更改,包括 22 次插入0 次删除
  1. 22 0
      README.md

+ 22 - 0
README.md

@@ -0,0 +1,22 @@
+# EGamma Electron Tracking Validation
+## How To Run
+Run the following commands to download, compile, and run the analysis routine.
+
+```bash
+# The recursive clone makes sure to also checkout the filval submodule.
+git clone --recursive gogs@git.fangmeier.tech:caleb/EGamma_ElectronTrackingValidation.git
+cd EGamma_ElectronTrackingValidation
+mkdir build
+cd build
+cmake ..
+make
+./tracking_validation -l LABEL -f PATH_TO_NTUPLE
+```
+
+Where `LABEL` is an arbitrary string used to keep track of, for example, what dataset is contained in the source Ntuple, and `PATH_TO_NTUPLE` is the path to the `trackingNtuple.root` file that you want to run over.
+
+If everything runs successfully, there will be a log file and new root file in the directory containing the source Ntuple. If there are errors, you can check the log file for hints to what happened. The new root file will be suffixed with "`_result`".
+
+
+## TODO:
+  - Enable specifying multiple root files to chain together.