/GENIE-v3

GENIE Generator Package compatible with ANNIE containerization

Primary LanguageC++

Important Information Regarding ANNIE GENIE container

Before using this container, make note of the supplementary scripts located in the annie directory. In order to properly use this container please set up the environment: source annie/Setup_GENIE.sh

Before running the Generator, please make sure you have the following files:

Detector geometry file - annie_v04.gdml - not included in this container - please include in your working directory

Flux files - gsimple_beammc_annie_????.root - can be found on GPVM: /annie/data/flux/gsimple_bnb/ - a smaller subsection can be used from a separate local directory

Cross Section file - gxspl-FNALsmall.xml - can be found through LArSoft: /cvmfs/larsoft.opensciencegrid.org/products/genie_xsec/v3_00_04_ub2/NULL/G1810a0211a-k250-e1000/data/gxspl-FNALsmall.xml - this specific file is used as to allow for joint analysis with MicroBooNE

Wrapper script - run_annie_genie.sh - included in annie directory

How to run Generator

When the environment has been set up, and all necessary files are present/found by the wrapper, run the wrapper script, run_annie_genie.sh. Necessary arguments include:

-n [int] : number of events
-f [path to and including flux files]
-x [path to and including cross section file] : is set by $GENIEXSECFILE
-r [int] : run number
--seed [int] : seed
--topvol [TWATER_LV | WORLD_LV | BLDG_LV | EXP_HALL_LV] : event volume
--tune [string] : viable tune parameter for GENIE

Additional arguments can be found by running ./run_annie_genie.sh -h

Here is an example command (assuming local copies of annie_v04.gdml and gxspl-FNALsmall.xml): ./run_annie_genie.sh -r 0 -n 1000 -f /annie/data/flux/gsimple_bnb/gsimple_beammc_annie_00*.root -x gxspl-FNALsmall.xml --seed 42 --topvol TWATER_LV --tune G18_10a_02_11a

The GENIE Event Generator

The GENIE Generator product is an advanced physics simulation used by nearly all modern neutrino experiments and it plays a key role in the exploitation of neutrino data. This product implements a modern software framework for MC event generators and includes state-of-the-art physics modules for neutrino or charged-lepton interactions with nucleons or nuclei, and for the simulation of nucleon decay, n-bar oscillation and boosted dark matter. It captures the latest results of the GENIE global analysis of neutrino scattering data and includes several tunes that were produced using the proprietary Comparisons and Tuning products. The GENIE physics model is universal and comprehensive: It handles all neutrinos and targets, and all processes relevant from MeV to PeV energy scales. The Generator includes several tools (flux drivers, detector geometry navigation drivers, specialized event generation apps, event reweighting engines) to simulate complex experimental setups in full detail and to support generator-related analysis tasks.

For more information, visit http://www.genie-mc.org

                                                   .oooooo.    oooooooooooo ooooo      ooo ooooo oooooooooooo  
                                                  d8P'  `Y8b   `888'     `8 `888b.     `8' `888' `888'     `8  
                                                 888            888          8 `88b.    8   888   888           
                        Ndyooym          dN      888            888oooo8     8   `88b.  8   888   888oooo8     
                     Nds//+sdmoy       d+m       888     ooooo  888    "     8     `88b.8   888   888    "      
                   Nh+//ohN  m+s      N//syyN    `88.    .88'   888       o  8       `888   888   888       o  
                 Ny+//od   Nh+oN       o///+      `Y8bood8P'   o888ooooood8 o8o        `8  o888o o888ooooood8  
               Nh+//om   Nh+/yN       o///s                                                                    
              d+//+d   my+/smmyhN    m///h                                         MONTE CARLO EVENT GENERATOR    
            Ns///yN NdyoshNNs///d   h////yN                                                                    
           mo//om        ms///+m   d///////oyhmN                                                               
          N+//yN       ms////+N    h////////////oym                                                         
          s//h       ho/+///sN     N///////////////od                                                          
         N+/h     my++yh+//y       s/////////////////oN                                                        
         Ns/m Nmy++ymNh//+d        s//////////////////+m                                                       
          NhssoshN  Ny//sN         m///////////////////+                                                       
                  Nmo/+ohdmN        mo//////////////////h            NmmN                                      
              ms/+s//o/-----:+sdN     mhso+ooys/////////o      mhs+/------/ohN                                 
    Nhd     N+-/o+/o+------------/shN     Ndy+//////////+ mhs+:---------------om                               
  mo/sN    m:/oo/oo:-----------------:://////////////////-----------------------y                              
  y//d    Noo++o+:----------:------------:://///////////:-------:/+osyso/:-------h                             
  Nyo+syysooo+/--------------::--------------:://///////:----::////+ossyso/------:                             
     NNNNNs--------------------:/::-------------:://///:-:://////////oosyo+:------                             
          y---------------------:////:::-----------:////////////////+o++++/:-----/                             
          m-----------------------://////////////////////////////+so/--:---------y                             
           +------------------------://////////////////////////+yy:---+oh/--:y+-/N                             
           N/-------------------------://////////////////////ohy/-------yy--os-/m                              
            No--------------------------://///////////////+shs/---------/d++/-oN                               
              mo--------------------------:////////////+shyo:------------sy/sm                                 
                Ny+:------------------------::://///oyhyo:--------------/sd                                    
                    mhso+/:------------------:/+oyhyo/----------:/+syhm                                        
                           NmddhyyyssssyyyhdmmNNNmhhhyyyyhhddmN                                                

