turn_by_turn
I/O functionality for turn-by-turn BPM measurements data from different particle accelerators
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○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 -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.2%) to scientific vocabulary
Keywords
Repository
I/O functionality for turn-by-turn BPM measurements data from different particle accelerators
Basic Info
- Host: GitHub
- Owner: pylhc
- License: mit
- Language: Python
- Default Branch: master
- Homepage: https://pylhc.github.io/turn_by_turn/
- Size: 18 MB
Statistics
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 0
- Releases: 15
Topics
Metadata Files
README.md
Turn-By-Turn
<!-- 
-->
This package provides reading functionality for turn-by-turn BPM measurements data from different particle accelerators.
It also provides writing functionality in the LHC's own SDDS format, through our sdds package.
Files are read into a custom-made TbtData dataclass encompassing the relevant information.
See the API documentation for details.
Installing
Installation is easily done via pip:
bash
python -m pip install turn_by_turn
One can also install in a conda environment via the conda-forge channel with:
bash
conda install -c conda-forge turn_by_turn
Example Usage
The package is imported as turn_by_turn, and exports top-level functions for reading and writing:
```python
import turnbyturn as tbt
Loading a file is simple and returns a custom dataclass named TbtData
data: tbt.TbtData = tbt.read("Beam2@BunchTurn@20181202@200849_739.sdds", datatype="lhc")
Easily access relevant information from the loaded data: transverse data, measurement date,
number of turns, bunches and IDs of the recorded bunches
firstbunchtransversepositions: tbt.TransverseData = data.matrices[0] measurementdate = data.date # a datetime.datetime object
Transverse positions are recorded as pandas DataFrames
firstbunchx = firstbunchtransversepositions.X.copy() firstbunchy = firstbunchtransversepositions.Y.copy()
Do any operations with these as you usually do with pandas
firstbunchmeanx = firstbunch_x.mean()
Average over all bunches/particles at all used BPMs from the measurement
averagedtbt: tbt.TbtData = tbt.utils.generateaverage_tbtdata(data)
Writing out to disk (in the LHC's SDDS format) is simple too, potentially with added noise
tbt.write("pathtooutput.sdds", averaged_tbt, noise=1e-5) ```
License
This project is licensed under the MIT License - see the LICENSE file for details.
Owner
- Name: PyLHC
- Login: pylhc
- Kind: organization
- Location: CERN
- Website: https://pylhc.github.io/
- Repositories: 26
- Profile: https://github.com/pylhc
Organisation for the OMC Team at CERN, in BE-ABP-LNO.
GitHub Events
Total
- Issues event: 1
- Delete event: 3
- Issue comment event: 11
- Push event: 32
- Pull request review event: 61
- Pull request review comment event: 93
- Pull request event: 6
- Create event: 4
Last Year
- Issues event: 1
- Delete event: 3
- Issue comment event: 11
- Push event: 32
- Pull request review event: 61
- Pull request review comment event: 93
- Pull request event: 6
- Create event: 4
Committers
Last synced: almost 3 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Felix Soubelet | f****t@p****m | 65 |
| Felix Soubelet | 1****t@u****m | 7 |
| JoschD | 2****D@u****m | 4 |
| awegsche | a****1@g****m | 2 |
| fscarlier | f****r@u****m | 1 |
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 2
- Total pull requests: 20
- Average time to close issues: 12 days
- Average time to close pull requests: 3 days
- Total issue authors: 1
- Total pull request authors: 6
- Average comments per issue: 1.0
- Average comments per pull request: 1.3
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: 5 days
- Issue authors: 0
- Pull request authors: 4
- Average comments per issue: 0
- Average comments per pull request: 1.67
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- JoschD (2)
- emaclean (1)
Pull Request Authors
- fsoubelet (10)
- JoschD (10)
- Mael-Le-Garrec (2)
- fscarlier (2)
- jgray-19 (2)
- awegsche (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 1,329 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 23
- Total maintainers: 1
pypi.org: turn_by_turn
Read and write turn-by-turn measurement files from different particle accelerator formats.
- Documentation: https://turn_by_turn.readthedocs.io/
-
Latest release: 0.9.1
published 8 months ago
Rankings
Maintainers (1)
conda-forge.org: turn_by_turn
Python package to read and write BPM measurement files from different particle accelerators.
- Homepage: https://github.com/pylhc/turn_by_turn
- License: MIT
-
Latest release: 0.4.2
published over 3 years ago
Rankings
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- JamesIves/github-pages-deploy-action 3.7.1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite