Skip to main content

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

Project description

3

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

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 favorite 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

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 analyze data from K-modulation and return the measured optics functions.
  • tbt_converter.py to convert different turn by turn data types to SDDS, potentially adding noise.
  • amplitude_detuning_analysis.py to perform amp. det. analysis on optics data with tune correction.
  • knob_extractor.py to extract from NXCALS the value of given knobs in the machine at a given time.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omc3-0.6.0.tar.gz (20.4 MB view details)

Uploaded Source

Built Distribution

omc3-0.6.0-py3-none-any.whl (20.8 MB view details)

Uploaded Python 3

File details

Details for the file omc3-0.6.0.tar.gz.

File metadata

  • Download URL: omc3-0.6.0.tar.gz
  • Upload date:
  • Size: 20.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for omc3-0.6.0.tar.gz
Algorithm Hash digest
SHA256 0f793f4ff4c26cc7014e904399dedd7b8ab130872d56fe1ef981d19af54cfb4a
MD5 9df1c39b2799f07bc7ff2413be2fffb6
BLAKE2b-256 0e6ba99a984d441e489523125a2ee174438bca23c81f82144e8e9171235a8070

See more details on using hashes here.

File details

Details for the file omc3-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: omc3-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 20.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for omc3-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcb9d7f5d64f4a8d4b786dc320305912d93bd4a80af6480aaf72eabbfb0df7b0
MD5 f8ef7896c4f5e1d939a32fe93cfaa5a9
BLAKE2b-256 c86e1a5bdb1aca47ccd9a944d6d1a6b707cf2a9f1e5f34080f13c24b6f97bd6c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page