Authors

Luis Alvarez-Ruso [9], Costas Andreopoulos (*) [5,7], Adi Ashkenazi [4], Christopher Barry [5], Francis Bench [5], 
 Steve Dennis [5], Steve Dytman [6], Hugh Gallagher [8], Steven Gardiner[3], Walter Giele [3], Robert Hatcher [3], 
 Or Hen [4], Libo Jiang [6], Rhiannon Jones [5], Igor Kakorin [2], Konstantin Kuzmin [2], Anselmo Meregaglia [1], 
       Donna Naples [6], Vadim Naumov [2],  Afroditi Papadopoulou [4], Gabriel Perdue [3], Marco Roda [5], 
              Vladyslav Syrotenko [8], Julia Tena Vidal [5], Jeremy Wolcott [8], and Julia Yarba [3]

                                           (The GENIE Collaboration)

(1) CENBG, Université de Bordeaux, CNRS/IN2P3, 33175 Gradignan, France
(2) Joint Institute for Nuclear Research (JINR), Dubna, Moscow region, 141980, Russia
(3) Fermi National Accelerator Laboratory, Batavia, Illinois 60510, USA
(4) Massachusetts Institute of Technology, Dept. of Physics, Cambridge, MA 02139, USA
(5) University of Liverpool, Dept. of Physics, Liverpool L69 7ZE, UK 
(6) University of Pittsburgh, Dept. of Physics and Astronomy, Pittsburgh PA 15260, USA
(7) STFC Rutherford Appleton Laboratory, Particle Physics Dept., Oxfordshire OX11 0QX, UK
(8) Tufts University, Dept. of Physics and Astronomy, Medford MA 02155, USA
(9) University of Valencia, Valencia, Spain

--------------------
(*) Corresponding Author:

 Prof. Costas Andreopoulos < constantinos.andreopoulos \at cern.ch >
    
 University of Liverpool          |  U.K. Research & Innovation (UKRI)
 Faculty of Science & Engineering |  Science & Technology Facilities Council (STFC)
 School of Physical Sciences      |  Rutherford Appleton Laboratory 
 Department of Physics            |  Particle Physics Department
 Oliver Lodge Lab 316             |  Harwell Oxford Campus, R1 2.89
 Liverpool L69 7ZE, UK            |  Oxfordshire OX11 0QX, UK          
 tel: +44-(0)1517-943201          |  tel: +44-(0)1235-445091 

Copyright

Copyright (c) 2003-2019, The GENIE Collaboration. For information, visit http://copyright.genie-mc.org

Physics & User manual

For installation and usage information, as well as information on the GENIE framework, event generator modules and tuning, see the GENIE Physics & User Manual in the public section of the GENIE Document Database: https://genie-docdb.pp.rl.ac.uk/cgi-bin/ShowDocument?docid=2

Public releases and physics tunes

For a list of public releases and a summary information, see http://releases.genie-mc.org

For a list of model configurations and tunes supported in each release, see http://tunes.genie-mc.org

The naming conventions for releases, model configurations and tunes are outlined in the GENIE web page and in the Physics & User manual.

Contribution guidelines

GENIE welcomes community contributions through its Incubator. An Incubator Project is the unique route for any physics or software development into any of the GENIE suite products (Generator, Comparisons, Tuning). Details on the Incubator Project Phases (Launch, Research and Development, Graduation, Integration and Deployment) can be found in the GENIE Bylaws in the public section of the GENIE Document Database: https://genie-docdb.pp.rl.ac.uk/cgi-bin/ShowDocument?docid=1

Citing GENIE

If you use GENIE, please always cite the following reference:

@article{Andreopoulos:2009rq,
      author         = "Andreopoulos, C. and others",
      title          = "{The GENIE Neutrino Monte Carlo Generator}",
      journal        = "Nucl. Instrum. Meth.",
      volume         = "A614",
      year           = "2010",
      pages          = "87-104",
      doi            = "10.1016/j.nima.2009.12.009",
      eprint         = "0905.2517",
      archivePrefix  = "arXiv",
      primaryClass   = "hep-ph",
      reportNumber   = "FERMILAB-PUB-09-418-CD",
      SLACcitation   = "%%CITATION = ARXIV:0905.2517;%%"
}

If you used any of the new model configurations and tunes provided in the GENIE v3* series, please add the following reference:


Finally, if you used any of the standard GENIE applications, built-in flux and geometry drivers, or if you used any of its event reweightng and error propagation tools, please add the following reference:

@article{Andreopoulos:2015wxa,
      author         = "Andreopoulos, Costas and Barry, Christopher and Dytman,
                        Steve and Gallagher, Hugh and Golan, Tomasz and Hatcher,
                        Robert and Perdue, Gabriel and Yarba, Julia",
      title          = "{The GENIE Neutrino Monte Carlo Generator: Physics and
                        User Manual}",
      year           = "2015",
      eprint         = "1510.05494",
      archivePrefix  = "arXiv",
      primaryClass   = "hep-ph",
      reportNumber   = "FERMILAB-FN-1004-CD",
      SLACcitation   = "%%CITATION = ARXIV:1510.05494;%%"
}

Please notice that the GENIE authors endorse the MCNET guidelines for fair academic use which can be found in http://www.montecarlonet.org/GUIDELINES. We invite users to consider which GENIE components are important for a particular analysis and cite them, in addition to the main references. A list of such references in maintained in the official GENIE web page.