3 - GUI

This is the graphical user interface wrapper for ``omc3`, our 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

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

Installing

Installation is easily done via pip:

pip install omc3_gui

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_gui
pip install --editable "omc3_gui[all]"

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

Functionality

Main Scripts

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

• .py Nothing here yet.

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE v3 License - see the LICENSE file for details.