Changes between Initial Version and Version 1 of HowToUseNUISCOMP-GENIE

Timestamp:

Jun 12, 2017, 5:46:17 PM (7 years ago)

Author:

Patrick Stowell

Comment:

--

HowToUseNUISCOMP-GENIE

@@ +1 @@
+= NUISCOMP =
+
+The NUISANCE comparison application can be used to generate MC predictions that can be directly compared with published scatter data by automatically selecting the correct event topologies from a provided event sample and binning them to match the data.
+
+[[PageOutline(1-3,Wiki content,inline,numbered)]]
+
+== Running NUISCOMP == 
+
+{{{
+#!div class="important" 
+'''Author:''' Patrick Stowell
+
+'''Date:''' June 2017
+
+'''Versions:''' `NUISANCE v2r0`, `GENIE 2.12.6`
+}}}
+
+The following example details how to run NUISANCE and produce MiniBooNE pion production comparisons to a generator of choice. Each generator requires very slightly different ways to handle NUISANCE, therefore multiple versions of this tutorial have been provided. Please use the following links to choose what generator you would like to use.
+
+- [wiki:HowToUseNUISCOMP-GENIE I want to use GENIE]
+- [wiki:HowToUseNUISCOMP-NuWro I want to use NuWro]
+- [wiki:HowToUseNUISCOMP-NEUT I want to use NEUT]
+
+
+== Generating GENIE Events ==
+If we want to see how a given GENIE model behaves, first we need to generate events. This can be done using the standard gevgen application, using the appropriate target and flux for a given data sample. 
+
+If all you want to do is check your NUSIANCE is built correctly, you can skip this step by downloading MC files from our online storage area by following the steps found here:LinkToNUISANCEMCFiles
+
+== Running gevgen ==
+
+The standard gevgen application options can be ran using
+{{{
+ $ gevgen -f  -n -e 
+}}}
+
+We need to provide a flux and target list to GENIE when running gevgen. To see our list of compiled flux and target combinations for each sample please see here:
+
+Note: If building NUISANCE v2r0 or higher against GENIE 2-12-0 or higher an option is provided to use an easier and quicker gevgen_nuisance application to generate NUISANCE-ready event files. Please see section 2.3 if you would like to use this.
+
+We want to run comparisons to MiniBooNE muon-neutrino scattering data on a mineral oil target, therefore to generate events we can run
+{{{
+ $ gevgen -f  MiniBooNE -t CH 
+}}}
+
+Once our events have been generated we can check that they have finished correctly by opening the output event file has a ‘gtree’ object and the flux spectrum file contains the correct histogram.
+
+
+{{{
+$ root gntp.2063030.ghep.root
+root [0]
+Attaching file gntp.2063030.ghep.root as _file0...
+Warning in <TClass::TClass>: no dictionary for class genie::NtpMCEventRecord is available
+Warning in <TClass::TClass>: no dictionary for class genie::NtpMCRecordI is available
+Warning in <TClass::TClass>: no dictionary for class genie::NtpMCRecHeader is available
+Warning in <TClass::TClass>: no dictionary for class genie::EventRecord is available
+Warning in <TClass::TClass>: no dictionary for class genie::GHepRecord is available
+Warning in <TClass::TClass>: no dictionary for class genie::Interaction is available
+Warning in <TClass::TClass>: no dictionary for class genie::InitialState is available
+Warning in <TClass::TClass>: no dictionary for class genie::Target is available
+Warning in <TClass::TClass>: no dictionary for class genie::ProcessInfo is available
+Warning in <TClass::TClass>: no dictionary for class genie::Kinematics is available
+Warning in <TClass::TClass>: no dictionary for class genie::XclsTag is available
+Warning in <TClass::TClass>: no dictionary for class genie::KPhaseSpace is available
+Warning in <TClass::TClass>: no dictionary for class genie::GHepParticle is available
+Warning in <TClass::TClass>: no dictionary for class pair<genie::EKineVar,double> is available
+root [1] _file0->ls();
+TFile**         gntp.2063030.ghep.root
+ TFile*         gntp.2063030.ghep.root
+  KEY: genie::NtpMCTreeHeader   header;1        GENIE output tree header
+  KEY: TFolder  gconfig;1       GENIE configs
+  KEY: TFolder  genv;1  GENIE user environment
+  KEY: TTree    gtree;1 GENIE MC Truth TTree, Format: [NtpMCEventRecord]
+}}}
+
+{{{
+$ root input-flux.root
+root [0]
+Attaching file input-flux.root as _file0...
+root [1] _file0->ls();
+TFile**         input-flux.root
+ TFile*         input-flux.root
+  KEY: TH1D     spectrum;1      neutrino_flux
+}}}
+
+Now that the event samples have been generated correctly, we need to prepare them for use in NUISANCE.
+
+== Running PrepareGENIE ==
+
+The standard gevgen application doesn’t save the total event rate predictions into the event file itself. NUISANCE needs these to correctly normalise predictions so before we can use these new events we need to prepare them.
+
+The PrepareGENIE application is built when NUISANCE is built with GENIE support should be available after the NUISANCE environmental setup script is ran. 
+
+{{{
+$ PrepareGENIE -h
+PrepareGENIEEvents NUISANCE app.
+Takes GHep Outputs and prepares events for NUISANCE.
+
+PrepareGENIEEvents  [-h,-help,--h,--help] [-i inputfile1.root,inputfile2.root,inputfile3.root,...] [-f flux_root_file.root,flux_hist_name] [-t target1[frac1],target2[frac2],...]
+
+Prepare Mode [Default] : Takes a single GHep file, reconstructs the original GENIE splines,  and creates a duplicate file that also contains the flux, event rate, and xsec predictions that NUISANCE needs.
+Following options are required for Prepare Mode:
+ [ -i inputfile.root  ] : Reads in a single GHep input file that needs the xsec calculation ran on it.
+ [ -f flux_file.root,hist_name ] : Path to root file containing the flux histogram the GHep records were generated with. A simple method is to point this to the flux histogram genie generatrs '-f /path/to/events/input-flux.root,spectrum'.
+ [ -t target ] : Target that GHepRecords were generated with. Comma seperated list. E.g. for CH2 target=1000060120,1000010010,1000010010
+}}}
+
+The PrepareGENIE application, when ran, loops over all the events, extracts the cross-section as a function of energy for each discrete interaction mode and uses this information to reconstruct the cross-section splines for each target that were used to generate events.
+
+These splines are then multiplied by specified flux and added according to the target definition provided to produce total flux and event rate predictions as a function of energy for the sample and saves them into the events file.
+
+We want to prepare our MiniBooNE events so we pass in the event files, the input flux, and the CH2 target definition.
+
+{{{
+ $ PrepareGENIE -i gntp.2063030.ghep.root -f input-flux.root,spectrum -t  1000060120,1000010010,1000010010  
+}}}
+
+Now when we open our event file again, we should see the flux and event rate histograms are now saved into the file ready for NUISANCE to read them.
+
+{{{
+  KEY: genie::NtpMCTreeHeader   header;1        GENIE output tree header
+  KEY: TFolder  gconfig;1       GENIE configs
+  KEY: TFolder  genv;1  GENIE user environment
+  KEY: TTree    gtree;1 GENIE MC Truth TTree, Format: [NtpMCEventRecord]
+  KEY: TDirectoryFile   IndividualGENIESplines;1        IndividualGENIESplines
+  KEY: TDirectoryFile   TargetGENIESplines;1    TargetGENIESplines
+  KEY: TH1F     nuisance_xsec;1
+  KEY: TH1F     nuisance_events;1
+  KEY: TH1F     nuisance_flux;1
+}}}
+
+== Running gevgen_nuisance (optional) ==
+
+Other than the standard gevgen application, if built against GENIE events later than GENIE 2.12.0, NUISANCE can also provide a gevgen_nuisance app, with additional features to support the creation of ‘NUISANCE-ready’ events.
+
+To build gevgen_nuisance, you will need to build with the option ‘-DBUILD_GEVGEN=ON’ during the cmake configure statement as shown in the build notes here:
+
+{{{
+ $ cmake ../ -DUSE_GENIE=1 -DBUILD_GEVGEN=1 
+}}}
+
+The gevgen_nuisance can be ran in a similar way to the normal gevgen application but flux inputs and target definitions can be provided in simpler formats
+
+In our example we want to generate events for a MiniBooNE muon neutrino flux on a CH2 target. Therefore we run
+
+{{{
+ $ gevgen_nuisance -n 250000 -f MiniBooNE_fhc_numu -t CH2  
+}}}
+
+We should then open the output event file to check it constrains the GENIE event tree ‘gtree’ object and the flux and event rate predictions.
+
+Notice that we no longer need to run PrepareGENIE on gevgen_nuisance events before using them nuisance. 
+
+gevgen_nuisance also provides extra support for mixed target and flux specifications. For further notes on these see: 
+
+== Setting up a GENIE Comparison ==
+
+Now that we have an event sample we can load them load them into NUISANCE by specifying them at run time. To do that we need to write a NUISANCE card file that lists all comparisons that should be made and the event files that should be used for each one.
+
+We want to produce comparisons to MiniBooNE pion production data, so first we should search the NUISANCE sample list.
+
+The ‘nuissamples’ script is provided for easy access of the sample list. Running it without any arguments will return a full sample list of available data comparisons. Providing an additional argument will return only samples containing the provided substring.
+
+We can list the MIniBooNE samples using
+{{{
+ [stowell@hepgw1 ~]$ nuissamples MiniBooNE
+MiniBooNE_CCQE_XSec_1DQ2_nu
+MiniBooNE_CCQELike_XSec_1DQ2_nu
+MiniBooNE_CCQE_XSec_1DQ2_antinu
+MiniBooNE_CCQELike_XSec_1DQ2_antinu
+MiniBooNE_CCQE_CTarg_XSec_1DQ2_antinu
+MiniBooNE_CCQE_XSec_2DTcos_nu
+MiniBooNE_CCQELike_XSec_2DTcos_nu
+MiniBooNE_CCQE_XSec_2DTcos_antinu
+MiniBooNE_CCQELike_XSec_2DTcos_antinu
+MiniBooNE_CC1pip_XSec_1DEnu_nu
+MiniBooNE_CC1pip_XSec_1DQ2_nu
+MiniBooNE_CC1pip_XSec_1DTpi_nu
+MiniBooNE_CC1pip_XSec_1DTu_nu
+MiniBooNE_CC1pip_XSec_2DQ2Enu_nu
+MiniBooNE_CC1pip_XSec_2DTpiCospi_nu
+MiniBooNE_CC1pip_XSec_2DTpiEnu_nu
+MiniBooNE_CC1pip_XSec_2DTuCosmu_nu
+MiniBooNE_CC1pip_XSec_2DTuEnu_nu
+MiniBooNE_CC1pi0_XSec_1DEnu_nu
+MiniBooNE_CC1pi0_XSec_1DQ2_nu
+MiniBooNE_CC1pi0_XSec_1DTu_nu
+MiniBooNE_CC1pi0_XSec_1Dcosmu_nu
+MiniBooNE_CC1pi0_XSec_1Dcospi0_nu
+MiniBooNE_CC1pi0_XSec_1Dppi0_nu
+MiniBooNE_NC1pi0_XSec_1Dcospi0_antinu
+MiniBooNE_NC1pi0_XSec_1Dcospi0_rhc
+MiniBooNE_NC1pi0_XSec_1Dcospi0_nu
+MiniBooNE_NC1pi0_XSec_1Dcospi0_fhc
+MiniBooNE_NC1pi0_XSec_1Dppi0_antinu
+MiniBooNE_NC1pi0_XSec_1Dppi0_rhc
+MiniBooNE_NC1pi0_XSec_1Dppi0_nu
+MiniBooNE_NC1pi0_XSec_1Dppi0_fhc
+MiniBooNE_NCEL_XSec_Treco_nu
+}}}
+
+We only care about CC1pip data therefore the following samples are of interest
+{{{
+[stowell@hepgw1 ~]$ nuissamples MiniBooNE_CC1pip
+MiniBooNE_CC1pip_XSec_1DEnu_nu
+MiniBooNE_CC1pip_XSec_1DQ2_nu
+MiniBooNE_CC1pip_XSec_1DTpi_nu
+MiniBooNE_CC1pip_XSec_1DTu_nu
+MiniBooNE_CC1pip_XSec_2DQ2Enu_nu
+MiniBooNE_CC1pip_XSec_2DTpiCospi_nu
+MiniBooNE_CC1pip_XSec_2DTpiEnu_nu
+MiniBooNE_CC1pip_XSec_2DTuCosmu_nu
+MiniBooNE_CC1pip_XSec_2DTuEnu_nu
+}}}
+
+In this example we will compare to the 1Dtpi and 1DTu distributions, but we could provide any number of the samples seen in the lists.
+
+We write our card file with these two datasets using the following sample object format:
+{{{
+sample NAME_OF_SAMPLE  INPUT_TYPE:FILE_INPUT    
+}}}
+
+So for our genie files generated in step 2.1, our card file would be :
+
+**genie_tutorial.card**
+{{{
+sample MiniBooNE_CC1pip_XSec_1DTpi_nu  GENIE: gntp.2063030.ghep.root
+sample MiniBooNE_CC1pip_XSec_1DTu_nu GENIE: gntp.2063030.ghep.root  
+}}}
+
+We can now run our cardfile using the standard nuisance application like so:
+{{{
+$ nuiscomp -c genie_tutorial.card  -o genie_samples.root
+}}}
+
+This will produce a lot of logging output , but eventually, if there are no errors, it should finish with:
+{{{
+[LOG Fitter]: Saving current full FCN predictions
+[LOG Minmzr]:- Writing each of the data classes...
+[LOG Sample]:-- Written Histograms: MiniBooNE_CC1pip_XSec_1DTpi_nu
+[LOG Sample]:-- Written Histograms: MiniBooNE_CC1pip_XSec_1DTu_nu
+[LOG Fitter]: ------------------------------------ -
+[LOG Fitter]: Comparison Complete.
+[LOG Fitter]: ------------------------------------ -
+}}}
+
+To check that the comparison definitely finished successfully, lets open the root file and check the file is not empty.
+{{{
+$ root genie_allsamples.root
+Attaching file genie_allsamples.root as _file0...
+root [0] TBrowser b
+}}}
+
+
+
+If you see something similar to this then the comparisons should have ran successfully.
+