mute 3.0.0

Muon Intensity Code

MUTE

MUTE (MUon inTensity codE) is a computational tool for calculating atmospheric muon fluxes and intensities underground. It makes use of the state-of-the-art codes daemonflux and MCEq, to calculate surface fluxes, and PROPOSAL, to simulate the propagation of muons through rock and water.

Installation

MUTE can be installed via pip:

pip install mute

This will install most of the requirements, including MCEq.

Additional Requirements

In order to generate custom survival probability tensors, PROPOSAL should be installed. Because it requires compilation, it needs to be installed separately (see detailed installation instructions here):

pip install proposal==7.6.2

MUTE has been tested with PROPOSAL v7.6.2; earlier or later versions are not guaranteed to work. Environment set-up help for PROPOSAL installation on a Mac can be found here.

Getting Started

The code for the above plot is found in /examples/example_total_flux_plot.ipynb.

For a basic example and a detailed description of how to use MUTE, see the Tutorial. For further examples, see the examples.

Citation

Please cite https://inspirehep.net/literature/1927720 for MUTE v1-2 and https://inspirehep.net/literature/2799258 for MUTE v3.

The current version of MUTE can be cited with the Zenodo DOI.

The citations for the models and propagation tools used by MUTE can be found in the MCEq and PROPOSAL documentation.

Authors

William Woodley

Contributors

Anatoli Fedynitch (@afedynitch) and Marie-Cécile Piro (@MarieCecile)

License

MUTE is licensed under the BSD 3-Clause License (see LICENSE).