updated RELEASE template

This commit is contained in:
mazzol_a committed 2026-11-18 15:45:22 +01:00
1 parent 442738d308
commit 4d1912e63e
1 file changed
+164 -191
+164 -191
View File
@@ -1,53 +1,25 @@
SLS Detector Package Minor Release 10.1.0 released on 2026-08-06
===============================================================
This document describes the differences between v10.1.0 and v10.0.0
This document describes the differences between v10.1.0 and v10.0.1
## Contents
1. [New, Changed or Resolved Features](#1-new-changed-or-resolved-features)
1. [Compilation](#11-compilation)
2. [Callback](#12-callback)
3. [Python](#13-python)
4. [Client](#14-client)
5. [Detector Server](#15-detector-server)
6. [Simulator](#16-simulator)
7. [Receiver](#17-receiver)
8. [Gui](#18-gui)
2. [On-board Detector Server Compatibility](#2-on-board-detector-server-compatibility)
3. [Firmware Requirements](#3-firmware-requirements)
4. [Kernel Requirements](#4-kernel-requirements)
5. [Download, Documentation & Support](#5-download-documentation--support)
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
2 On-board Detector Server Compatibility
3 Firmware Requirements
4 Kernel Requirements
5 Download, Documentation & Support
1 New, Changed or Resolved Features
=====================================
Building shared libraries is disabled by default. If you need to link
against any of the libSls*.so libraries, you can enable this by passing
-DSLS_BUILD_SHARED_LIBRARIES=ON to CMake.
Added SLS_USE_SYSTEM_ZMQ option (default OFF) to use the libzmq of the host
instead of the one included in our repo.
Experimental support for building the detector client (including python bindings) on macOS
``rx_dbitlist`` keeps the order of the passed bit list
Detector.pattern (python) accepts also a pattern object, not only a pattern file
added patternstart to python (ctb, xilinx_ctb , mythen3), only the detector class api was exposed (startPattern())
documentation for all branches and developer now online and build and pushed automatically
gui: mouse zooms not reset at start of acquisition
m3: fixed patwaittime in intervals, which is hardly used. patwaittime in clocks stays the same and working.
m3: getPatternFileName typo fixed
## 1 New, Changed or Resolved Features
support for building rpms
@@ -62,195 +34,196 @@ M3: threshold energy updated to -1 in receiver master file whenever it is set in
eiger seting vthreshold dac directly should change settings to undefined. done.
2 On-board Detector Server Compatibility
==========================================
### 1.1 Compilation
- Building shared libraries is disabled by default. If you need to link against any of the `libSls*.so` libraries, you can enable this by passing `-DSLS_BUILD_SHARED_LIBRARIES=ON` to CMake.
- Added `SLS_USE_SYSTEM_ZMQ` option (default `OFF`) to use the libzmq of the host instead of the one included in our repo.
- Experimental support for building the detector client (including python bindings) on macOS
- libfmt added to dependency
- support for building rpms
- documentation for all branches and developer now online and build and pushed automatically
Eiger 10.0.0
Jungfrau 10.0.0
Mythen3 10.0.0
Gotthard2 10.0.0
Moench 10.0.0
### 1.2 Callback
On-board Detector Server Upgrade
--------------------------------
### 1.3 Python
From v6.1.0 (without tftp):
update only on-board detector server
Using command 'updatedetectorserver'
- `Detector.pattern` (python) accepts also a pattern object, not only a pattern file
- added `patternstart` to python (ctb, xilinx_ctb, mythen3), only the detector class api was exposed (`startPattern()`)
- python dacs => using deprecated `np.int`. dacs return float (default dtype of numpy) => changed to `np.int32` (meant for v10.0.1)
### 1.4 Client
udpate both on-board detector server and firmware simultaneously
Using command 'update'
- m3: `getPatternFileName` typo fixed
- removed unused function `readDataFile`/`writeDataFile` from `file_utils.h`
- changed api: `datastream` => `udp_datastream`, `set/getDatastream` => `set/getUDPDatastream`; also implemetned for jungfrau, moench at receiver side (top/bottom)
- setting number of UDP interfaces can only be set at detector level and not at module level. (individual modules)
Instructions available at
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/serverupgrade.html
### 1.5 Detector Server
- m3: fixed `patwaittime` in intervals, which is hardly used. `patwaittime` in clocks stays the same and working.
### 1.6 Simulator
- can build virtual servers on mac OS
3 Firmware Requirements
========================
### 1.7 Receiver
Eiger 02.10.2023 (v32) (updated in 7.0.3)
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)
- `rx_dbitlist` keeps the order of the passed bit list
- added `rx_streamdummyheader` to send the zmq dummy header any time. Allows pre-configuring zmq processing before acq begins.
- allow disabling one UDP interface in the receiver.
- zmqsocket - allowing hwm to be set already at the constructor level. As before, can still be set after construction with socket reconnection.
Mythen3 13.11.2024 (v2.0) (updated in 9.0.0)
### 1.8 Gui
Gotthard2 03.10.2024 (v1.0) (updated in 9.0.0)
- gui: mouse zooms not reset at start of acquisition
Moench 26.10.2023 (v2.0) (updated in 8.0.2)
## 2 On-board Detector Server Compatibility
| Detector | Version |
|-----------|---------|
| Eiger | 10.0.0 |
| Jungfrau | 10.0.0 |
| Mythen3 | 10.0.0 |
| Gotthard2 | 10.0.0 |
| Moench | 10.0.0 |
Detector Upgrade
----------------
### On-board Detector Server Upgrade
The following can be upgraded remotely:
From v6.1.0 (without tftp):
Eiger via bit files
Jungfrau via command <.pof>
Mythen3 via command <.rbf>
Gotthard2 via command <.rbf>
Moench via command <.pof>
- update only on-board detector server
- Using command `updatedetectorserver`
- udpate both on-board detector server and firmware simultaneously
- Using command `update`
Except Eiger,
upgrade
Using command 'programfpga' or
Instructions available at
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/serverupgrade.html
udpate both on-board detector server and firmware simultaneously
Using command 'update'
## 3 Firmware Requirements
| Detector | Firmware Date | Version | Updated in |
|-----------|---------------|------------------|------------|
| Eiger | 02.10.2023 | v32 | 7.0.3 |
| Jungfrau | 09.02.2025 | v1.6, HW v1.0 | 9.1.0 |
| Jungfrau | 08.02.2025 | v2.6, HW v2.0 | 9.1.0 |
| Mythen3 | 13.11.2024 | v2.0 | 9.0.0 |
| Gotthard2 | 03.10.2024 | v1.0 | 9.0.0 |
| Moench | 26.10.2023 | v2.0 | 8.0.2 |
Instructions available at
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/firmware.html
### Detector Upgrade
The following can be upgraded remotely:
| Detector | Upgrade via |
|-----------|--------------------|
| Eiger | bit files |
| Jungfrau | command `<.pof>` |
| Mythen3 | command `<.rbf>` |
| Gotthard2 | command `<.rbf>` |
| Moench | command `<.pof>` |
Except Eiger,
4 Kernel Requirements
======================
- upgrade
- Using command `programfpga` or
- udpate both on-board detector server and firmware simultaneously
- Using command `update`
Instructions available at
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/firmware.html
Blackfin
--------
Latest version: Fri Oct 29 00:00:00 2021
Older ones will work, but might have issues with programming firmware via
the package.
## 4 Kernel Requirements
### Blackfin
Nios
-----
Compatible version: Mon May 10 18:00:21 CEST 2021
Latest version: Fri Oct 29 00:00:00 2021
Older ones will work, but might have issues with programming firmware via the package.
Kernel Upgrade
---------------
Eiger via bit files
Others via command
### Nios
Commands: udpatekernel, kernelversion
Instructions available at
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/commandline.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/detector.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/pydetector.html
Compatible version: Mon May 10 18:00:21 CEST 2021
### Kernel Upgrade
| Detector | Upgrade via |
|----------|-------------|
| Eiger | bit files |
| Others | command |
Commands: `udpatekernel`, `kernelversion`
5 Download, Documentation & Support
====================================
Instructions available at
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/commandline.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/detector.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/pydetector.html
Download
--------
The Source Code:
https://github.com/slsdetectorgroup/slsDetectorPackage
Documentation
-------------
Installation:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/installation.html
## 5 Download, Documentation & Support
Quick Start Guide:
https://slsdetectorgroup.github.io//10.1.0/quick_start_guide.html
### Download
Firmware Upgrade:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/firmware.html
- **The Source Code:**
- https://github.com/slsdetectorgroup/slsDetectorPackage
- **RPM Packages:**
- https://gitea.psi.ch/detectors/-/packages
Detector Server upgrade:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/serverupgrade.html
### Documentation
Detector Simulators:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/virtualserver.html
- **Installation:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/installation.html
- **Quick Start Guide:**
- https://slsdetectorgroup.github.io//{{VERSION}}/quick_start_guide.html
- **Firmware Upgrade:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/firmware.html
- **Detector Server upgrade:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/serverupgrade.html
- **Detector Simulators:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/virtualserver.html
- **Consuming slsDetectorPackage:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/consuming.html
- **Software Architecture:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/softwarearchitecture.html
- **Set up commands in config file:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/configcommands.html
- **Image Size and Output Characteristics:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/dataformat.html
- **API Examples:**
- https://github.com/slsdetectorgroup/api-examples
- **Command Line Documentation:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/commandline.html
- **C++ API Documentation:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/detector.html
- **C++ API Example:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/examples.html#
- **Python API Documentation:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/pygettingstarted.html
- **Python API Example:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/pyexamples.html
- **Receivers (including custom receiver):**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/receivers.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/slsreceiver.html
- **Detector UDP Header:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/udpheader.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/udpdetspec.html
- **Output Data:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/dataformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/fileformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/slsreceiverheaderformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/masterfileattributes.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/binaryfileformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/hdf5fileformat.html
- **slsReceiver Zmq Format:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/slsreceiver.html#zmq-json-header-format
- **TroubleShooting:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/troubleshooting.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/troubleshooting.html#receiver-pc-tuning-options
- **Further Documentation:**
- https://www.psi.ch/en/detectors/documentation
- **Info on Releases:**
- https://slsdetectorgroup.github.io/slsDetectorPackage/index.html
Consuming slsDetectorPackage:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/consuming.html
Software Architecture
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/softwarearchitecture.html
### Support
Set up commands in config file
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/configcommands.html
Image Size and Output Characteristics
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/dataformat.html
API Examples:
https://github.com/slsdetectorgroup/api-examples
Command Line Documentation:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/commandline.html
C++ API Documentation:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/detector.html
C++ API Example:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/examples.html#
Python API Documentation:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/pygettingstarted.html
Python API Example:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/pyexamples.html
Receivers (including custom receiver):
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/receivers.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/slsreceiver.html
Detector UDP Header:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/udpheader.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/udpdetspec.html
Output Data:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/dataformat.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/fileformat.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/slsreceiverheaderformat.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/masterfileattributes.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/binaryfileformat.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/hdf5fileformat.html
slsReceiver Zmq Format:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/slsreceiver.html#zmq-json-header-format
TroubleShooting:
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/troubleshooting.html
https://slsdetectorgroup.github.io/slsDetectorPackage/10.1.0/troubleshooting.html#receiver-pc-tuning-options
Further Documentation:
https://www.psi.ch/en/detectors/documentation
Info on Releases:
https://slsdetectorgroup.github.io/slsDetectorPackage/index.html
Support
-------
dhanya.thattil@psi.ch
erik.frojdh@psi.ch
alice.mazzoleni@psi.ch
- dhanya.thattil@psi.ch
- erik.frojdh@psi.ch
- alice.mazzoleni@psi.ch