4.4.1. Download, Compilation, and Running

This document guides the user on the creation of a new Demo Service Client, using Python, WAF modules, Qt, Taurus and CUT plugins. As this is a programming tutorial, you will produce file and code as instructed. You can also download a finalized version of the code from https://gitlab.eso.org/ecos/cut/-/tree/master/examples/, so our first step will be to download it.

$ git clone https://gitlab.eso.org/ecos/cut

$ mv cut/examples/demo_service_client ./
$ rm -rf cut

The directory we will be using for this tutorial is the demo_service_client, and it contains the code for a Python application. This is a waf project on its own, so it can be build in an independent manner from the rest of Control UI Toolkit. In order to do so, the reader must execute:

$ cd demo_service_client
$ waf configure install

And to execute the application:

$ cutDemoServiceClient

Demo Service Client: The application will include these elements

4.4.2. Project Structure

This is the structure of the project. We use as build system WAF, and on top wtools extension to make ELT application definition easier:

demo_service_client
├── client
│   ├── src
│   │   ├── cut
│   │   │   └── examples
│   │   │       └── demo_service_client
│   │   │           ├── __init__.py
│   │   │           ├── applicationconfiguration.py
│   │   │           ├── mainwindow_ui.ui
│   │   │           └── mainwindowcontroller.py
│   │   └── cutdemoserviceclient.py
│   └── wscript
└── wscript

4.4.2.1. Project wscript

The first file we should take a look is demo_service_client/wscript:

#!/usr/bin/env python3
import os
from wtools.project import declare_project


def configure(cnf):
    # We check which version of qt6 is requested and set the proper feature for later
    if hasattr(cnf, "want_qt6") and cnf.want_qt6 is True:
        cnf.check_python_module("PySide6")
    else:
        cnf.check_python_module("PySide2", condition="ver >= num(5, 14, 1) and ver < num(6, 0, 0)")
    cnf.check_python_module("taurus")
    cnf.check_python_module("elt.cut")
    cnf.check_python_module("CutWidgets")
    cnf.check_python_module("tauruscii")
    cnf.check_python_module("taurusmal")


def qtcallable(cnf):
    # We can do some checks here, for example to discriminate between Qt6 and Qt5:
    if os.environ.get("ELT_RELEASE", "6").startswith("6"):
        return dict(version=6)
    else:
        return dict(version=5)


declare_project(
    "DemoServiceClient",
    version="3.1.10-rc1",
    requires=["cxx", "qt", "python", "pyqt"],
    recurse="client",
    qt=qtcallable,
)

In contrast to what has been shown in the Python Application Tutorial, extra python module checks for tauruscii and taurusmal have been added. These modules provides the OLDB and MAL RR plugins for Taurus.

The rest of the project structure has not been changed.