MuonGun¶
Documentation and examples for running muongun.py
The clsim.py
script has various options:
usage: muongun.py [-h] [--gcdfile GCDFILE] --outputfile OUTPUTFILE
[--summaryfile SUMMARYFILE] [--EnableHistogram]
[--HistogramFilename HISTOGRAMFILENAME]
[--procnum PROCNUM] [--seed SEED]
[--nevents NEVENTS] [--IceModelLocation ICEMODELLOCATION]
[--IceModel ICEMODEL]
[--holeiceparametrization HOLEICEPARAMETRIZATION]
[--oversize OVERSIZE] [--efficiency EFFICIENCY]
[--no-PropagateMuons] [--PhotonSeriesName PHOTONSERIESNAME]
[--GPU GPU] [--UseGPUs] [--model MODEL] [--gamma GAMMA]
[--offset OFFSET] [--emin EMIN] [--emax EMAX]
[--length LENGTH] [--radius RADIUS] [--x X] [--y Y] [--z Z]
[--length-dc LENGTH_DC] [--radius-dc RADIUS_DC]
[--x-dc X_DC] [--y-dc Y_DC] [--z-dc Z_DC] [--deepcore]
[--no-propagate-photons] [--natural-rate]
[--UseOnlyDeviceNumber USEONLYDEVICENUMBER]
[--RawPhotonSeriesName RAWPHOTONSERIESNAME]
[--no-KeepMCTree]
MuonGunGenerator script
optional arguments:
-h, --help show this help message and exit
--gcdfile GCDFILE GeoCalibDetStatus filename
--outputfile OUTPUTFILE
Output filename
--summaryfile SUMMARYFILE
JSON Summary filename
--EnableHistogram Write a SanityChecker histogram file.
--HistogramFilename HISTOGRAMFILENAME
Histogram filename.
--procnum PROCNUM job number (RNG stream number)
--seed SEED RNG seed
--nevents NEVENTS Number of events
--IceModelLocation ICEMODELLOCATION
Location of ice model param files
--IceModel ICEMODEL ice model subdirectory
--holeiceparametrization HOLEICEPARAMETRIZATION
Location of hole ice param files
--oversize OVERSIZE over-R: DOM radius oversize scaling factor
--efficiency EFFICIENCY
overall DOM efficiency correction
--no-PropagateMuons Don't run PROPOSAL to do in-ice propagation
--PhotonSeriesName PHOTONSERIESNAME
Photon Series Name
--GPU GPU Graphics Processing Unit number (shoud default to
environment if None)
--UseGPUs Use Graphics Processing Unit for photon propagation
--model MODEL primary cosmic-ray flux parametrization
--gamma GAMMA power law spectral index
--offset OFFSET power law offset in GeV
--emin EMIN mininum generated energy in GeV
--emax EMAX maximum generated energy in GeV
--length LENGTH cylinder length in m
--radius RADIUS cylinder radius in m
--x X cylinder x-position in m
--y Y cylinder y-position in m
--z Z cylinder z-position in m
--length-dc LENGTH_DC
inner cylinder length in m
--radius-dc RADIUS_DC
inner cylinder radius in m
--x-dc X_DC inner cylinder x-position in m
--y-dc Y_DC inner cylinder y-position in m
--z-dc Z_DC inner cylinder z-position in m
--deepcore use inner cylinder
--no-propagate-photons
Don't run ClSim.
--natural-rate Sample natural rate muon bundles
--UseOnlyDeviceNumber USEONLYDEVICENUMBER
Use only this device.
--RawPhotonSeriesName RAWPHOTONSERIESNAME
Raw Photon Series Name
--no-KeepMCTree Delete propagated MCTree