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 (13.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: DrLu-2017
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Size: 9.37 MB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
mbtrack2
mbtrack2 is a coherent object-oriented framework written in python to work on collective effects in synchrotrons.
mbtrack2 is composed of different modules allowing to easily write scripts for single bunch or multi-bunch tracking using MPI parallelization in a transparent way. The base of the tracking model of mbtrack2 is inspired by mbtrack, a C multi-bunch tracking code initially developed at SOLEIL.
Examples
Jupyter notebooks demonstrating mbtrack2 features are available in the example folder and can be opened online using google colab:
+ mbtrack2 base features 
+ dealing with RF cavities and longitudinal beam dynamics
+ collective effects
+ bunch by bunch feedback
+ RF loops and feedbacks
Installation
Using pip
Run:
pip install mbtrack2
To test your installation run:
from mbtrack2 import *
Using conda
Clone the mbtrack2 repo and enter the repo:
git clone https://gitlab.synchrotron-soleil.fr/PA/collective-effects/mbtrack2.git
cd mbtrack2
To create a new conda environment for mbtrack2 run:
conda env create -f mbtrack2.yml
conda activate mbtrack2
Or to update your current conda environment to be able to run mbtrack2:
conda env update --file mbtrack2.yml
To test your installation run:
from mbtrack2 import *
Using docker
A docker image is available:
docker pull gitlab-registry.synchrotron-soleil.fr/pa/collective-effects/mbtrack2
References
If used in a publication, please cite mbtrack2 paper and the zenodo archive for the corresponding code version (and any other paper in this list for more specific features).
mbtrack2 general features
A. Gamelin, W. Foosang, and R. Nagaoka, “mbtrack2, a Collective Effect Library in Python”, presented at the 12th Int. Particle Accelerator Conf. (IPAC'21), Campinas, Brazil, May 2021, paper MOPAB070.
RF cavities with beam loading and RF feedbacks
Yamamoto, Naoto, Alexis Gamelin, and Ryutaro Nagaoka. "Investigation of Longitudinal Beam Dynamics With Harmonic Cavities by Using the Code Mbtrack." Proc. 10th International Partile Accelerator Conference (IPAC’19), Melbourne, Australia, 19-24 May 2019. 2019.
Owner
- Login: DrLu-2017
- Kind: user
- Repositories: 1
- Profile: https://github.com/DrLu-2017
Citation (CITATION.cff)
cff-version: 1.2.0
title: mbtrack2
message: 'If you use this software, please cite it as below.'
type: software
authors:
- family-names: Gamelin
given-names: Alexis
- family-names: Foosang
given-names: Watanyu
- family-names: Yamomoto
given-names: Naoto
- family-names: Gubaidulin
given-names: Vadim
- family-names: Nagaoka
given-names: Ryutaro
identifiers:
- type: doi
value: 10.5281/zenodo.14418989
repository-code: >-
https://gitlab.synchrotron-soleil.fr/PA/collective-effects/mbtrack2
abstract: >
mbtrack2 is a coherent object-oriented framework written
in python to work on collective effects in synchrotrons.
license: BSD-3-Clause
version: 0.8.0
date-released: '2024-12-16'
GitHub Events
Total
- Push event: 7
- Create event: 2
Last Year
- Push event: 7
- Create event: 2
Dependencies
- gitlab-registry.synchrotron-soleil.fr/pa/collective-effects/python_mpi latest build
- accelerator-toolbox >=0.5.0
- h5py >=3.6
- matplotlib >=3.5
- mpmath >=1.2.1
- myst_parser >=0.15
- numpy >=1.21
- pandas >=1.5.3
- readthedocs-sphinx-search ==0.1.1
- scipy >=1.7
- seaborn >=0.12
- sphinx ==5.3.0
- sphinx_rtd_theme ==1.1.1
- accelerator-toolbox 0.6.1
- colorama 0.4.6
- contourpy 1.3.0
- cycler 0.12.1
- exceptiongroup 1.2.2
- fonttools 4.54.1
- h5py 3.12.1
- importlib-metadata 8.5.0
- importlib-resources 6.4.5
- iniconfig 2.0.0
- isort 5.13.2
- kiwisolver 1.4.7
- matplotlib 3.9.2
- mpi4py 3.1.6
- mpmath 1.3.0
- numpy 1.26.4
- packaging 24.2
- pandas 2.2.3
- pillow 11.0.0
- platformdirs 4.3.6
- pluggy 1.5.0
- pyparsing 3.2.0
- pytest 7.4.4
- pytest-mock 3.14.0
- python-dateutil 2.9.0.post0
- pytz 2024.2
- scipy 1.13.1
- seaborn 0.12.2
- six 1.16.0
- tomli 2.0.2
- tzdata 2024.2
- yapf 0.40.2
- zipp 3.21.0
- isort 5.* develop
- pytest ^7.1 develop
- pytest-mock >= 3.14.0 develop
- yapf >= 0.29 develop
- accelerator-toolbox >= 0.5.0
- h5py ^3.6
- matplotlib ^3.5
- mpi4py ^3.1
- mpmath ^1.2.1
- numpy ^1.21
- pandas >=1.5.3
- python >=3.9
- scipy ^1.7
- seaborn ^0.12