Giter Club home page Giter Club logo

rionid's Introduction

RionID (Ringed IONs IDentification) Usage Guide

documentationDOI

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

Installation

  git clone https://github.com/DFreireF/rionid.git
  • Then in the cloned directory:
  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 -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 ToF which we used as inspiration for the backbone of this code.
We acknowledge Dr. Shahab Sanajri (@xaratustrah) for the guiding our software coding, specially in the initial stages.

rionid's People

Contributors

dfreiref avatar gwgwhc avatar

Stargazers

nana_van avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

ruijiuchen

rionid's Issues

GUI under Graph

One window with graph on top and controls on the bottom, so that settings can be changed on the fly.

Move lines on the graph

Ability to move lines on the graph by mouse, if known position, so that all other lines get new calculation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.