Skip to content

The OMC Python Packages

This section of the website goes over our Python computing and analysis software and environments. Our main software for optics analysis is the omc3 package.

Our other packages provide useful tools and scripts for our day-to-day work as well as specific I/O functionality and entrypoint utilities for our codes. All our Python codes, including legacy repositories, can be found on the PyLHC organisation's page on Github. An overview of our main packages and relevant links can be found in the table below.

Package Description Version Documentation Wiki
OMC3 Frequency analysis, optics computation from turn-by-turn data, corrections calculations and results plotting PyPI version for OMC3
OMC3 GUI Graphical User Interface for OMC3 Segment-by-Segment Analysis PyPI version for OMC3 GUI
TFS-Pandas TFS files I/O functionality PyPI version for TFS-Pandas
Turn-by-Turn Particle accelerators turn-by-turn BPM measurements I/O functionality PyPI version for Turn-by-Turn
SDDS SDDS files I/O functionality PyPI version for SDDS
Optics-Functions Calculate various beam optics functions from TFS-Dataframes PyPI version for Optics-Functions
Generic-Parser Entrypoint argument parser functionality PyPI version for Generic-Parser

Some smaller utility or legacy packages are found in the table below:

Package Description Version Documentation Wiki
PyLHC-Tools Useful OMC-related scripts PyPI version for PyLHC-Tools
PyLHC-Submitter Wrapper for HTCondor job submission PyPI version for PyLHC-Submitter
IRNL RDT Correction Calculate powering of IR NL-correctors based on RDT compensation. PyPI version for IRNL RDT Correction
IR Amplitude Detuning Correction Correct amplitude detuning via IR correctors. PyPI version for IR Amplitude Detuning Correction
Example Study Scripts Collection of example MAD-X studies GitHub release for MESS
Beta-Beat.src Frequency analysis, optics computation from turn-by-turn data and corrections calculations GitHub release for Beta-Beat.src
Accelerator Timeline Frequency analysis, optics computation from turn-by-turn data and corrections calculations GitHub release for Beta-Beat.src

The OMC Production Environments

The OMC Python 3 production environment for use for instance in the CCC is based on the CERN BE/CO Acc-Py distribution, although an OMC-specific one. The environment, along with many of our important files, is located in the /afs/cern.ch/eng/sl/lintrack/ directory on afs.

The environment is located at /afs/cern.ch/eng/sl/lintrack/omc_python3/ and can be used in two different ways:

  • Activate the environment (source /afs/cern.ch/eng/sl/lintrack/omc_python3/bin/activate) then run python to execute your programs.
  • Point to the Python executable directly (/afs/cern.ch/eng/sl/lintrack/omc_python3/bin/python) to execute your programs.

Modifying the Environment

You cannot modify this environment, unless you are one of the maintainers. Should you need specific packages, reach out to us or consider setting up your own environment from our Acc-Py distribution.

Python 2 Environment

A legacy Python 2 version of our optics software exists: Beta-Beat.src. Its development has ended, but it is kept for anyone trying to rerun old analyses.

We do have a miniconda2 installation in lintrack for such legacy Python 2 codes. This distribution is frozen and the use of Python 2 codes should be avoided as much as possible.