Data

Tools

Indexes

Applications

Experiments

Open Source Science

rionid

Collection of code for the identification of ring-stored ions in Python.

https://github.com/dfreiref/rionid

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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Collection of code for the identification of ring-stored ions in Python.

Basic Info
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 3
  • Open Issues: 7
  • Releases: 3
Created over 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

RionID (Ring-stored ion IDentification) Usage Guide

documentationDOI

RionID is a Python code that simulates the time-of-flight/revolution-frequency spectrum of particles stored in a storage ring. Here is a guide on how to use RionID (for more details please check dfreiref.github.io/rionid/):

Installation

  • Download and install Barion from @Xaratustrah, LISEreader from @gwgwhc and PyROOT

  • Download or clone the RionID repository: bash git clone https://github.com/DFreireF/rionid.git

  • Then in the cloned directory: bash pip install .

    Usage

Navigate to the directory containing the RionID code in your terminal. Run python __main__.py [arguments], replacing [arguments] with the desired arguments (detailed below).

Arguments

The following arguments are available for use with RionID:

Main Arguments

  • datafile (required): Name of the input file with data. Can also be a list of files in a txt file.
  • alphap: Momentum compaction factor of the ring.
  • refion: Reference ion with format NucleonsNameChargestate := AAXX+CC. Example: 72Ge+35, 1H+1, 238U+92...
  • filep: Read list of particles to simulate. LISE file or something else.

Secondary Arguments

  • harmonics: Harmonics to simulate.

Arguments for Each Mode (Exclusive)

  • brho: Brho value of the reference nucleus at ESR (isochronous mode).
  • kenergy: Kinetic energy of reference nucleus at ESR (isochronous mode).
  • gamma: Lorentz factor gamma of the reference particle.
  • fref: Revolution frequency of the reference particle (standard mode).

Arguments for Visualization

  • ndivs: Number of divisions in the display.
  • amplitude: Display of srf data options. 0 -> constant height, else->scaled.

Actions

  • log: Set the logging level.
  • show: Show display. If not, save root file and close display.
  • outdir: Output directory.
  • correct: Correct simulated spectrum following a polynomial fit with paremeters given here.

Example Usage: Dummy example

python python -m rionid datafile.txt -f 11.2452 -r 209Bi+83 -psim datafile.psim -b 5.5 -d 8 -am 1 -s -o output_folder -c 1 2 3

This command would run RionID on the datafile.txt input file, using the standard mode with a reference frequency of 11.2452, a reference ion of 209Bi+83, a particle input file of datafile.psim, a brho value of 5.5, and displaying the data with 8 divisions, scaled amplitude, and showing the display. The output files would be saved in the output_folder directory, and the simulated spectrum would be corrected using the polynomial fit parameters 1, 2, and 3.

Tutorial:

Tutorial for introducing yourself to Schottky data analysis by G. Hudson-Chang @gwgwhc.

Acknowledgements:

We acknowledge Dr. RuiJiu Chen (@chenruijiu) for providing a C++ code for the simulation of time-of-flight which we used as inspiration for the backbone of this code.
We acknowledge Dr. Shahab Sanjari (@xaratustrah) for the guiding our software coding, specially in the initial stages.

Owner

  • Name: David Freire Fernández
  • Login: DFreireF
  • Kind: user
  • Location: Germany
  • Company: GSI, MPIK

Nuclear physics doctoral student

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Freire-Fernández"
  given-names: "David"
  orcid: "https://orcid.org/0000-0002-5898-9291"
- family-names: "Hudson-Chang"
  given-names: "George"
  orcid: "https://orcid.org/0000-0001-6404-6153"
title: "rionid: Collection of code for the identification of ringed ions in Python"
doi: 10.5281/zenodo.8169342
date-released: 2023-07-20
url: "https://github.com/DFreireF/rionid"

GitHub Events

Total
  • Issues event: 4
  • Push event: 60
  • Pull request event: 5
  • Create event: 21
Last Year
  • Issues event: 4
  • Push event: 60
  • Pull request event: 5
  • Create event: 21

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • xaratustrah (4)
  • DFreireF (3)
Pull Request Authors
  • ruijiuchen (4)
Top Labels
Issue Labels
enhancement (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 9 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
pypi.org: rionid

Ring-stored ion IDentification

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 9 Last month
Rankings
Dependent packages count: 9.4%
Average: 31.2%
Dependent repos count: 53.0%
Maintainers (1)
DFreireF
Last synced: 7 months ago