Data

Tools

Indexes

Applications

Experiments

Open Source Science

showermodel

A Python package for modelling cosmic-ray showers, their light production and their detection

https://github.com/jaimerosado/showermodel

Science Score: 67.0%

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

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

Repository

A Python package for modelling cosmic-ray showers, their light production and their detection

Basic Info
Statistics
  • Stars: 17
  • Watchers: 4
  • Forks: 1
  • Open Issues: 4
  • Releases: 10
Created almost 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

ShowerModel

Build Status Binder DOI pypi Documentation Status

ShowerModel logo

A Python package for modelling cosmic-ray showers, their light production and their detection.

  • Code : https://github.com/JaimeRosado/ShowerModel
  • Docs: https://showermodel.readthedocs.io/

* License: GPL-3.0

Install

  • Install miniconda or anaconda first.

As user

It can be installed by doing: pip install ShowerModel If pip install ShowerModel fails as it is, you probably need to use --user option. This may happen in Windows installations. pip install --user ShowerModel

Although it is optional, it is recommended to create a dedicated conda virtual environment.

As developer

  • Create and activate the conda environment: git clone https://github.com/JaimeRosado/ShowerModel.git cd ShowerModel conda env create -f environment.yml conda activate showermodel

  • To update the environment when dependencies get updated use: conda env update -n showermodel -f environment.yml

To install ShowerModel, run the following command from the ShowerModel root directory where the setup.py file is located: pip install -e .

Test your installation by running any of the notebooks in this repository. Otherwise, open an Issue with your error.

Further information

See our presentation video and contribution to ADASS XXX conference: * https://drive.google.com/file/d/14AGV91mQXDwecGy2qxgNEmWeIcxKy_I0/view?usp=sharing * https://adass2020.es/static/ftp/P4-176/P4-176.pdf

Owner

  • Name: Jaime Rosado
  • Login: JaimeRosado
  • Kind: user
  • Company: Universidad Complutense de Madrid

Citation (CITATION.cff) 

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Rosado
    given-names: Jaime
    orcid: https://orcid.org/0000-0001-8208-9480
  - family-names: Morcuende
    given-names: Daniel
    orcid: https://orcid.org/0000-0001-9400-0922
title: ShowerModel
doi: 10.5281/zenodo.6773258
version: v0.1.9
date-released: 2022-06-28

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 314
  • Total Committers: 2
  • Avg Commits per committer: 157.0
  • Development Distribution Score (DDS): 0.401
Top Committers
Name Email Commits
Jaime Rosado j****s@f****s 188
Daniel Morcuende d****n@u****s 126
Committer Domains (Top 20 + Academic)
ucm.es: 1 fis.ucm.es: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 9
  • Total pull requests: 31
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 3 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.22
  • Average comments per pull request: 0.39
  • Merged pull requests: 27
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • morcuended (8)
  • JaimeRosado (1)
Pull Request Authors
  • morcuended (27)
  • JaimeRosado (4)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 11 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 6
  • Total maintainers: 2
pypi.org: showermodel

Modelling cosmic-ray showers, their light production and its detection

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 11 Last month
Rankings
Dependent packages count: 10.1%
Stargazers count: 15.3%
Dependent repos count: 21.6%
Forks count: 22.7%
Average: 22.8%
Downloads: 44.5%
Maintainers (2)
morcuende JaimeRosado
Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/pypi_publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite
environment.yml pypi
pyproject.toml pypi
setup.py pypi