`nrCascadeSim` - A simulation tool for nuclear recoil cascades resulting from neutron capture

`nrCascadeSim` - A simulation tool for nuclear recoil cascades resulting from neutron capture - Published in JOSS (2022)

https://github.com/villano-lab/nrcascadesim

Science Score: 95.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: arxiv.org, joss.theoj.org, zenodo.org
  • Committers with academic emails
    4 of 7 committers (57.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 6 months ago · JSON representation

Repository

calculating the NR spectrum resulting from neutron-capture cascades.

Basic Info
  • Host: GitHub
  • Owner: villano-lab
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: master
  • Size: 24.9 MB
Statistics
  • Stars: 0
  • Watchers: 6
  • Forks: 1
  • Open Issues: 25
  • Releases: 14
Created over 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Code of conduct

README.md

CircleCI Status GitHub Actions Status Documentation Status License: MIT arXiv: 2104.02742 codecov

nrCascadeSim - a tool for generating nuclear recoil spectra resulting from neutron capture

status DOI

A C/C++ set of executables and library for computing the nuclear recoil spectra left behind by capturing neutrons when all the capture gammas escape the medium.

You can find more detailed documentation of nrCascadeSim here. The documentation contains e.g. a guide to get started.

CITATION

If you decide to use this code, or if you want to add a reference to it, please cite the latest archived version,

Villano, A.N., Harris, K., Brown, S. , 2022, nrCascadeSim - A tool for generating nuclear recoil spectra resulting from neutron capture [Code, v1.5.0] [DOI:10.5281/zenodo.5579857].

@software{nrcascadesim, author = {Villano, A.N. and Harris, K. and Brown S.}, title = {{nrCascadeSim - A tool for generating nuclear recoil spectra resulting from neutron capture [Code, v1.5.0]}}, year = {2022}, publisher = {Zenodo}, version = {v1.5.0}, doi = {DOI:10.5281/zenodo.5579857}, url = {https://doi.org/10.5281/zenodo.5579857}, howpublished={The code can be found under \url{https://github.com/villano-lab}.} }

VERSION HISTORY

AUTHORS & CONTACT

The authors of nrCascadeSim are A.N. Villano, K. Harris, and S. Brown.

For questions, support, bug reports, or other suggestions, please open an issue.

LICENSE

This project is licensed under the MIT License - see the LICENSE file.

<!---## Ionization

Ionization assumes the Lindhard model:

Y = k*g(ε)/(1+kg(ε))
g(ε) = a*εγ + b*εω + ε
ε(Er) = 11.5Er[keV]Z-7/3

Using the accepted value for Silicon (k = 0.143) or Germanium (k = 0.159), whichever is appropriate; a = 3; b = 0.7; γ = 0.15; and ω = 0.6.

Last updated 08 Jan, 2022, v1.2.3

Owner

  • Name: UCD Villano Group
  • Login: villano-lab
  • Kind: organization
  • Location: University of Colorado Denver, Physics Department

An organization for the code developed and used by the Villano group for dark matter and particle/nuclear physics research.

JOSS Publication

`nrCascadeSim` - A simulation tool for nuclear recoil cascades resulting from neutron capture
Published
February 23, 2022
Volume 7, Issue 70, Page 3993
Authors
A.n. Villano ORCID
Department of Physics, University of Colorado Denver, Denver CO 80217, USA
Kitty Harris ORCID
Department of Physics, University of Colorado Denver, Denver CO 80217, USA
Staci Brown
Department of Applied Mathematics & Statistics, University of New Mexico, Albuquerque NM 87131, USA
Editor
Lucy Whalley ORCID
Tags
Simulation Nuclear Physics

GitHub Events

Total
  • Issues event: 1
  • Issue comment event: 4
  • Push event: 16
Last Year
  • Issues event: 1
  • Issue comment event: 4
  • Push event: 16

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 927
  • Total Committers: 7
  • Avg Commits per committer: 132.429
  • Development Distribution Score (DDS): 0.441
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Kitty k****s@u****u 518
Anthony Villano a****o@u****u 372
Kitty Harris 4****n 15
Kitty Harris k****s@u****u 12
Staci s****9@m****u 5
Kitt 4****7 4
Francisco J. Solis s****a@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 60
  • Total pull requests: 40
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 19 days
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 2.82
  • Average comments per pull request: 0.68
  • Merged pull requests: 40
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • villaa (27)
  • nuclearGoblin (24)
  • altavir (5)
  • matthewfeickert (4)
Pull Request Authors
  • nuclearGoblin (22)
  • villaa (18)
Top Labels
Issue Labels
JOSS (27) documentation (22) enhancement (22) testing/CI (16) bug (13) coverage (3) help wanted (3) develop (2) build-system (2) question (2)
Pull Request Labels
JOSS (5) enhancement (3) testing/CI (3) bug (2) documentation (2) build-system (1)

Dependencies

docs/requirements.txt pypi
  • breathe *
  • myst-parser *
  • sphinx_rtd_theme *
example-usecase/requirements.txt pypi
  • ipykernel *
  • matplotlib *
  • nbconvert *
  • numpy *
  • pandas *
  • papermill *
  • pytest *
  • scipy *
  • uproot ==3.12.0
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • maxim-lobanov/setup-xcode v1 composite
example-usecase/environment.yml pypi
  • awkward-pandas *
  • pandas *
  • papermill *
  • uproot ==3.12.0