The Beta-Beat GUI¶
The Beta-Beat GUI provides different functionalities separated in multiple views, in the form of a graphical interface. The GUI can be ran locally, provided you have access to afs
, but most importantly directly from the CERN Control Center. This section provides a short overview for the main features.
Info
The gitlab CI automatically generates an API documentation page based on the source code.
(A legacy version for the BetaBeat.src
branch is also available.)
One would usually start with setting up the GUI via:
- Defaults to set some default values right from the start of the GUI.
- The Beam Selection Window to set the beam, paths and the
python
binary to use. - The Settings Window to set additional options for the GUI and analysis.
The GUI provides several panels, each for a defined use and with a set of options and results:
- The BPM Panel for loading measurements files, displaying data and launching analysis.
- The Analysis Panel to display and manipulate the results of harmonic analysis on measurement data.
- The Optics Panel to compare computed optics to nominal models.
- The Correction Panel to display the computed necessary corrections to reach the nominal model.
- The Amplitude Detuning Panel for amplitude detuning analysis.
some GUI elements are shared between different panels, and are described in the Common Components section, in particular, information with regards to the shared plotting backend can be found there.
This site will guide you through the GUI's layout and functionality. For starters, check out the basics of running the GUI.
The main focus of this documentation is the version that uses the omc3
package. For some additional information regarding the legacy BetaBeat.src
version, see the dedicated page.
Bug Reporting
If you find bugs, please create issues with the OMC3-GUI
label.