mute

A lightweight code for calculations of muon fluxes and intensities.

https://github.com/wjwoodley/mute

Science Score: 33.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A lightweight code for calculations of muon fluxes and intensities.

Basic Info
  • Host: GitHub
  • Owner: wjwoodley
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 1.82 MB
Statistics
  • Stars: 13
  • Watchers: 2
  • Forks: 3
  • Open Issues: 1
  • Releases: 0
Created almost 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License

README.md

MUTE

DOI

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

Total Underground Flux vs Vertical Depth

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).

Owner

  • Name: William Woodley
  • Login: wjwoodley
  • Kind: user

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 3
  • Watch event: 5
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 1
  • Fork event: 1
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 3
  • Watch event: 5
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 1
  • Fork event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 14
  • Total Committers: 3
  • Avg Commits per committer: 4.667
  • Development Distribution Score (DDS): 0.357
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
wjwoodley w****y@u****a 9
William Woodley 5****y 4
Anatoli Fedynitch a****h 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 3
  • Total pull requests: 5
  • Average time to close issues: 6 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: 6 months
  • Average time to close pull requests: 2 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • zhoualbert (2)
  • afedynitch (1)
Pull Request Authors
  • wjwoodley (4)
  • afedynitch (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 106 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 7
  • Total maintainers: 1
pypi.org: mute

Muon Intensity Code

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 106 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 11.6%
Average: 18.6%
Forks count: 19.1%
Stargazers count: 19.3%
Downloads: 32.9%
Maintainers (1)
Last synced: 10 months ago