add some comments to analyze-genie-mc

1 files changed, 16 insertions, 1 deletions

diff --git a/utils/analyze-genie-mc b/utils/analyze-genie-mc
index 7fdb948..92fdd92 100755
--- a/utils/analyze-genie-mc
+++ b/utils/analyze-genie-mc
@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 # Copyright (c) 2019, Anthony Latorre <tlatorre at uchicago>
 #
 # This program is free software: you can redistribute it and/or modify it
@@ -13,6 +13,21 @@
 #
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
+"""
+Very simple script to analyze GENIE MC to estimate the expected event rate from
+atmospheric neutrino events before and after different cuts. To run it simply
+pass the filename of a GENIE ntuple file:
+
+    $ ./analyze-genie-mc mc_atm_nu_genie_010000_0.gst.root
+
+Note: The input files should be in the GENIE "ntuple" format which you can
+create by using the gntpc utility. For example:
+
+    $ gntpc -i /sno/output/d2o-leta/mc_atmospherics/atmospheric_neutrinos_genie/root/mc_atm_nu_genie_010000_0.root -f gst
+
+will create a new file mc_atm_nu_genie_010000_0.gst.root in the current working
+directory in the ntuple file format.
+"""
 
 import ROOT
 import numpy as np