Server icon About kamzik3

Kamzik3 is a modular and lightweight experiment control framework written in Python3.

It is focused on minimalist yet unified way to control and orchestrate wide range of devices used in experimental setup.

It uses ZeroMQ to exchange messages between server and clients. Qt5 is used for the graphical interface. Kamzik3 provides tools for logging, visualizing and evaluation of experimental data. Users can create and execute custom macros and scans using the built-in macro-server.

The experimental setup is defined in one configuration file written in YAML, human-readable data serialization standard.

The framework can be downloaded from PyPI (https://pypi.org/project/kamzik3/).

The project page with git repository, change log, list of dependencies etc. can be found at https://gitlab.desy.de/cfel-sc-public/kamzik3.

Example experiment

Copy the content of the /example folder into a writable directory of your choice. Choose that directory as a working directory.

Server icon Start the server:

python server.py

Client icon Start the client:

python client.py

Optionally, you can start the listener:

python listener.py

Templates for the user interface

Many templates are already available for the user interface. You can modify them using Qt designer.

Configuration files

One config file must be provided for each server and another one for the client.

API Documentation

Documentation of the modules included in kamzik3.

Indices and tables