Karabo Developer WorkshopOn-Site

Friday 1 Mar 2024, 09:00 → 17:00 Europe/Berlin

E1.173 (European XFEL)

The aim of this workshop is to enable EuXFEL staff members and guests to contribute to the Karabo control system by writing macros, middle-layer devices or GUI extensions.

The workshop participants are required to have already some experience with Karabo. Depending on the sessions, additional requirements apply. Therefore, registration can be done for a subset of the sessions.

Participants are required to bring their laptops enabled to access the EuXFEL WLAN. 

2024_Mar_karaboWorkshop_intro.pdf

2024_Mar_karaboWorkshop_intro.pptx

howto_visa_karabo.pdf

VISA

Session 1: Writing a Simple Procedure in Karabo

Learn and exercise how to write a Karabo macro.

Prerequisites:
- Experience with using Karabo
- Python coding experience.

1 Introduction

Speaker: Anna Klimovskaia (Eur.XFEL (European XFEL))

2 Hands-On

Speaker: Anna Klimovskaia (Eur.XFEL (European XFEL))

Session1.odp

Session1.pdf

Session1_win.pptx

10:30 Coffee Break

Session 2: Writing and Maintaining a Middle-Layer Karabo Device

A Karabo Middlelayer device can do all a macro can - and more.
Moreover, it can be configured and its code is versioned. Therefore, an established procedure should be converted to a device.

Prerequisites:
- Experience from writing a Karabo macro (e.g. from previous session)

3 Introduction

Speaker: Gero Flucke (Eur.XFEL (European XFEL))

2024_Mar_karaboWorkshop_device.pdf

2024_Mar_karaboWorkshop_device.pptx

4 Hands-On

Speaker: Gero Flucke (Eur.XFEL (European XFEL))

session2_copypaste.txt

13:00 Lunch

Session 3: Handling Fast Data through Pipelines

Fast and/or big data like camera images or digitzer data is handled in Karabo via so called Data Pipelines. Although usually part of the schema of a device, this data is handled differently than control and slow data.
This session will introduce pipeline data handling in the Karabo middlelayer API.

Prerequisite:
- Experience with writing a middlelayer Karabo device, e.g. from the previous session.

5 Introduction

Speaker: Raul Costa (Eur.XFEL (European XFEL))

KaraboWorkshopPipelines_2024.odp

KaraboWorkshopPipelines_2024.pdf

6 Hands-On

Speaker: Raul Costa (Eur.XFEL (European XFEL))

15:00 Coffee Break

Session 4: Writing Karabo GUI extensions

The Karabo GUI provides a plethora of widgets that can be used on scenes to customize user interaction with devices.
On top of that, GUI extension allow to implement custom GUI widgets and make them available without the need to wait for a new GUI release. Moreover, specialized GUI widgets can interact with Karabo device to implement a wide range of features.

7 Introduction

Speaker: Ivars Karpics (Eur.XFEL (European XFEL))

8 Hands-On

Speaker: Ivars Karpics (Eur.XFEL (European XFEL))

2024_karabo_workshop_extensions.odp

2024_karabo_workshop_extensions.pdf

• Karabo scenes: https://rtd.xfel.eu/docs/karabo/en/latest/library/gui_scene_development.html
• GUI Extensions: https://rtd.xfel.eu/docs/gui-extensions/en/latest/install_latest_version.html
• Qt: https://doc.qt.io/qt-5/qtwidgets-index.html , https://doc.qt.io/qt-5/qtwidgets-module.html
• Qt designer: designer
• PyQt graph: https://www.pyqtgraph.org/
• pyqtgraph examples:     python -m pyqtgraph.examples