Installation

Preparation

To install srsgui, make sure you have Python version 3.7 or later. you can check your Python version by running from the command line:

python --version

Note

Commands running from the command prompt shown here are assumed using a Windows computer system. If you use other systems, commands may be different. Refer to this page.

If you have a Python older than the required version, install a newer Python.

Using virtual environment avoids possible dependency conflict among Python packages. If you want to use a virtual environment, create one with your favorite virtual environment package. If you do not have a preference, use Python default venv.

python -m venv env
.\env\Scripts\activate

Note

Commands to use venv are different among computer systems. Other than Windows, refer to this page.

Srsgui installation

To run srsgui as a GUI application, install it with [full] option using pip:

python -m pip install srsgui[full]

It will install srsgui package along with the 3 main packages (pyserial, matplotlib and pyside6) and their dependencies.

If

  • you plan only to use the instrument driver part of srsgui package without GUI support,

  • your system requires to install matplotlib or pyside6 from sources other than pip (Some linux systems do so),

  • you want to use pyqt5 or pyside2 instead of pyside6 as GUI backend,

  • you have trouble with the full installation and you want to install dependency manually,

you can install without the extra [full] option:

python -m pip install srsgui

It will install srsgui with pyserial only.

Note

srsgui runs with either pyside6, pyside2 or pyqt5 installed as GUI backend. If your system already have pyside2 or pyqt5 installed, you do not have to install pyside6.

python -m pip show pyside2

python -m pip show pyqt5

will show if pyside2 or pyqt5 is installed.

Note

In order to maintain the MIT license for your projects or modified srsgui, you have to use pyside6 or pyside2. Note that pyqt5 imposes GPLv3 license to packages using pyqt5.

Running srsgui application

After srsgui is installed, you can start srsgui application from the command line

srsgui

or

python -m srsgui

srsgui installs a executable script named “srsgui” in Python/Scripts directory. If the directory is included in PATH environment variable, srsgui command will work. Otherwise, python -m srsgui will work regardless of PATH setting.

_images/initial-screen-capture.png

If you see the application is open and running, the installation is successful!

Note

Instead of seeing the application running, you may get errors, probably ImportError. Carefully look through the exception traceback to find out which package causes the error. When the latest python is installed, some packages may not install properly. If the problem is not from srsgui directly, web search of the problem usually leads to a fix.