README.md

PyLHC Tools

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

• Autogenerated docs via Sphinx can be found at https://pylhc.github.io/PyLHC/.
• General documentation of the OMC-Team is located at https://pylhc.github.io/

Installing

This package is Python 3.7+ compatible, and can be installed through pip:

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:

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. (forced_da_analysis.py)
• Machine Settings Info - Prints an overview over the machine settings at a given time. (machine_settings_info.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.