twinpals-modul-1

A custom made Geant4 simulation for a Positron Annihilation Lifetime Spectroscopy to generate data streams with individual event information.

https://github.com/db-science/twinpals-modul-1

Science Score: 57.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 1 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A custom made Geant4 simulation for a Positron Annihilation Lifetime Spectroscopy to generate data streams with individual event information.

Basic Info
  • Host: GitHub
  • Owner: DB-science
  • License: gpl-3.0
  • Language: C++
  • Default Branch: main
  • Size: 79.1 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created almost 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

TwinPALS Module 1: Digital Twin for Positron Annihilation Spectroscopy (PALS)

This first module of the digital twin for Positron Annihilation Spectroscopy (PALS) is a Geant4-based simulation written in C++. In this simulation, the positron source is simplified to only produce the accompanying gamma of 1275 keV energy and the two collinear 511 keV gamma quanta from annihilation. Each gamma energy requires its own simulation run. The scintillators available in this simulation are based on common plastic scintillators used in PALS applications.

Prerequisites

To successfully use this simulation, Geant4 must be downloaded in advance. The version I used is 11.0.0, which can be downloaded here: Geant4 Download. A YouTube video detailing the installation and initial steps with Geant4 can be found at the following link: Geant4 Installation Guide.

How to Use the First Module of TwinPALS

In the src folder, you will find a file named DetectorConstruction.cc. Between lines 205 and 236, there is a marked section (see image below). This section contains several parameters that can be adjusted as needed.

Adjustable Parameters

- worldSizeXY and worldSizeZ: Define the dimensions of the world volume.
- Scintillator_geometry_choice: Switch between four different scintillator geometries by setting values from 0 to 3.
- cryst_dX, cryst_dY, cryst_dZ, Frontradius: Determine the dimensions of the scintillators used.
- Distance_form_origin: Specifies the distance of the scintillator surface from the center of the world volume.

Please refer to the image below for the exact location of these parameters in the DetectorConstruction.cc file. Adjust these parameters according to your specific requirements to tailor the simulation to your needs.

Einstellungen

Additionally, in the src folder, in the file PrimaryGenerator.cc, at line 44 (see image below), you can switch between the two gamma energies (511 keV collinear gamma quanta or 1275 keV) by setting the value to 1 or 0.

Einstellungen_Gamma_energy

Finally, in the src folder, in the file RunAction.cc, at line 92, you define the location and name of the binary data stream within the quotation marks. The file extension .stream should be retained.

Einstellungen_StreamSave

How to cite this Software?

You must cite the applied version of this software in your study.

You can cite all versions by using the DOI 10.5281/zenodo.11448085. This DOI represents all versions, and will always resolve to the latest one

Owner

  • Name: DB_science
  • Login: DB-science
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Boras
  given-names: Dominik
orcid: https://orcid.org/0009-0002-0324-7730
title: TwinPALS-Modul-1
version: v1.0.0
date-released: 2024-06-03

GitHub Events

Total
Last Year