Search/Navigation:
Related:
SLAC/EPP/HPS Public
Jefferson Lab/Hall B/HPS Run Wiki
S30XL-LESA/LDMX
The HPS Monitoring Application is a Java Swing GUI application which provides an online data monitoring framework for the experiment.
The application is part of the HPS Java project, so the Installing HPS Java instructions should be followed to build it.
You may also find an hps-distribution jar using a Nexus repository search and download it through the web interface.
The application is activated through its main method and takes only one command line argument, which is the name of a settings properties file.
java -jar hps-distribution-bin.jar org.hps.monitoring.application.Main -c settings.prop
The settings files are not typically hand edited but created by saving settings from the GUI's menu.
Label | Name | Description |
---|---|---|
1 | Application Menu Bar | contains menus with commands |
2 | Status Panel | application's current status (connected or disconnected) |
3 | Date Panel | shows when status last changed |
4 | Control Buttons | used to connect, disconnect, pause, continue, etc. |
5 | Data Source | available data sources (files or ET) |
6 | Event Dashboard | statistics for the current session |
7 | System Status Monitor Tab | system status monitoring tables (for alarms) |
8 | Log Tab | list of application log messages |
9 | Trigger Diagnostics | shows trigger diagnostics info when the right Driver is active in the job |
10 | Plot Panel | shows the current set of plots in the session |
11 | Plot Info Panel | shows information about the currently selected plot |
You can start a new monitoring session by clicking on the connect button in the GUI.
When the application is disconnected, as it will be just after starting up, the button will look like this.
Clicking the button will connect a new session using the currently configured settings.
After connecting, the button's appearance will change.
Settings can be saved under Save Settings in the Settings menu.
Previously saved settings may also be loaded in the application under Load Settings in the Settings menu. You should give these files the extension of .prop to indicate that they are Java properties files. The settings will not take effect until a new session is started. If there is a currently active session, it will not be affected.
Configuring Settings
Settings can be configured in the GUI by clicking on Open Settings Window under the Settings menu.
The first tab contains settings for configuring the application's connection to an ET server.
Setting | Description | Notes |
---|---|---|
ET Name | name of the ET buffer file | |
Host | ET server's TCP/IP hostname | |
Port | port for connection to server | |
Blocking | block when reading from ET system | usually should be deselected |
Verbose | run ET station in verbose mode | |
Station Name | the name of the ET station used by the monitoring application | should not exist already |
Chunk Size | number of chunks encoded together | typically one chunk corresponds with an EVIO event |
Queue Size | the queue (cue?) size | not sure what this means! |
Station Position | station's position in the chain of ET stations | |
Wait Mode | wait mode for when events are not immediately available | |
Wait Time | in timed Wait Mode, determines how long to wait for events before giving up |
Setting | Description | Notes |
---|---|---|
Steering File Resource | path to steering file jar resource | |
Steering File | path to steering file on disk | use the Select Steering File button to choose a file |
Steering Type | choose whether a file or resource is used | determines whether the Steering File or Steering File Resource value is used |
Processing Stage | limit event processing to a certain stage | event processing will be done up to and including the selected stage |
Detector Name | name of detector model | |
Detector Resources Directory | used to select a directory with detector resources | implements detector aliasing as the selected detector may override a known detector |
User Run Number | provide a run number to override those from the events | |
Conditions Tag | select a conditions tag for limiting returned conditions data | |
Freeze Detector Conditions | prevent conditions system from using run numbers in the data | may only be used when run number and detector are provided |
Max Events | max events to read before disconnecting | -1 means unlimited |
LCSim Event Builder | select the builder for creating LCSim events | default should be fine |
Disconnect on error | disconnect if there are any errors | |
Disconnect on end run | disconnect when run ends | |
Log to File | log messages to a file instead of the log table | |
Log File Name | log file name if logging to a file instead of the log table | |