|
|
# TuneX Requirements
|
|
|
|
|
|
|
|
|
* Requires write access to a `data` directory. This directory must be accessible from control room consoles.
|
|
|
|
|
|
* Must include a beampath-selection utility to allow users to quickly select a beampath and tune combination.
|
|
|
|
|
|
* Once a beampath/tune has been selected, the app shall only prompt the user for beam parameters that could potentially be relevant to that tune.
|
|
|
|
|
|
* When a user enters the desired beam parameters, the app shall perform error checks to ensure that the desired beam parameters are valid and within the machine specifications. The app shall generate error messages should one or more beam parameters be invalid.
|
|
|
|
|
|
* The `Loader` portion of the app should include an option to set all calculated device setpoints directly from the web app, with the exception of devices designated as 'read-only'.
|
|
|
|
|
|
* When loading a tune, `Loader` shall compare values with the live device parameters from the control system, providing a list of parameters, desired setpoints, and current device setpoints. Device setpoints differing from the desired setpoints by more than 0.1% shall be highlighted.
|
|
|
|
|
|
* The `Display` portion of the app shall graphically display the differences between the calculated tune setpoints and the live device parameters from the control system. The 'differences' displayed should be an accurate representation of the magnitude of a deviation from a known 'best-value'.
|
|
|
|
|
|
* The app will display periodic and matching section devices differently.
|
|
|
|
|
|
* `Display` will show all devices consecutively as they appear in the beam path, and include section labels, which will provide the user with a understanding of where in the path they are looking without filling the screen with text.
|
|
|
|
|
|
* `Display` will allow for mouse-over information of all devices displayed, including the device name, calculated setpoint, current setpoint, and deviation.
|
|
|
|
|
|
* `Display` will show three different types of devices differently for easy user identification: focusing devices (quads, solenoids, einzel lens, etc), steering devices (dipoles, steerers), and RF (accelerators, bunchers).
|
|
|
|
|
|
* `Display` will include options to show or hide any combination of the three device types (focusing devices, steering devices, and RF).
|
|
|
|
|
|
* `Display` will allow multiple users to compare different paths/tunes at the same time without interference. |