Skip to content

Add section detailing performance improvements to documentation #3911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shroffk merged 4 commits into from
Aug 19, 2026
+20 −7
Merged

Add section detailing performance improvements to documentation #3911

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f2475e
Document ways to improve display performance and update rates
rjwills28 Aug 10, 2026
b62da92
Reword performance section in documentation
rjwills28 Aug 19, 2026
47c2366
Fix lint errors in modified file
rjwills28 Aug 19, 2026
9226ed3
Clarify the OS that performance improvements have been tested on
rjwills28 Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions docs/source/running.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ From the command-line, invoke ``phoebus.sh -help``, which will look
similar to this, but check your copy of CS-Studio/Phoebus
for the complete list::

_______ _______ _______ ______ _______
_______ _______ _______ ______ _______
( ____ )|\ /|( ___ )( ____ \( ___ \ |\ /|( ____ \
| ( )|| ) ( || ( ) || ( \/| ( ) )| ) ( || ( \/
| (____)|| (___) || | | || (__ | (__/ / | | | || (_____
| (____)|| (___) || | | || (__ | (__/ / | | | || (_____
| _____)| ___ || | | || __) | __ ( | | | |(_____ )
| ( | ( ) || | | || ( | ( \ \ | | | | ) |
| ) | ) ( || (___) || (____/\| )___) )| (___) |/\____) |
|/ |/ \|(_______)(_______/|/ \___/ (_______)\_______)

Command-line arguments:

-help - This text
-splash - Show splash screen
-nosplash - Suppress the splash screen
Expand Down Expand Up @@ -74,12 +74,12 @@ be interpreted by the Linux shell, best enclose all resources in quotes.

Open probe with a PV name::

phoebus.sh -resource "pv://?sim://sine&app=probe"
phoebus.sh -resource "pv://?sim://sine&app=probe"


Open PV Table with some PVs::

phoebus.sh -resource "pv://?MyPV&AnotherPV&YetAnotherPV&app=pv_table"
phoebus.sh -resource "pv://?MyPV&AnotherPV&YetAnotherPV&app=pv_table"

Note that all these examples use the internal name of the application feature,
for example "pv_table", and not the name that is displayed the user interface,
Expand Down Expand Up @@ -112,10 +112,23 @@ For this scenario, invoke ``phoebus.sh`` with the ``-server`` option, using
a TCP port that you reserve for this use on that computer, for example::

phoebus.sh -server 4918

The first time you start phoebus this way, it will actually open the main window.
Follow-up invocations, for example::

phoebus.sh -server 4918 -resource "/path/to/some/file.pvs"

will contact the already running instance and have it open the requested file.


Performance
-----------

Phoebus displays are built on JavaFX, which will use hardware acceleration wherever possible. If your screen contains PVs with high update rates and you notice that the display is not keeping up then you may benefit from using the following environment and Java options::

export __GL_SYNC_TO_VBLANK=0
export _JAVA_OPTIONS="-Dprism.vsync=false"

These settings allow the display to update without waiting for the :abbr:`vblank (vertical blanking interval)` meaning that the monitor's refresh rate is ignored and display updates occur as fast as possible.

Note: these options will only make a difference when running on a dedicated GPU and have only been tested on Linux operating systems.
Loading