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 repository for visualizing output from the code and creating user-defined models.
Installation
with pip
python3 -m pip install nupyprop
with conda
We 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 nupyprop
Usage
nupyprop --help
Example for running tau propagation for 107 GeV neutrinos at 10 degrees with 107 neutrinos injected with stochastic energy loss & with all other parameters as defaults:
nupyprop -e 7 -a 10 -t stochastic -s 1e7
Run parameters are defined in run.py. Different switches are described as follows:
-e or --energy: incoming neutrino energy in log_10(GeV). Works for single energy or multiple energies. For multiple energies, separate energies with commas eg. 7,8,9,10,11. Default energies are 107,107.25,107.5,…1011 GeV.
-a or --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->35 degrees, in steps of 1 degree.
-i or --idepth: depth of ice/water in km. Default value is 4 km.
-l or --lepton: flavor of lepton used to propagate. Can be either muon or tau. Default is tau.
-n or --nu_type: type of neutrino matter. Can be either neutrino or anti-neutrino. Default is neutrino.
-t or --energy_loss: energy loss type for lepton - can be stochastic or continuous. Default is stochastic.
-x or --xc_model: neutrino/anti-neutrino cross-section model used. Can be from the pre-defined set of models (see xc-table) or custom. Default is ct18nlo.
-p or --pn_model: photonuclear interaction energy loss model used. Can be from the pre-defined set of models (see pn-table) or custom. Default is allm.
-f or --fac_nu: rescaling factor for BSM cross-sections. Default is 1.
-s or --stats: statistics or no. of injected neutrinos. Default is 1e7 neutrinos.
-c or --cdf_only: If set to yes, the output file will not contain outgoing lepton energies, and will only contain exit probabilities and binned outgoing energy CDF values. Default is no.
-htc or --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.
Viewing output results: output_*.h5 will contain the results of the code after it has finished running. In the terminal, run vitables (optional dependency) and open the output_*.h5 file to view the output results.
output_*.h5 naming convention is as follows: output_A_B_C_D_E_F_G, where
Model Tables
Neutrino/Anti-Neutrino Cross-Section Model
Reference
Abramowicz, Levin, Levy, Maor (ALLM)
Block, Durand, Ha, McKay (BDHM)
CTEQ18-NLO
Connolly, Thorne, Waters (CTW)
nCTEQ15
User Defined
Charged Lepton Photonuclear Energy Loss Model
Reference
Abramowicz, Levin, Levy, Maor (ALLM)
Bezrukov-Bugaev (BB)
Block, Durand, Ha, McKay (BDHM)
Capella, Kaidalov, Merino, Tran (CKMT)
User Defined
Code Execution Timing Tables
Charged Lepton
Energy Loss Type
E|nu| [GeV]
Angles
N|nu|;;in
Time (hrs)
τ
Stochastic
107
1-35
108
1.07*, 0.26***
τ
Continuous
107
1-35
108
0.88*
τ
Stochastic
108
1-35
108
6.18*, 1.53***
τ
Continuous
108
1-35
108
5.51*
τ
Stochastic
109
1-35
108
27.96*, 5.08***
τ
Continuous
109
1-35
108
19.11*
τ
Stochastic
1010
1-35
108
49.80*, 12.43***
τ
Continuous
1010
1-35
108
35.59*
τ
Stochastic
1011
1-35
108
12.73***
τ
Continuous
1011
1-35
108
Charged Lepton
Energy Loss Type
E|nu| [GeV]
Angles
N|nu|;;in
Time (hrs)
μ
Stochastic
106
1,2,3,5,7,10,12,15,17,20,25,30,35
108
μ
Continuous
106
1,2,3,5,7,10,12,15,17,20,25,30,35
108
0.95*
μ
Stochastic
107
1,2,3,5,7,10,12,15,17,20,25,30,35
108
μ
Continuous
107
1,2,3,5,7,10,12,15,17,20,25,30,35
108
3.19*
μ
Stochastic
108
1,2,3,5,7,10,12,15,17,20,25,30,35
108
μ
Continuous
108
1,2,3,5,7,10,12,15,17,20,25,30,35
108
5.17*
μ
Stochastic
109
1,2,3,5,7,10,12,15,17,20,25,30,35
108
111.77**
μ
Continuous
109
1,2,3,5,7,10,12,15,17,20,25,30,35
108
7.42*
μ
Stochastic
1010
1,2,3,5,7,10,12,15,17,20,25,30,35
108
98.17*
μ
Continuous
1010
1,2,3,5,7,10,12,15,17,20,25,30,35
108
9.76*
μ
Stochastic
1011
1,2,3,5,7,10,12,15,17,20,25,30,35
108
μ
Continuous
1011
1,2,3,5,7,10,12,15,17,20,25,30,35
108
* - 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 Ubuntu
These 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: sudo apt-get install gfortran
git clone the source code: git clone git@github.com:NuSpaceSim/nupyprop.git
cd nupyprop
build and install the package in ‘editable’ mode python3 -m pip install -e .
Developing the code on MacOS
These 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 MacOS which is out of date and missing critical functionality. Use the homebrew python instead, or a virtualenv, or a conda environment.
Install the non-pypi required dependencies as described for users above.
Install a fortran compiler. ex: brew install gcc
git clone the source code: git clone git@github.com:NuSpaceSim/nupyprop.git
cd nupyprop
build and install the package in ‘editable’ mode python3 -m pip install -e .
1 maintainer
Metadata
1 maintainer
Release files for nupyprop 0.1.7.post77
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| nupyprop-0.1.7.post77-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.9 | CPython 3.9 | Linux glibc 2.17+ x86-64 | Details |
| nupyprop-0.1.7.post77-cp39-cp39-macosx_10_9_x86_64.whl | CPython 3.9 | CPython 3.9 | macOS 10.9+ x86-64 | Details |
| nupyprop-0.1.7.post77-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.8 | CPython 3.8 | Linux glibc 2.17+ x86-64 | Details |
| nupyprop-0.1.7.post77-cp38-cp38-macosx_10_9_x86_64.whl | CPython 3.8 | CPython 3.8 | macOS 10.9+ x86-64 | Details |
| nupyprop-0.1.7.post77-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.7 | CPython 3.7 pymalloc | Linux glibc 2.17+ x86-64 | Details |
| nupyprop-0.1.7.post77-cp37-cp37m-macosx_10_9_x86_64.whl | CPython 3.7 | CPython 3.7 pymalloc | macOS 10.9+ x86-64 | Details |
Total release size: 29.8 MB
Release files / nupyprop-0.1.7.post77-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nupyprop-0.1.7.post77-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
9fd7f419aa2fd3d170e7cf4c08f1330415c3a86ee12e4c71cf35f2d380fa5607
|
|
BLAKE2b-256 checksum How to use checksums |
e290548f1bbffa6a3878a546c35b1bbea31bff1f98e1ab99f550e3fc499c0b10
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / nupyprop-0.1.7.post77-cp39-cp39-macosx_10_9_x86_64.whl
| Download URL | nupyprop-0.1.7.post77-cp39-cp39-macosx_10_9_x86_64.whl |
|---|---|
| Size | 5.0 MB |
| Tags | CPython 3.9 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
87e1802ebbad2ec97fcea5f14e4be75bd1b226e418b9d35c1eead7be1a667973
|
|
BLAKE2b-256 checksum How to use checksums |
b94dda8103f0d4592a5ddcb51aa91e5ae422d31e5b5598f3f0e8539236fe4b00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / nupyprop-0.1.7.post77-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nupyprop-0.1.7.post77-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.8 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
7579e174cb35934f46b8b39296576618058613153557b3bfa13ac968fa4570c8
|
|
BLAKE2b-256 checksum How to use checksums |
e14261af9c94c03838f15a4bee4f9cde843c0e45b9a79bfd64729fb14dbe23cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / nupyprop-0.1.7.post77-cp38-cp38-macosx_10_9_x86_64.whl
| Download URL | nupyprop-0.1.7.post77-cp38-cp38-macosx_10_9_x86_64.whl |
|---|---|
| Size | 5.0 MB |
| Tags | CPython 3.8 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
003eaa6de2dafed05cbead89f988614b840553b96007131df6d5cdbec8661002
|
|
BLAKE2b-256 checksum How to use checksums |
17543b87af6c86d14a828c8fd7ca17cec0420606d848b843d9b9d33c3aa13cea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / nupyprop-0.1.7.post77-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | nupyprop-0.1.7.post77-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
6afddf26b72d0ec2d11b2af5b0a932f4525836315f54865e47472443d76f560f
|
|
BLAKE2b-256 checksum How to use checksums |
536588d15d3b6bc43d34bae2a7eceee10dfc99d0ac8d2fcdd27cce318367fc25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / nupyprop-0.1.7.post77-cp37-cp37m-macosx_10_9_x86_64.whl
| Download URL | nupyprop-0.1.7.post77-cp37-cp37m-macosx_10_9_x86_64.whl |
|---|---|
| Size | 5.0 MB |
| Tags | CPython 3.7 CPython 3.7 pymalloc macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
504aa2af86364349cdc8b08e9b79a97c07654f137703d9ffaa643722790ea41f
|
|
BLAKE2b-256 checksum How to use checksums |
590352bcda0145371bb85ddbc4f5ed92a961c0f9c23ab7bf93d2833adb678deb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Security for nupyprop 0.1.7.post77
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
