Metadata-Version: 2.4
Name: nuVeto
Version: 3.0.0
Summary: Package implements the formalism for calculating passing fraction as discussed in JCAP07(2018)047.
Maintainer-email: Tianlu Yuan <tyuan@icecube.wisc.edu>
License: GNU LESSER GENERAL PUBLIC LICENSE
                               Version 3, 29 June 2007
        
         Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
         Everyone is permitted to copy and distribute verbatim copies
         of this license document, but changing it is not allowed.
        
        
          This version of the GNU Lesser General Public License incorporates
        the terms and conditions of version 3 of the GNU General Public
        License, supplemented by the additional permissions listed below.
        
          0. Additional Definitions.
        
          As used herein, "this License" refers to version 3 of the GNU Lesser
        General Public License, and the "GNU GPL" refers to version 3 of the GNU
        General Public License.
        
          "The Library" refers to a covered work governed by this License,
        other than an Application or a Combined Work as defined below.
        
          An "Application" is any work that makes use of an interface provided
        by the Library, but which is not otherwise based on the Library.
        Defining a subclass of a class defined by the Library is deemed a mode
        of using an interface provided by the Library.
        
          A "Combined Work" is a work produced by combining or linking an
        Application with the Library.  The particular version of the Library
        with which the Combined Work was made is also called the "Linked
        Version".
        
          The "Minimal Corresponding Source" for a Combined Work means the
        Corresponding Source for the Combined Work, excluding any source code
        for portions of the Combined Work that, considered in isolation, are
        based on the Application, and not on the Linked Version.
        
          The "Corresponding Application Code" for a Combined Work means the
        object code and/or source code for the Application, including any data
        and utility programs needed for reproducing the Combined Work from the
        Application, but excluding the System Libraries of the Combined Work.
        
          1. Exception to Section 3 of the GNU GPL.
        
          You may convey a covered work under sections 3 and 4 of this License
        without being bound by section 3 of the GNU GPL.
        
          2. Conveying Modified Versions.
        
          If you modify a copy of the Library, and, in your modifications, a
        facility refers to a function or data to be supplied by an Application
        that uses the facility (other than as an argument passed when the
        facility is invoked), then you may convey a copy of the modified
        version:
        
           a) under this License, provided that you make a good faith effort to
           ensure that, in the event an Application does not supply the
           function or data, the facility still operates, and performs
           whatever part of its purpose remains meaningful, or
        
           b) under the GNU GPL, with none of the additional permissions of
           this License applicable to that copy.
        
          3. Object Code Incorporating Material from Library Header Files.
        
          The object code form of an Application may incorporate material from
        a header file that is part of the Library.  You may convey such object
        code under terms of your choice, provided that, if the incorporated
        material is not limited to numerical parameters, data structure
        layouts and accessors, or small macros, inline functions and templates
        (ten or fewer lines in length), you do both of the following:
        
           a) Give prominent notice with each copy of the object code that the
           Library is used in it and that the Library and its use are
           covered by this License.
        
           b) Accompany the object code with a copy of the GNU GPL and this license
           document.
        
          4. Combined Works.
        
          You may convey a Combined Work under terms of your choice that,
        taken together, effectively do not restrict modification of the
        portions of the Library contained in the Combined Work and reverse
        engineering for debugging such modifications, if you also do each of
        the following:
        
           a) Give prominent notice with each copy of the Combined Work that
           the Library is used in it and that the Library and its use are
           covered by this License.
        
           b) Accompany the Combined Work with a copy of the GNU GPL and this license
           document.
        
           c) For a Combined Work that displays copyright notices during
           execution, include the copyright notice for the Library among
           these notices, as well as a reference directing the user to the
           copies of the GNU GPL and this license document.
        
           d) Do one of the following:
        
               0) Convey the Minimal Corresponding Source under the terms of this
               License, and the Corresponding Application Code in a form
               suitable for, and under terms that permit, the user to
               recombine or relink the Application with a modified version of
               the Linked Version to produce a modified Combined Work, in the
               manner specified by section 6 of the GNU GPL for conveying
               Corresponding Source.
        
               1) Use a suitable shared library mechanism for linking with the
               Library.  A suitable mechanism is one that (a) uses at run time
               a copy of the Library already present on the user's computer
               system, and (b) will operate properly with a modified version
               of the Library that is interface-compatible with the Linked
               Version.
        
           e) Provide Installation Information, but only if you would otherwise
           be required to provide such information under section 6 of the
           GNU GPL, and only to the extent that such information is
           necessary to install and execute a modified version of the
           Combined Work produced by recombining or relinking the
           Application with a modified version of the Linked Version. (If
           you use option 4d0, the Installation Information must accompany
           the Minimal Corresponding Source and Corresponding Application
           Code. If you use option 4d1, you must provide the Installation
           Information in the manner specified by section 6 of the GNU GPL
           for conveying Corresponding Source.)
        
          5. Combined Libraries.
        
          You may place library facilities that are a work based on the
        Library side by side in a single library together with other library
        facilities that are not Applications and are not covered by this
        License, and convey such a combined library under terms of your
        choice, if you do both of the following:
        
           a) Accompany the combined library with a copy of the same work based
           on the Library, uncombined with any other library facilities,
           conveyed under the terms of this License.
        
           b) Give prominent notice with the combined library that part of it
           is a work based on the Library, and explaining where to find the
           accompanying uncombined form of the same work.
        
          6. Revised Versions of the GNU Lesser General Public License.
        
          The Free Software Foundation may publish revised and/or new versions
        of the GNU Lesser General Public License from time to time. Such new
        versions will be similar in spirit to the present version, but may
        differ in detail to address new problems or concerns.
        
          Each version is given a distinguishing version number. If the
        Library as you received it specifies that a certain numbered version
        of the GNU Lesser General Public License "or any later version"
        applies to it, you have the option of following the terms and
        conditions either of that published version or of any later version
        published by the Free Software Foundation. If the Library as you
        received it does not specify a version number of the GNU Lesser
        General Public License, you may choose any version of the GNU Lesser
        General Public License ever published by the Free Software Foundation.
        
          If the Library as you received it specifies that a proxy can decide
        whether future versions of the GNU Lesser General Public License shall
        apply, that proxy's public statement of acceptance of any version is
        permanent authorization for you to choose that version for the
        Library.
        
