karabo-sls-detectors 3.2.4

A Karabo device to control and acquire data from SLS detectors.

slsDetector Package

Overview

The slsDetector package provides a way to interface with SLS detectors in the Karabo control system. More information on the detectors can be found on this webpage:

https://www.psi.ch/en/lxn/documentation

Contact

For questions, please contact [e-mail].

License and Contributing

This software is released by the European XFEL GmbH as is and without any warranty under the GPLv3 license. If you have questions on contributing to the project, please get in touch at [e-mail].

Source Code

The sources for this project can be found at https://github.com/European-XFEL/Karabo-slsDetectors

Dependencies

The Karabo slsDetector package depends on slsDetectorPackage, which is the SDK provided by the SLS detector group under the LGPL-3.0 license.

• slsDetectorPackage v10.0.x

  https://github.com/slsdetectorgroup/slsDetectorPackage.git

Installing and Running from PyPI

The device can further be installed from PyPI and ships in the form of a self-hosting device server. All the needed libaries are grafted in, including the ones from slsDetectorPackage.

To install, run

pip install karabo-sls-detectors

To run, make sure you initially prepared a Karabo environment using

pip install karabo.services
karabo-activate --init-to PATH/TO/KARABO

and have activated that Karabo environment using

source PATH/TO/KARABO/activate

and then start the self-hosting server with

karabo-sls-detector-server [serverId=, ... karabo-cpp-server options]

Update to SLS Detector Software v5.0.1

In the SLS detector software, some of the parameters changed from v4.0.1 to v5.0.1. The Karabo device followed these changes, thus some of the keys have been renamed:

Old Key Name	New Key Name
bitDepth	dynamicRange
detectorIp	udpSrcIp
detectorMac	udpSrcMac
detectorNumber	serialNumber
detectorVersion	firmwareVersion
numberOfCycles	numberOfTriggers
rxUdpIp	udpDstIp
rxUdpPort	udpDstPort
softwareVersion	detServerVersion
thisVersion	clientVersion
vHighVoltage	highVoltage
vHighVoltageMax	highVoltageMax

The following parameters have been removed, as not available any more, or not available for the detectors we currently have at XFEL:

Removed Key Name
angConv
angDir
binSize
detectorDeveloper
flatFieldCorrectionFile
globalOff
lock
master
maximumDetectorSize
moveFlag
numberOfGates
online
sync
threaded

For some other properties the unit and type have changed:

Key Name	Old Unit	New Unit	Old Type	New Type
exposureTime	s	ns	FLOAT	INT64
exposurePeriod	s	ns	FLOAT	INT64
delayAfterTrigger	s	ns	FLOAT	INT64