Data

Tools

Indexes

Applications

Experiments

Open Source Science

remage

Simulation framework for low-background physics experiments

https://github.com/legend-exp/remage

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 9 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.0%) to scientific vocabulary

Keywords

geant4 germanium-detectors low-background monte-carlo particle-physics simulation
Last synced: 10 months ago · JSON representation ·

Repository

Simulation framework for low-background physics experiments

Basic Info
Statistics
  • Stars: 7
  • Watchers: 5
  • Forks: 12
  • Open Issues: 38
  • Releases: 27
Topics
geant4 germanium-detectors low-background monte-carlo particle-physics simulation
Created over 5 years ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Citation

README.md

remage logo

remage

Simulation framework for low background physics experiments

GitHub tag (latest by date) GitHub Workflow Status pre-commit GitHub issues GitHub pull requests Read the Docs Docker Hub License DOI


The remage project aims to deliver a modern Geant4-based C++ library designed for efficient simulation of particle physics processes in typical low background physics experiments. The library is setup-agnostic, requiring users only to define the experimental setup's geometry. Supported specification languages include C++, GDML, and others. Once the geometry is provided, users can access a comprehensive suite of tools for common tasks, such as physics generation and standard output handling.

Get started with our documentation pages!

Main features

  • Low entry barrier: Most simulations can be executed directly using the remage executable and a macro file, eliminating the need to write or compile C++ code.
  • Various pre-compiled remage versions available on Docker Hub
  • Support for modern Geant4, including:
    • Multithreading
    • GDML support
    • Multiple output file formats (ROOT, HDF5...)
  • LEGEND HDF5 (LH5) output format
  • Fast third-party cosmic muon generator (through EcoMug)
  • Support for external generators:
  • Third-party double-beta decay generator (through bxdecay0)
  • Advanced vertex confinement on physical volumes, geometrical solids, surfaces and intersections
  • Sensible output schemes for HPGe and optical detectors

Owner

  • Name: LEGEND Experiment
  • Login: legend-exp
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
title: remage
doi: 10.5281/zenodo.11115662
date-released: 2024-05-05
message: "If you use this software, please cite it as below."
authors:
  - family-names: Pertoldi
    given-names: Luigi
    orcid: https://orcid.org/0000-0002-0467-2571
  - family-names: Huber
    given-names: Manuel
    orcid: https://orcid.org/0009-0000-5212-2999
  - family-names: Neuberger
    given-names: Moritz
    orcid: https://orcid.org/0009-0001-8471-9076
  - family-names: Morgan
    given-names: Benjamin
    orcid: https://orcid.org/0000-0003-3604-0883
  - family-names: Esch
    given-names: Eric
    orcid: https://orcid.org/0009-0000-4920-9313
  - family-names: Dixon
    given-names: Toby
    orcid: https://orcid.org/0000-0001-8787-6336

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 102
  • Total pull requests: 259
  • Average time to close issues: 3 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 7
  • Total pull request authors: 8
  • Average comments per issue: 2.16
  • Average comments per pull request: 1.69
  • Merged pull requests: 199
  • Bot issues: 1
  • Bot pull requests: 24
Past Year
  • Issues: 84
  • Pull requests: 204
  • Average time to close issues: 18 days
  • Average time to close pull requests: 4 days
  • Issue authors: 6
  • Pull request authors: 7
  • Average comments per issue: 2.44
  • Average comments per pull request: 2.0
  • Merged pull requests: 155
  • Bot issues: 1
  • Bot pull requests: 15
View more stats
Top Authors
Issue Authors
  • gipert (55)
  • ManuelHu (20)
  • tdixon97 (14)
  • EricMEsch (7)
  • MoritzNeuberger (4)
  • drbenmorgan (1)
  • pre-commit-ci[bot] (1)
Pull Request Authors
  • ManuelHu (144)
  • gipert (42)
  • tdixon97 (25)
  • pre-commit-ci[bot] (22)
  • EricMEsch (21)
  • dependabot[bot] (2)
  • MoritzNeuberger (2)
  • 311Francis (1)
Top Labels
Issue Labels
output (20) bug (13) discussion (9) documentation (9) python-wrapper (6) generators (6) lh5 (4) enhancement (4) validation (3) build-system (2) help wanted (2) physics (2) good first issue (1) geometry (1)
Pull Request Labels
documentation (12) python-wrapper (10) validation (8) output (7) bug (7) enhancement (6) physics (3) CI/CD (3) codex (3) generators (2) build-system (2) dependencies (2) geometry (1) github_actions (1) discussion (1)

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v2 composite
docs/environment.yml pypi