Project-URL: Repository, https://github.com/tianluyuan/nuVeto.git
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<2.4.0,>=1.7.0
Requires-Dist: scipy<2,>=1.6.0
Requires-Dist: MCEq<2,>=1.4.0
Requires-Dist: pandas<3
Provides-Extra: plotting
Requires-Dist: matplotlib; extra == "plotting"
Provides-Extra: pythia8
Requires-Dist: pythia8mc; extra == "pythia8"
Requires-Dist: matplotlib; extra == "pythia8"
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Dynamic: license-file

[![PyPI version](https://img.shields.io/pypi/v/nuveto)](https://pypi.org/project/nuveto) [![Build Status](https://github.com/tianluyuan/nuVeto/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/tianluyuan/nuVeto/actions) [![Python versions](https://img.shields.io/pypi/pyversions/nuveto)](https://pypi.org/project/nuveto)

# nuVeto

This package calculates the effect of a detector veto, triggered by the accompanying muons from the same air shower, on the high-energy atmospheric neutrino flux. The calculated result is the passing-flux or passing-fraction of atmospheric neutrinos as a function of energy and zenith angle.

As a corollary, the total atmospheric neutrino flux as well as parent particle fluxes at various depths in the atmosphere are calculated using [`MCEq`](https://github.com/mceq-project/MCEq). To illustrate, the parent fluxes are accessible as shown in this [example](https://github.com/tianluyuan/nuVeto/blob/eb643373534c289ef11a01c43fc82bceeb76c122/src/nuVeto/examples/plots.py#L359).

<img width="49%" alt="fluxes" src="https://github.com/tianluyuan/nuVeto/blob/main/paper/figs_for_readme/fluxes_100.png?raw=true" > <img width="49%" alt="Ds+_025" src="https://github.com/tianluyuan/nuVeto/blob/main/paper/figs_for_readme/Ds+_0.25.png?raw=true" >

In the right panel, solid lines are direct calculations from `MCEq` while dashed lines are an extension down to lower energies where the parent particle is assumed to no longer interact and their fluxes are computed based on the CR flux, cross section, yield and parent's decay length.

## Getting started
It is recommended to work within a Python virtual environment.

```
python3 -m venv vdir
source vdir/bin/activate
```

### Installing

```bash
pip install nuVeto
```

This will install `numpy`, `scipy`, `pandas` and `MCEq`. By default this will not install MKL or CUDA libraries that accelerate `MCEq`. If your system has the right hardware available, it is possible get a substantial speed up with `pip install mkl` or `pip install MCEq[cuda]`. The fastest library is automatically chosen.

As of v2.3.1 a suite of tests is also packaged. It uses [`pytest`](https://docs.pytest.org/en/stable/), which can be optionally installed and run as follows.

```bash
pip install nuVeto[testing]
pytest --pyargs nuVeto
```

Additional optional dependencies are `[plotting]` and `[pythia8]` which will respectively install needed packages for making example plots (`from nuVeto.examples import plots`), and generating alternative hadron decay rates with PYTHIA.

Note that v2.0 and higher rely on the updated version of [MCEq](https://github.com/mceq-project/MCEq). For the legacy version that relies on [MCEq_classic](https://github.com/afedynitch/MCEq_classic) do `git checkout v1.5` and follow the instructions in the README.

### Usage

The simplest way to run is

```python
from nuVeto import passing
from nuVeto.utils import Units
import crflux.models as pm

enu = 1e5*Units.GeV
cos_theta = 0.5
pf = passing(enu, cos_theta, kind='conv nu_mu',
             pmodel=(pm.HillasGaisser2012, 'H3a'),
             hadr='SIBYLL2.3e', depth=1950*Units.m,
             density=('CORSIKA', ('SouthPole','December')))
```
where kind can be `(conv|pr|_parent_) nu_(e|mu)(bar)`

See `examples/plots.py` for more detailed examples.

## Building muon detection probabilities

<img width="49%" alt="Pdet" src="https://github.com/tianluyuan/nuVeto/blob/main/paper/figs_for_readme/prpl_step1000.png?raw=true"> <img width="49%" alt="Pdet" src="https://github.com/tianluyuan/nuVeto/blob/main/paper/figs_for_readme/prpl_sigmoid.png?raw=true">

To calculate the passing fraction requires knowing the muon detection probability as a function of the overburden and energy of the muon at the surface. This is constructed from a convolution of the muon reaching probability and the detector response. The scripts for generating the necessary files are provided in the `scripts/mu/` subdirectory, which can be obtained with a download or clone of this repository.

The muon reaching probability is constructed from MMC simulations and is provided for propagation in ice and water in `data/mmc/(ice|water)_(allm97|bb).npz` for two different cross section parameterizations. The detector response probability must first be defined in `scripts/mu/pl.py` as a function of the muon energy **at the detector**. Then, pass the function name to the `--plight` argument and construct the overall muon reaching and detection probability with the following command, for example.

```bash
cd scripts/mu
./mu.py ice_allm97 -o mymudet.npz --plight pl_step_1000
```

To use the newly generated file, pass the stem without file extension as a string to the `prpl` argument.
```python
passing(enu, cos_theta, prpl='mymudet')`.
```

For many different characterisations of the detector response (e.g. for different depths or different directions) this process can be inconvenient. In this case one can also directly use a function for pl:
```python
from nuVeto.mu import interp

pl=lambda emu: #some function of muon energy

prpl=interp("ice_allm97",pl)
enu=1e3
cos_theta=0.5
pf = passing(enu, cos_theta, prpl=prpl)
```

## Contributers
_Carlos Arguelles, Sergio Palomares-Ruiz, Austin Schneider, Logan Wille, Tianlu Yuan_
