Package: nupyprop
Propagate neutrinos through the earth.A python package and command line utility, including fortran for
performance with openMP.Documentation (WIP):https://nupyprop.readthedocs.io/en/latest/Note:While the documentation is currently WIP, users and developers should consult the
nuPyProp tutorial folder calledplotting_tutorialin the current repository, for visualizing output from the code and creating user-defined models.Citation:Please cite “Neutrino propagation in the Earth and emerging charged leptons with nuPyProp”, D. Garg, S.Patel et al. (NuSpaceSim Collaboration),e-Print: arXiv:2209.15581 [astro-ph.HE, hep-ph], submitted for publication in Journal of Cosmology and Astroparticle Physics.Acknowledgments:This work is supported by NASA grants 80NSSC19K0626 at the University of Maryland,Baltimore County, 80NSSC19K0460 at the Colorado School of Mines, 80NSSC19K0484 at theUniversity of Iowa, and 80NSSC19K0485 at the University of Utah, 80NSSC18K0464 at LehmanCollege, and under proposal 17-APRA17-0066 at NASA/GSFC and JPL.Installationwith pippython3 -m pip install nupypropwith condaWe recommend installing nupyprop into a conda environment like so. In
this example the name of the environment is “nupyprop”conda create -n nupyprop -c conda-forge -c nuspacesim nupyprop
conda activate nupypropUsagenupyprop--helpExamplefor running tau propagation for 107GeV neutrinos at 10
degrees with 107neutrinos injected with stochastic energy loss &
with all other parameters as defaults:nupyprop-e7-a10-tstochastic-s1e7Run parametersare defined in run.py. Different switches are
described as follows:-eor--energy: incoming neutrino energy in log_10(GeV). Works for
single energy or multiple energies. For multiple energies, separate
energies with commas eg. 6,7,8,9,10,11. Default energies are
106,106.25,106.5,…1011GeV.-aor--angle: slant Earth angles in degrees. Works for single angle
or multiple angles. For multiple angles, separate angles with commas
eg. 1,3,5,7,10. Default angles are 1->42 degrees, in steps of 1
degree.-ior--idepth: depth of ice/water in km. Default value is 4 km.-clor--charged_lepton: flavor of charged lepton used to propagate. Can be either
muon or tau. Default is tau.-nor--nu_type: type of neutrino matter. Can be either neutrino or
anti-neutrino. Default is neutrino.-tor--energy_loss: energy loss type for lepton - can be stochastic
or continuous. Default is stochastic.-xor--xc_model: neutrino/anti-neutrino cross-section model used.
Can be from the pre-defined set of models (seexc-table) or custom.
Default is ct18nlo.-por--pn_model: photonuclear interaction energy loss model used.
Can be from the pre-defined set of models (seepn-table) or custom.
Default is allm.-elor--energy_lepton: option to print exiting charged lepton’s final energy in
output file.
Default is no-for--fac_nu: rescaling factor for BSM cross-sections. Default is 1.-sor--stats: statistics or no. of injected neutrinos. Default is 1e7
neutrinos.-htcor--htc_mode: High throughput computing mode. If set to yes,
the code will be optimized to run in high throughput computing mode.
Default is no.Note: This program uses OpenMP for propagating the huge number of neutrinos injected.
For this purpose, the code will useallthe threads available in your processor by default.
To control the number of threads used for running the code, useexport OMP_NUM_THREADS=x,
wherexis the number of threads you want the code to run with.Viewing output results: output_*.h5 will contain the results of the
code after it has finished running. In the terminal, runvitables(optional dependency) and open the output_*.h5 file to view the output
results.output_*.h5 naming convention is as follows:output_A_B_Ckm_D_E_F_G,
whereA = Neutrino type: nu is for neutrino & anu is for anti-neutrino.B = Charged lepton type: tau is for tau leptons & muon is for muons.C = idepth: depth of water layer (in km).D = Neutrino (or anti-neutrino) cross-section model.E = Charged lepton photonuclear energy loss model.F = Energy loss type: can be stochastic or continuous.G = Statistics (ie. no. of neutrinos/anti-neutrinos injected).Model TablesNeutrino/Anti-Neutrino Cross-Section ModelReferenceAbramowicz, Levin, Levy, Maor (ALLM)hep-ph/9712415,Phys. Rev. D 96, 043003Block, Durand, Ha, McKay (BDHM)Phys. Rev. D 89, 094027,Phys. Rev. D 96, 043003CTEQ18-NLOPhys. Rev. D 103, 014013,Phys. Rev. D 81, 114012Connolly, Thorne, Waters (CTW)Phys. Rev. D 83, 113009nCTEQ15Phys. Rev. D 93, 085037,Phys. Rev. D 81, 114012User DefinedSeenuPyProp tutorial repositoryCharged Lepton Photonuclear Energy Loss ModelReferenceAbramowicz, Levin, Levy, Maor (ALLM)hep-ph/9712415,Phys. Rev. D 63, 094020Bezrukov-Bugaev (BB)Yad. Fiz. 33, 1195,Phys. Rev. D 63, 094020Block, Durand, Ha, McKay (BDHM)Phys. Rev. D 89, 094027,Phys. Rev. D 63, 094020Capella, Kaidalov, Merino, Tran (CKMT)Eur. Phys. J. C 10, 153Phys. Rev. D 63, 094020User DefinedSeenuPyProp tutorial repositoryCode Execution Timing TablesCharged LeptonEnergy Loss TypeE|nu|[GeV]AnglesN|nu|;;inTime (hrs)τStochastic1071-351081.07*, 0.26***τContinuous1071-351080.88*τStochastic1081-351086.18*, 1.53***τContinuous1081-351085.51*τStochastic1091-3510827.96*, 5.08***τContinuous1091-3510819.11*τStochastic10101-3510849.80*, 12.43***τContinuous10101-3510835.59*τStochastic10111-3510812.73***τContinuous10111-35108Charged LeptonEnergy Loss TypeE|nu|[GeV]AnglesN|nu|;;inTime (hrs)μStochastic1061,2,3,5,7,10,12,15,17,20,25,30,35108μContinuous1061,2,3,5,7,10,12,15,17,20,25,30,351080.95*μStochastic1071,2,3,5,7,10,12,15,17,20,25,30,35108μContinuous1071,2,3,5,7,10,12,15,17,20,25,30,351083.19*μStochastic1081,2,3,5,7,10,12,15,17,20,25,30,35108μContinuous1081,2,3,5,7,10,12,15,17,20,25,30,351085.17*μStochastic1091,2,3,5,7,10,12,15,17,20,25,30,35108111.77**μContinuous1091,2,3,5,7,10,12,15,17,20,25,30,351087.42*μStochastic10101,2,3,5,7,10,12,15,17,20,25,30,3510898.17*μContinuous10101,2,3,5,7,10,12,15,17,20,25,30,351089.76*μStochastic10111,2,3,5,7,10,12,15,17,20,25,30,35108μContinuous10111,2,3,5,7,10,12,15,17,20,25,30,35108* - Intel Core i7-8750H; 6 cores & 12 threads. ** - Intel Core
i5-10210; 4 cores & 8 threads. *** - UIowa Argon cluster; 56 cores.For debugging/development:The correct order to look at the code is
in the following order:data.py: contains functions for reading/writing from/to hdf5 files.geometry.py: contains the Earth geometry modules (including
PREM) for use with python/fortran.models.py: contains neutrino cross-section & charged lepton energy loss model templates.propagate.f90: heart of the code; contains fortran modules to
interpolate between geometry variables, cross-sections, energy loss
parameters & propagate neutrinos and charged leptons through the Earth.main.py: forms the main skeleton of the code; propagates the
neutrinos and charged leptons, and calculates the p_exit and collects
outgoing lepton energies.run.py: contains all the run parameters and variables needed for
all the other .py files.Developing the code on UbuntuThese notes should help developers of this code build and install the
package locally using a pep518 compliant build system (pip).Install the non-pypi required dependencies as described for users
above.Install a fortran compiler. ex:sudoapt-getinstall gfortrangit clone the source code:git clone git@github.com:NuSpaceSim/nupyprop.gitcd nupypropbuild and install the package in ‘editable’ modepython3-mpip install-e.Developing the code on MacOSThese notes should help developers of this code build and install the
package locally using a pep518 compliant build system (pip).Currently
we do not support the default system python3 on MacOSwhich is out of
date and missing critical functionality. Use the homebrew python
instead, or avirtualenv, or a conda environment.Install the non-pypi required dependencies as described for users
above.Install a fortran compiler. ex:brew install gccgit clone the source code:git clone git@github.com:NuSpaceSim/nupyprop.gitcd nupypropbuild and install the package in ‘editable’ modepython3-mpip install-e.