runPyDM
For conceptual usage, see:
- pyrogue.pydm.runPyDM(serverList='localhost:9090', ui=None, display=None, display_factory=None, title=None, sizeX=800, sizeY=1000, maxListExpand=5, maxListSize=100, linkTimeout=10.0, requestStallTimeout=None, enableTerminal=False, enableIPython=False)[source]
Launch the default Rogue PyDM application.
- Parameters:
serverList (
str, default:'localhost:9090') – Comma-separated list ofhost:portRogue servers.ui (
str|None, default:None) – Optional UI file path. Defaults topydmTop.pyin this package if neitherdisplaynordisplay_factoryis supplied.display (
type[Display] |None, default:None) – Optional top-levelpydm.Displaysubclass to instantiate directly.display_factory (
Callable[...,Display] |None, default:None) – Optional factory that returns apydm.Displayinstance.title (
str|None, default:None) – Optional window title. Defaults to"Rogue Server: <servers>".sizeX (
int, default:800) – Initial window width in pixels.sizeY (
int, default:1000) – Initial window height in pixels.maxListExpand (
int, default:5) – Debug-tree auto-expand depth argument forwarded to the UI.maxListSize (
int, default:100) – Debug-tree list-size cap argument forwarded to the UI.linkTimeout (
float, default:10.0) – Idle timeout in seconds for VirtualClient link-state detection. This is the normal tuning knob for long-running hardware or simulation transactions and defaults to 10 seconds.requestStallTimeout (
float|None, default:None) – In-flight request age in seconds before the VirtualClient declares the server stalled.Nonedisables stalled-request detection, which is usually the right default unless the application has a strict upper bound for valid request duration.enableTerminal (
bool, default:False) – Add a local shell terminal tab beside the system log in theSystemtab. Defaults toFalse. When enabled the GUI exposes an interactive shell running as the user who launched the GUI, on the machine displaying the GUI, not on the Rogue server.enableIPython (
bool, default:False) – Add anIPythontab holding an interactive session with a connectedpyrogue.interfaces.VirtualClientbound asclientand the tree root asroot. Defaults toFalse. Independent ofenableTerminal. When enabled the GUI exposes arbitrary Python execution as the user who launched the GUI, on the machine displaying the GUI, not on the Rogue server.
- Returns:
This function runs the Qt event loop until the application exits.
- Return type:
Notes
Do not instantiate a plain
qtpy.QtWidgets.QApplicationbefore callingrunPyDM.runPyDMconstructs apydm.PyDMApplication, which must be the soleqtpy.QtWidgets.QApplicationin the process so PyDM’s window-management hooks (XSynccounter updates and_NET_WM_PINGreply registration) attach to the visible windows. Constructing a plainqtpy.QtWidgets.QApplicationfirst leaves PyDM’s hooks bound to a stub instance and the visible windows fail to reply to the compositor’s ping/sync messages, leading to spurious “not responding” warnings (notably under GNOME-on-Wayland with XWayland).runPyDMdetects this case and raisesRuntimeError.