pylhc

Additional tools for particle accelerator data analysis and machine information

https://github.com/pylhc/pylhc

Science Score: 59.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
    2 of 8 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

analysis cern lhc omc optics particle-accelerators pylhc python

Keywords from Contributors

commandline-calls generic-parser ini-parser accelerator-physics frequency-analysis mad-x optics-measurements plots
Last synced: 6 months ago · JSON representation

Repository

Additional tools for particle accelerator data analysis and machine information

Basic Info
Statistics
  • Stars: 4
  • Watchers: 15
  • Forks: 2
  • Open Issues: 3
  • Releases: 19
Topics
analysis cern lhc omc optics particle-accelerators pylhc python
Created over 14 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Zenodo

README.md

PyLHC Tools

Cron Testing Code Climate coverage Code Climate maintainability (percentage) GitHub last commit GitHub release DOI

This package provides tools for particle accelerator physics complementing the optics measurement analysis tools of the omc3 package. It is a collection of useful scripts for the Optics Measurements and Corrections team (OMC) at CERN, with functionality for data analysis, corrections calculation, simulations management and machine information extraction.

Documentation

Installing

This package is Python 3.7+ compatible, and can be installed through pip: bash python -m pip install pylhc

After installing, scripts can be run with either python -m pylhc.SCRIPT --FLAG ARGUMENT or by calling the Python files directly.

For development purposes, we recommend creating a new virtual environment and installing from VCS in editable mode with all extra dependencies: bash git clone https://github.com/pylhc/pylhc python -m pip install --editable "pylhc[all]"

Note: Some scripts access functionality only available on the CERN Technical Network. To use those, you should make sure to install the relevant extra dependencies with python -m pip install "pylhc[cern]".

Functionality

  • Forced DA Analysis - Script to analyze forced DA. (forceddaanalysis.py)
  • Machine Settings Info - Prints an overview over the machine settings at a given time. (machinesettingsinfo.py)
  • KickGroup Information - Get information about KickGroups. (kickgroups.py)
  • BSRT Logger and BSRT Analysis - Saves data coming straight from LHC BSRT FESA class and allows subsequent analysis. (bsrt_logger.py & bsrt_analysis.py )
  • BPM Calibration Factors - Compute the BPM calibration factors using ballistic optics. Two methods are available: using the beta function and using the dispersion. (bpm_calibration.py)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Owner

  • Name: PyLHC
  • Login: pylhc
  • Kind: organization
  • Location: CERN

Organisation for the OMC Team at CERN, in BE-ABP-LNO.

GitHub Events

Total
  • Release event: 1
  • Delete event: 1
  • Push event: 5
  • Pull request review comment event: 5
  • Pull request review event: 7
  • Pull request event: 1
  • Create event: 3
Last Year
  • Release event: 1
  • Delete event: 1
  • Push event: 5
  • Pull request review comment event: 5
  • Pull request review event: 7
  • Pull request event: 1
  • Create event: 3

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 117
  • Total Committers: 8
  • Avg Commits per committer: 14.625
  • Development Distribution Score (DDS): 0.778
Top Committers
Name Email Commits
mihofer m****r@c****h 26
Felix Soubelet 1****t@u****m 22
JoschD j****y@g****m 21
Yngve Inntjore Levinsen y****n@g****m 15
mihofer a 13
JoschD 2****D@u****m 12
Joschua Werner Dilly j****y@c****h 7
Maël Le Garrec m****l@l****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 35
  • Total pull requests: 68
  • Average time to close issues: 3 months
  • Average time to close pull requests: 15 days
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.6
  • Average comments per pull request: 0.44
  • Merged pull requests: 64
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 13 hours
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.67
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JoschD (19)
  • mihofer (8)
  • fsoubelet (7)
  • lmalina (1)
Pull Request Authors
  • JoschD (36)
  • fsoubelet (25)
  • mihofer (8)
  • Mael-Le-Garrec (1)
Top Labels
Issue Labels
Enhancement (16) Bug (5) Release (3) Type: Feature (3) Documentation (3) Request (1) Type: Release (1) Citation (1)
Pull Request Labels
Enhancement (11) Bug (7) Release (6) Type: Maintenance (3) Estimate: Normal (3) Type: Bug (3) Type: Feature (3) Documentation (3) Request (2) CI/CD (2) Priority: Low (2) Citation (1) Removal (1) Type: Documentation (1) Type: Release (1) Type: CI/CD (1) Status: Review Needed (1) Feature (1)

Dependencies

.github/workflows/coverage.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/cron.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/documentation.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • generic-parser >= 1.1
  • jpype1 >= 1.3
  • matplotlib >= 3.8
  • numpy >= 1.24
  • omc3 >= 0.15
  • pandas >= 2.1
  • parse >= 1.15
  • scipy >= 1.10
  • tfs-pandas >= 3.8