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
Sphinxcan be found at https://pylhc.github.io/omc3/. - General documentation of the OMC Team is located at https://pylhc.github.io/.
Installing
The package is deployed on PyPI and can easily be installed via pip:
python -m 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
python -m pip install --editable "omc3[all]"
Functionality
Codes can then be run with either python -m omc3.SCRIPT --FLAG ARGUMENT or calling the .py file directly.
Main Scripts
Main scripts to be executed lie in the /omc3 directory. These include:
hole_in_one.pyto perform frequency analysis on turn by turn BPM data and infer optics (and more) for a given accelerator.kmod_importer.pyto average, import and calculate lumi-imbalace K-modulation results.knob_extractor.pyto extract fromNXCALSthe value of given knobs in the machine at a given time.model_creator.pyto generate optics models required for optics analysis.global_correction.pyto calculate corrections from measurement files.response_creator.pyto provide correction response files.tbt_converter.pyto convert different turn by turn data types toSDDS, potentially adding noise.amplitude_detuning_analysis.pyto perform amp. det. analysis on optics data with tune correction.madx_wrapper.pyto start aMAD-Xrun with a file or string as input.
Plotting Scripts
Plotting scripts for analysis outputs can be found in /omc3/plotting:
plot_spectrum.pyto generate plots from files generated by frequency analysis.plot_bbq.pyto generate plots from files generated by BBQ analysis.plot_amplitude_detuning.pyto generate plots from files generated by amplitude detuning analysis.plot_optics_measurements.pyto generate plots from files generated by optics_measurements.plot_tfs.pyall-purpose tfs-file plotter.plot_kmod_results.pyto plot the beta and waist of the K-modulation results.
Other Scripts
Other general utility scripts are in /omc3/scripts:
update_nattune_in_linfile.pyto update the natural tune columns in the lin files by finding the highest peak in the spectrum in a given interval.write_madx_macros.pyto generateMAD-Xtracking macros with observation points from a TWISS file.merge_kmod_results.pyto 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.pyto create a fake measurement based on a model TWISS file.betabeatsrc_output_converter.pyto convert outputs from our old codes toomc3's new standardized format.linfile_clean.pyto automatically clean given columns in lin files.kmod_average.pyto calculate the average of multiple K-modulation measurements.kmod_import.pyto import a K-modulation measurement into an optics-measurement directory.kmod_lumi_imbalace.pyto calculate the luminosity imbalance between two IPs from averaged K-modulation files.bad_bpms_summary.pyto collect and summarise the bad BPMs from GUI runs.resync_bpms.pyto perform re-synchronisation of SuperKEKB BPMs data after a first optics analysis.
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.
1 maintainer
Metadata
1 maintainer
Release files for omc3 0.29.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| omc3-0.29.0.tar.gz | 17.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| omc3-0.29.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 35.4 MB
Release files / omc3-0.29.0.tar.gz
| Download URL | omc3-0.29.0.tar.gz |
|---|---|
| Size | 17.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb0da73edd5b6ffc0ab5cd792a22c31db48f965e2688feb0c014fb5e73667af9
|
|
BLAKE2b-256 checksum How to use checksums |
ca3a8e099b71b12a713d0f2bcfbe88a84ed30880f037280788589283842f3c94
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / omc3-0.29.0-py3-none-any.whl
| Download URL | omc3-0.29.0-py3-none-any.whl |
|---|---|
| Size | 17.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9ee63b23d266268da0c97d6274d81f507af752df888e2466ebfa632e14f28aba
|
|
BLAKE2b-256 checksum How to use checksums |
78e7167fdad3be062df5fad2ec49bca16c46f6e8ff6cd73557f30ad325906490
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
