omc3 0.4.0

An accelerator physics tools package for the OMC team at CERN.

3

This is the python-tool package of the Optics Measurements and Corrections team (OMC) at CERN.

Most of the codes are generic and not limited to CERN accelerators, and the package can easily be used for your favourite circular accelerator. To see how to adapt this for your machine, see our documentation, Model section. To contribute, see our guidelines on the OMC website.

Documentation

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

Installing

Installation is easily done via pip:

pip install omc3

For development purposes, we recommend creating a new virtual environment and installing from VCS in editable mode with all extra dependencies (cern for packages only available in the CERN GPN, test for pytest and relevant plugins, and doc for packages needed to build documentation)

git clone https://github.com/pylhc/omc3
pip install --editable "omc3[all]"

Codes can then be run with either python -m omc3.SCRIPT --FLAG ARGUMENT or calling the .py file directly.

Functionality

Main Scripts

Main scripts to be executed lie in the /omc3 directory. These include:

• global_correction.py to calculate corrections from measurement files.
• hole_in_one.py to perform frequency analysis on turn by turn BPM data and infer optics (and more) for a given accelerator.
• madx_wrapper.py to start a MAD-X run with a file or string as input.
• model_creator.py to generate optics models required for optics analysis.
• response_creator.py to provide correction response files.
• run_kmod.py to analyse data from K-modulation and return the measured optics functions.
• tbt_converter.py to convert different turn by turn datatypes to SDDS, potentially adding noise.
• amplitude_detuning_analysis.py to perform amp. det. analysis on optics data with tune correction.

Plotting Scripts

Plotting scripts for analysis outputs can be found in /omc3/plotting:

• plot_spectrum.py to generate plots from files generated by frequency analysis.
• plot_bbq.py to generate plots from files generated by BBQ analysis.
• plot_amplitude_detuning.py to generate plots from files generated by amplitude detuning analysis.
• plot_optics_measurements.py to generate plots from files generated by optics_measurements.
• plot_tfs.py all purpose tfs-file plotter.

Other Scripts

Other general utility scripts are in /omc3/scripts:

• update_nattune_in_linfile.py to update the natural tune columns in the lin files by finding the highest peak in the spectrum in a given interval.
• write_madx_macros.py to generate MAD-X tracking macros with observation points from a twiss file.
• merge_kmod_results.py to merge lsa_results files created by kmod, and add the luminosity imbalance if the 4 needed IP/Beam files combination are present.
• fake_measurement_from_model.py to create a fake measurement based on a model twiss file.
• betabeatsrc_output_converter.py to convert outputs from our old codes to omc3's new standardized format.
• linfile_clean.py to automatically clean given columns in lin-files.

Example use for these scripts can be found in the tests files. Documentation including relevant flags and parameters can be found at https://pylhc.github.io/omc3/.

License

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