Skip to content

The OMC3 Software Documentation

The omc3 package is the python tool of the Optics Measurements and Corrections team at CERN. The omc3 repository is the new version of our codes, refactored and rewritten for Python 3.7+.

Info

This section acts as a general documentation and guide to using the omc3 package. The package's source can be found on Github and its API documentation can be found at the following link.

Installing

Installation is easily done via pip: 

python -m pip install omc3

Additionally, some features require access to the CERN Technical Network and require CERN-specific dependencies. Those are installable from the CERN Acc-Py index through the cern extra, and can be installed from the CERN network or by providing the index-url: 

python -m pip install --index-url http://acc-py-repo.cern.ch:8081/repository/vr-py-releases/simple --trusted-host acc-py-repo.cern.ch "omc3[cern]"

What to expect

The omc3 package serves the following purposes:

  • Providing an all-in-one package for frequency analysis and optics measurements and corrections algorithms in particle accelerators.
  • Providing an easily callable entrypoint to run your analytics from measurement / simulation files.
  • Providing a convenient wrapper to effortlessly run MAD-X jobs.

For installation instructions and detailed content see the getting started guide. For a step by step walk-through of an omc3 analysis workflow, see the workflow guide.

License

This software is licensed under the MIT License, see License.

Authors

This work is the result of combined efforts by members of the pylhc/omc-team working group. Contributions are welcome, but tightly controlled, see the guidelines page.