spintrack.jl

High-precision storage ring particle tracking for spin/EDM experiments.

https://github.com/isentropic/spintrack.jl

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

Repository

High-precision storage ring particle tracking for spin/EDM experiments.

Basic Info
  • Host: GitHub
  • Owner: isentropic
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Size: 1.03 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 2
  • Open Issues: 14
  • Releases: 0
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

SpinTrack.jl

This software is specifically designed to perform for storage ring proton EDM experiment.

This software is developed by Zhanibek Omarov under supervision from Yannis K. Semertzidis and Selcuk Haciomeroglu during Ph.D. program at KAIST and IBS-CAPP.

Installation instructions

Install Julia - link

Next, paste this in the Julia prompt (REPL): import Pkg; Pkg.add(url="https://github.com/isentropic/SpinTrack.jl") Pkg.add("Plots")

If you want Jupyter notebooks, refer to this link

Getting started

Once the Installation instructions are performed, paste the following to get the most basic tracking example:

``` using SpinTrack using Plots

p = symmetrichybridring() sol = getsolution(u1long(1e-6), p); plot(sol) `` In casePlots` library errors, you might want to try a different plotting backend.

More examples

More additional examples could be found in examples/ in jupyter notebook format.

Useful links

  1. https://julialang.org/
  2. https://docs.julialang.org/en/v1/manual/getting-started/

TODO items

  1. Add comprehensive documentation
  2. Add unit tests
  3. Add CI via github actions
  4. Add links to the thesis, paper and notes
  5. Add more tutorials

Attribution

Please provide the appropriate attribution if used in your works or find helpful.

  1. Bibtex: bibtex @software{Omarov_SpinTrack_jl_2022, author = {Omarov, Zhanibek}, month = {8}, title = {{SpinTrack.jl}}, version = {0.0.1}, year = {2022} }
  2. Or use the github sidebar "citation" interface
  3. Please give a github star for visibility.

Owner

  • Name: Zhanibek
  • Login: isentropic
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Omarov
    given-names: Zhanibek
    orcid: https://orcid.org/0000-0002-8783-8791
title: "SpinTrack.jl"
version: 0.0.1
date-released: 2022-08-16

GitHub Events

Total
  • Watch event: 3
  • Push event: 1
  • Fork event: 2
Last Year
  • Watch event: 3
  • Push event: 1
  • Fork event: 2

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 17
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 17
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • github-actions[bot] (14)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/CompatHelper.yml actions