Merge pull request #1125 from slsdetectorgroup/910/release_notes

release notes
This commit is contained in:
maliakal_d 2025-03-12 09:29:48 +01:00 committed by GitHub
commit a295208c12
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -7,15 +7,9 @@ This document describes the differences between v9.1.0 and v9.0.0
CONTENTS
--------
1 New, Changed or Resolved Features
1.1 Compilation
1.2 Callback
1.3 Python
1.4 Client
1.5 Detector Server
1.6 Simulator
1.7 Receiver
1.8 Gui
1 Changes
1.1 New or Changed Features
1.2 Resolved Features
2 On-board Detector Server Compatibility
3 Firmware Requirements
4 Kernel Requirements
@ -24,8 +18,8 @@ This document describes the differences between v9.1.0 and v9.0.0
1 New, Changed or Resolved Features
=====================================
1 Changes
==========
@ -33,11 +27,63 @@ This document describes the differences between v9.1.0 and v9.0.0
============================
Receiver
--------
* Frame Synchronizer (experimental)
Added a new binary, similar to slsMultiReceiver, to collect images from
several receivers and stream them out as a ZMQ multipart message
(one part for each UDP port). No reconstuction of the image. Includeds start
and end ZMQ messages as well for the start and end callback parameters.
Documentation
-------------
* Command line - multi module and multi detector indices
Help on this topic has been added to the 'Command line' topic.
* Row and column index (UDP header or callback)
Help on how this is determined from the hostname is added to the 'UDP
Header' and the 'Quick Start Guide' topics. Also added to the help in '
hostname' command line help. Please note that this can be overwritten by
corresponding row and column commands.
1.2 Resolved Features
======================
Firmware
---------
* [Jungfrau] Column select and filter resistor
Configuration fix for chip v1.1 for these parameters
Firmware &/ On-board Detector Server
------------------------------------
* [Jungfrau] Timing Info Decoder
Only allowed for hardware v2.0 now.
* [Jungfrau] Auto Comparator Disable - chip v1.0
Previously, this mode for chip v1.0 automatically disabled the on-chip
gain switching compatator after a fixed portion of the exposure time.
Now, one must set also the comparator disable time using 'compdisabletime'
just as in chip v1.1.
* [Mythen3] Default period on server start up is 0 now.
Client
-------
@ -48,6 +94,47 @@ This document describes the differences between v9.1.0 and v9.0.0
detector index on the 'config' or 'parameter' command instead.
* [Mythen3] patternX command autocompletes the argument to a path now.
Receiver
--------
* Multiple Receiver objects in multiple threads
slsMultiReceiver uses child processes, but if user rewrote to use multiple
receiver objects in multiple threads instead, a callback mutex is now
implemented to handle the locking mechanism between threads for the callbacks.
* Removed potentially unsafe str().c_str() calls.
ZMQ
---
* [Moench] Reduced significant print out in zmq processing using energy
threshold.
* [Moench] Zmq dummy packet restreaming command did nothing
Temporary solution was to move from 'stop' to 'rx_stop' as 'stop' did not
go further if module is idle.
* [Moench] Too many Zmq dummy packets- unclear end in acquire
Give time to process dummy packet before restreaming it and wait more
before restreaming to reduce amoutn of zmq dummy packets to process.
Simulators
-----------
* [Jungfrau][Moench] Slightly faster transmistting time by removing sleeping
only if there is a transmission delay
2 On-board Detector Server Compatibility
@ -56,7 +143,7 @@ This document describes the differences between v9.1.0 and v9.0.0
Eiger 9.0.0
Jungfrau 9.1.0
Mythen3 9.0.0
Mythen3 9.1.0
Gotthard2 9.0.0
Gotthard 9.0.0
Moench 9.0.0
@ -85,8 +172,8 @@ This document describes the differences between v9.1.0 and v9.0.0
Eiger 02.10.2023 (v32) (updated in 7.0.3)
Jungfrau xx.03.2025 (v1.6, HW v1.0) (updated in 9.1.0)
xx.03.2025 (v2.6, HW v2.0) (updated in 9.1.0)
Jungfrau 09.02.2025 (v1.6, HW v1.0) (updated in 9.1.0)
08.02.2025 (v2.6, HW v2.0) (updated in 9.1.0)
Mythen3 13.11.2024 (v2.0) (updated in 9.0.0)