After the full installation, you can start srsinst.rga application
by typing one of the following commands from the command prompt.
If you installed it with a virtual environment, activate the virtual environment
before stating srsinst.rga.
# If python/script directory is in PATH setting,rga# If not,python-msrsinst.rga
The initial window looks like the image
in the previous page, if srsinst.rga is started with the default rga project.
srsinst.rga GUI application is simply the srsgui application running
with a configuration file including
RGA100 class
and supporting RGA tasks. The application section of srsgui
gives general description on how to use the application.
Srsinst.rga starts with the last configuration file it used when closed.
Note that the configuration file name is printed in the console dock window,
when the application starts. Unless you loaded another configuration file
after installation, it is the default configuration file, rga.taskconfig
in the default Pyhon library directory\site-packages\srsinst\rga
for Windows computers.
If you want to use a different configuration, you can change a configuration file
by select one from the menu/File/Open Config.
You can connect to an RGA by selecting one of the instrument names from the menu/Connect.
If the RGA is connected, it will pop up a dialog box asking if you want to disconnect.
If the RGA is disconnected, it will pop up a dialog box for connection.
The connection dialog box is simply a GUI wrapper for the connection method of the Instrument class shown in
Connection section in the instrument driver
Once an RGA is connected, the Instrument Info panel will be populated with the instrument status info,
which displays the return string of rga.get_info() method.
Once an RGA is connected, you can query and send commands from the terminal.
If you do not see the terminal window, you can bring it up to the top by selecting
the menu/Docks/Terminal.
From the terminal, you can use both the raw remote commands of an RGA and the commands in Rga100 class.
When you type “help” from the terminal, it displays details on how to use commands in the terminal.
Following shows interaction with an RGA from the terminal window.
# type the first part of each line into the terminal input and press "Send" button
# using RGA raw command
id? ==> SRSRGA200VER0.01SN01008
mi? ==> 1
mi2
mi? ==> 2
# with instrument specifier incase you use multiple instrument2
rga:mi? ==> 2
rga2:id? ==> SRSRGA100VER0.01SN01023
# RGA100 instrument class command
rga.status.id_string ==> SRSRGA320VER0.01SN01008
rga.scan.initial_mass ==> 2
rga.scan.initial_mass=1
rga.scan.initial_mass ==> 1
You can run all the code blocks shown in navigating through RGA100 class
from the terminal (well, no pprint. Only attributes and methods of the instrument
defined in the configuration file).
Another way to interact with an RGA is through the capture dock widget. You can open or bring
the capture dock widget to the top by select the rga-Capture menu item from the menu/Docks.
Pressing the Capture button will query all the commands in the class, and update the display them
in the tree structure. Double-clicking on a value allow you to change the value.
Enabling Show method option will display class methods associated with the components.
Some simple methods without a return value can have the run button.
Pressing the run button the methods can run from the capture dock widget.
The capture dock widget is a convenient way to look through command values of the instrument at a glance.
However, its continuous update generates a lot of communication with the instrument.
The item values does NOT get updated or changed reliably while a scan is running in a task.
A simple function of an instrument are implemented as a command or a method in a component.
It can be run from the terminal widget or capture dock widget. A Bigger and complex task, however,
may need hundreds of lines of code with combination of multiple
commands and methods of multiple components of multiple instruments.
Such a task can be implemented as a subclass of
Task class and included as a separate item in the menu/Tasks.
The default task configuration file, rga.taskconfig, contains the following tasks for basic RGA operations.
