Skip to main content

Ring-stored ion IDentification: A pure Python tool for Schottky spectrum analysis.

Project description

RionID (Ring-stored ion IDentification)

Documentation DOI PyPI version License

RionID is a Python software for the identification of ions stored in storage rings. It simulates revolution frequencies based on magnetic rigidity or frequency settings and matches them against experimental Schottky spectra.

Features

  • Pure Python: No ROOT dependencies required.
  • Automated Matching: Includes Quick PID logic to scan $\alpha_p$ and Reference Frequency to find the best match ($\chi^2$ minimization).
  • Signal Processing: Built-in baseline subtraction (BrPLS) and peak detection.
  • Standalone: Bundles barion and lisereader (GPL-3.0) for easy installation without complex dependency management.

Installation

Option 1: From PyPI (Recommended)

RionID is available on the Python Package Index. This is the easiest way to install it along with all dependencies.

pip install rionid

Option 2: From Source

If you want the development version:

git clone https://github.com/GSI-Nuclear-Astrophysics/rionid.git
cd rionid
pip install .

Usage

Graphical User Interface (GUI)

Once installed, you can launch the GUI simply by typing:

rionid

Command Line Interface (CLI)

You can also run simulations directly from the terminal:

rionid datafile.npz -f 11.2452 -r 209Bi+83 -psim fragments.lpp -b 5.5

Arguments

  • datafile: Input spectrum file (.npz, .csv, .txt).
  • -r, --refion: Reference ion (e.g., 72Ge+35).
  • -ap, --alphap: Momentum compaction factor.
  • -psim: LISE++ output file for fragment yields.
  • -hrm: Harmonics to simulate.
  • -b, --brho: Magnetic rigidity (Brho) [Tm].
  • -f, --fref: Revolution frequency [Hz].
  • --remove_baseline: Apply baseline subtraction.
  • --peak_threshold_pct: Peak detection threshold (0.0 - 1.0).

Acknowledgements

  • Dr. RuiJiu Chen for providing the C++ Time-of-Flight simulation code that inspired the backbone of this software.
  • Dr. Shahab Sanjari for guidance on software architecture and Schottky analysis.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rionid-8.0.0.tar.gz (117.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rionid-8.0.0-py3-none-any.whl (72.6 kB view details)

Uploaded Python 3

File details

Details for the file rionid-8.0.0.tar.gz.

File metadata

  • Download URL: rionid-8.0.0.tar.gz
  • Upload date:
  • Size: 117.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.4 Linux/6.16.1-arch1-1

File hashes

Hashes for rionid-8.0.0.tar.gz
Algorithm Hash digest
SHA256 de7cfc1669992a5a7e8549a400eaff485c488c6d809ac207c0a01d391be608cc
MD5 4ebe444d4f9e75e67dbb4a357d8087b4
BLAKE2b-256 97d4f435ab16f005a765ced4dd1e798df205ccb376341abfea56e2cbd1b45419

See more details on using hashes here.

File details

Details for the file rionid-8.0.0-py3-none-any.whl.

File metadata

  • Download URL: rionid-8.0.0-py3-none-any.whl
  • Upload date:
  • Size: 72.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.4 Linux/6.16.1-arch1-1

File hashes

Hashes for rionid-8.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 60925f3d0542f93b1a282cdad9491d4048f579238523c99164fdfaae90c4e99c
MD5 58800520004a80c9f6ac6652edc6e1d0
BLAKE2b-256 13dd4e6c942b1b1561996214b9b58125de25ec08ad00a1d09d507e55c0a74c9b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page