9.2.0.rc (#1232)

* Python module is now built using scikit-build-core: Dev/scikitbuild #1164
* slsdet is available on PyPI from this release onwards
* Fixed broken import in typecaster.h #1181
* Dev/automate version number #1193
* Dev/automate version part2 #1209
* 9111: added expat to host section to fix conda #1216
* fix for gotthard.py to import slsdet properly
* added slsFramesynchronizer to conda copy_lib.sh
* version of release
* update version of client
* removed cmake <=3.28 that was added in 9.1.11 (main_library in meta.yaml in conda-recipes)
* added slsFrameSynchronizer binary to conda
* added numpy dependency to toml
* added documentation for pip in installation

Detailed Commits:
* skeleton pyproject.toml
* moved compiled extension into slsdet
* WIP
* WI{
* separated the recipes
* restored comments, cleanup
* cleaned meta yaml
* added back some python versions
* conda build of main library
* fixed typo
* removed conda build pin
* added zlib
* added workflow for python lib
* patching libzmq and cleaned up cmake
* removed compiler version
* switched patch tool
* reverted to scikit-build in pyproject.toml
* added sls_detector bin
* added sync, renamed action
* update cmake<=3.28 in conda build requirements
* Fixed broken import in typecaster.h (#1181)
- Fixed the broken import _slsdet --> slsdet._slsdet caused by a previous upgrade
- added tests that exercises the conversion from python to C++ and from C++ to python
- Python unit tests now run in CI (!)
* removed 3.28 restriction on cmake in meta.yaml
* from #1216 to 9.1.1.rc that got lost in merge from develoepr, added expat to host section to fix conda build
* back with the cmake restriction
* fixing gotthard1 import
* version number automated for python build
* mistakenly set version back to 0.0.0
* updated github workflow scripts to support automatic version numbering with environment variable
* managed to load VERSION file in yaml file - simplifies things
* saving changes in git workflow failed
* got typo in github workflow
* updatet regex pattern to support postfix
* normalized version to PEP 440 specification in update_version.py
* bug did not support version 0.0.0
* added regex pattern matching to version in toml file
* version now supports . before postfix
* updates api version based on version file & converted shell script files to python
* updated all makefiles
* adresses review comments
* updated release version and the api lib version
* raise an exception if the pull socket python script had errors at startup (for eg if pyzmq was not installed)
* cmake<=3.28 not required anymore
* updated documentation for pip installation as well
* 920/add numpy  (#1226)
* added numpy dependency
* aded build specifications for python version and platform
* release notes
---------
Co-authored-by: froejdh_e <erik.frojdh@psi.ch>
Co-authored-by: Fröjd Lars Erik <froejdh_e@pcmoench03.psi.ch>
Co-authored-by: Erik Fröjdh <erik.frojdh@gmail.com>
Co-authored-by: mazzol_a <mazzol_a@pc17378.psi.ch>
Co-authored-by: AliceMazzoleni99 <alice.mazzoleni@psi.ch>

.github/workflows/cmake.yaml

@@ -1,4 +1,4 @@
-name: CMake
+name: Native CMake Build
 
 on: [push, pull_request]
 
@@ -14,10 +14,16 @@ jobs:
     runs-on: ubuntu-latest
     name: Configure and build using cmake
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: 'pip'
+      - run: pip install pytest numpy
+
       - uses: awalsh128/cache-apt-pkgs-action@latest
         with:
-          packages: libhdf5-dev qtbase5-dev qt5-qmake libqt5svg5-dev
+          packages: libhdf5-dev qtbase5-dev qt5-qmake libqt5svg5-dev libpng-dev libtiff-dev
           version: 1.0
 
       - name: Configure CMake
@@ -27,12 +33,15 @@ jobs:
 
       - name: Build
         # Build your program with the given configuration
-        run: cmake --build ${{github.workspace}}/build -j2 --config ${{env.BUILD_TYPE}}
+        run: cmake --build ${{github.workspace}}/build -j4 --config ${{env.BUILD_TYPE}}
 
-      - name: Test
+      - name: C++ unit tests
         working-directory: ${{github.workspace}}/build
-        # Execute tests defined by the CMake configuration.
-        # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
         run: ctest -C ${{env.BUILD_TYPE}} -j1
 
+      - name: Python unit tests
+        working-directory: ${{github.workspace}}/build/bin
+        run: |
+          python -m pytest ${{github.workspace}}/python/tests
+
 

.github/workflows/conda_library.yaml

@@ -0,0 +1,42 @@
+name: Build slsdetlib
+
+on: [pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, ] # macos-12, windows-2019]
+        python-version: ["3.12",]
+
+    runs-on: ${{ matrix.platform }}
+
+    # The setup-miniconda action needs this to activate miniconda
+    defaults:
+      run:
+        shell: "bash -l {0}"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get conda
+        uses: conda-incubator/setup-miniconda@v3.0.4
+        with:
+          python-version: ${{ matrix.python-version }}
+          channels: conda-forge
+
+      - name: Prepare
+        run: conda install conda-build conda-verify pytest anaconda-client
+
+      - name: Disable upload
+        run: conda config --set anaconda_upload no
+
+      - name: Build
+        run: conda build conda-recipes/main-library --output-folder build_output
+
+      - name: Upload all Conda packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: conda-packages
+          path: build_output/**  # Uploads all packages

.github/workflows/conda_python.yaml

@@ -0,0 +1,42 @@
+name: slsdet
+
+on: [pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, ] # macos-12, windows-2019]
+        python-version: ["3.12",]
+
+    runs-on: ${{ matrix.platform }}
+
+    # The setup-miniconda action needs this to activate miniconda
+    defaults:
+      run:
+        shell: "bash -l {0}"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get conda
+        uses: conda-incubator/setup-miniconda@v3.0.4
+        with:
+          python-version: ${{ matrix.python-version }}
+          channels: conda-forge
+
+      - name: Prepare
+        run: conda install conda-build conda-verify pytest anaconda-client
+
+      - name: Disable upload
+        run: conda config --set anaconda_upload no
+
+      - name: Build
+        run: conda build conda-recipes/python-client --output-folder build_output 
+
+      - name: Upload all Conda packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: conda-packages
+          path: build_output/**  # Uploads all packages

CMakeFiles/cmake.check_cache

@@ -1 +0,0 @@
-# This file is generated by cmake for dependency checking of the CMakeCache.txt file

CMakeLists.txt

@@ -1,8 +1,16 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.15)
 project(slsDetectorPackage)
-set(PROJECT_VERSION 9.0.0)
+
+# Read VERSION file into project version
+set(VERSION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/VERSION")
+file(READ "${VERSION_FILE}" VERSION_CONTENT)
+string(STRIP "${VERSION_CONTENT}" PROJECT_VERSION_STRING)
+set(PROJECT_VERSION ${PROJECT_VERSION_STRING})
+
+# Pass it to the compiler
+add_compile_definitions(SLS_DET_VERSION="${PROJECT_VERSION}")
 
 set(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG")
 
@@ -21,20 +29,40 @@ include(FetchContent)
 option(SLS_FETCH_ZMQ_FROM_GITHUB "Fetch zmq from github" OFF)
 option(SLS_FETCH_PYBIND11_FROM_GITHUB "Fetch pybind11 from github" OFF)
 
+
+
+# Allow FetchContent_Populate to be called with a single argument
+# otherwise deprecated warning is issued
+# Note: From cmake 3.28 we can pass EXCLUDE_FROM_ALL to FetchContent_Declare
+# and avoid direct use of Populate
+if (${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.30")
+    cmake_policy(SET CMP0169 OLD) 
+endif()
+
+# Patch libzmq to set minimum cmake version to 3.15 to avoid warnings
+# with newer cmake versions
+# Patch is applied in the FetchContent_Declare
+set(SLS_LIBZMQ_VERSION "4.3.4")
+
+
 if(SLS_FETCH_ZMQ_FROM_GITHUB)
     # Opt in to pull down a zmq version from github instead of
-    # using the bundled verison
+    # using the bundled version
     FetchContent_Declare(
         libzmq
         GIT_REPOSITORY https://github.com/zeromq/libzmq.git
-        GIT_TAG        v4.3.4
+        GIT_TAG        v${SLS_LIBZMQ_VERSION}
+        PATCH_COMMAND ${CMAKE_COMMAND} -E chdir <SOURCE_DIR> patch -p1 < ${CMAKE_CURRENT_SOURCE_DIR}/libs/libzmq/libzmq_cmake_version.patch
+        UPDATE_DISCONNECTED 1
     )
 else()
     # Standard behaviour use libzmq included in this repo (libs/libzmq)
     FetchContent_Declare(
         libzmq
-        URL ${CMAKE_CURRENT_SOURCE_DIR}/libs/libzmq/libzmq-4.3.4.tar.gz
+        URL ${CMAKE_CURRENT_SOURCE_DIR}/libs/libzmq/libzmq-${SLS_LIBZMQ_VERSION}.tar.gz
         URL_HASH MD5=cc20b769ac10afa352e5ed2769bb23b3
+        PATCH_COMMAND ${CMAKE_COMMAND} -E chdir <SOURCE_DIR> patch -p1 < ${CMAKE_CURRENT_SOURCE_DIR}/libs/libzmq/libzmq_cmake_version.patch
+        UPDATE_DISCONNECTED 1
     )
 endif()
 
@@ -46,6 +74,11 @@ set(ENABLE_CPACK OFF CACHE BOOL "")
 set(ENABLE_CLANG OFF CACHE BOOL "")
 set(ENABLE_CURVE OFF CACHE BOOL "")
 set(ENABLE_DRAFTS OFF CACHE BOOL "")
+set(ENABLE_PRECOMPILED OFF CACHE BOOL "")
+set(WITH_DOC OFF CACHE BOOL "")
+set(WITH_DOCS OFF CACHE BOOL "")
+
+ 
 
 # Using GetProperties and Populate to be able to exclude zmq
 # from install (not possible with FetchContent_MakeAvailable(libzmq))
@@ -183,7 +216,7 @@ endif()
 # to control options for the libraries
 if(NOT TARGET slsProjectOptions)
     add_library(slsProjectOptions INTERFACE)
-    target_compile_features(slsProjectOptions INTERFACE cxx_std_11)
+   target_compile_features(slsProjectOptions INTERFACE cxx_std_11)
 endif()
 
 if (NOT TARGET slsProjectWarnings)
@@ -241,8 +274,8 @@ endif()
 if(SLS_USE_SANITIZER)
     target_compile_options(slsProjectOptions INTERFACE -fsanitize=address,undefined -fno-omit-frame-pointer)
     target_link_libraries(slsProjectOptions INTERFACE -fsanitize=address,undefined)
-    # target_compile_options(slsProjectOptions INTERFACE -fsanitize=thread)
-    # target_link_libraries(slsProjectOptions INTERFACE -fsanitize=thread)
+    #target_compile_options(slsProjectOptions INTERFACE -fsanitize=thread -fno-omit-frame-pointer)
+    #target_link_libraries(slsProjectOptions INTERFACE -fsanitize=thread)
 endif()
 
 
@@ -296,19 +329,20 @@ if (SLS_USE_INTEGRATION_TESTS)
 endif (SLS_USE_INTEGRATION_TESTS)
 
 if (SLS_USE_PYTHON)
-    find_package (Python 3.6 COMPONENTS Interpreter Development)
+    find_package (Python 3.8 COMPONENTS Interpreter Development)
     if(SLS_FETCH_PYBIND11_FROM_GITHUB)
         FetchContent_Declare(
             pybind11
             GIT_REPOSITORY https://github.com/pybind/pybind11
-            GIT_TAG        v2.11.0
+            GIT_TAG        v2.13.6
         )
 
     else()
+    # https://github.com/pybind/pybind11/releases
         FetchContent_Declare(
             pybind11
-            URL ${CMAKE_SOURCE_DIR}/libs/pybind11/v2.11.0.tar.gz
-            URL_HASH MD5=90c4946e87c64d8d8fc0ae4edf35d780
+            URL ${CMAKE_CURRENT_SOURCE_DIR}/libs/pybind11/v2.13.6.tar.gz
+            URL_HASH MD5=a04dead9c83edae6d84e2e343da7feeb
         )
     endif()
     FetchContent_MakeAvailable(pybind11)
@@ -320,9 +354,15 @@ if (SLS_USE_CTBGUI)
     add_subdirectory(pyctbgui)
 endif(SLS_USE_CTBGUI)
 
-configure_file( .clang-tidy  
-    ${CMAKE_BINARY_DIR}/.clang-tidy  
-)
+# Workaround for file note being copied to build directory
+# when issuing a python -m build
+# TODO! Proper fix
+if(EXISTS ".clang-tidy")
+    configure_file(.clang-tidy  
+        ${CMAKE_BINARY_DIR}/.clang-tidy  
+    )
+endif()
+
 
 if (SLS_BUILD_EXAMPLES)
     add_subdirectory(sample)
@@ -346,4 +386,4 @@ if(SLS_MASTER_PROJECT)
     set(CMAKE_INSTALL_DIR "share/cmake/${PROJECT_NAME}")
     set(PROJECT_LIBRARIES slsSupportShared slsDetectorShared slsReceiverShared)
     include(cmake/package_config.cmake)
-endif()
+endif()

README.md

@@ -2,7 +2,11 @@
 Before building from source make sure that you have the [software wiki](https://slsdetectorgroup.github.io/devdoc/dependencies.html) installed. If installing using conda, conda will manage the dependencies. Avoid also installing packages with pip. 
 
 ## Documentaion
-Detailed documentation can be found in the [software wiki](https://slsdetectorgroup.github.io/devdoc/index.html) and on the [official site](https://www.psi.ch/en/detectors/software).
+Detailed documentation including installation can be found in the [software wiki](https://slsdetectorgroup.github.io/devdoc/index.html).
+
+Different releases can be found on the [official site](https://www.psi.ch/en/lxn/software-releases).
+
+Firmware compatiblity can be found in [firmware page](https://github.com/slsdetectorgroup/slsDetectorFirmware)
 
 ## Installation
 
@@ -42,33 +46,20 @@ conda search slsdet
 conda search slsdetgui
 ```
 
-### 2. Build from source
+## 2. Build from source
 
-##### 2.1 Download Source Code from github
+### 2.1 Download Source Code from github
 ```
 git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch 7.0.0
 ```
 
-**Pybind for Python**<br>
-* **v7.0.0+**:
-pybind11 packaged into 'libs/pybind'. No longer a submodule. No need for "recursive" or "submodule update".
- 
-* **Older versions**:
-   pybind11 is a submodule. Must be cloned using "recursive" and updated when switching between versions using the following commands.
-
-```
-# clone using recursive to get pybind11 submodule
-git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git
-
-# update submodule when switching between releases
-cd slsDetectorPackage
-git submodule update --init
-```
-
-##### 2.2 Build from source
+> **Note:** For v6.x.x of slsDetectorPackage and older, refer [pybind11 notes on cloning](#Pybind-and-Zeromq).
 
 
-###### Build using CMake
+### 2.2 Build from source
+
+
+### Build using CMake
 
 ```
 # outside slsDetecorPackage folder
@@ -94,26 +85,28 @@ Instead of the cmake command, one can use ccmake to get a list of options to con
 ccmake ..
  
 # choose the options
-# first press [c] - configure
+# first press [c] - configure (unil you see [g])
 # then press [g] - generate
 ```
 
 |Example cmake options|Comment|
 |---|---|
 | -DSLS_USE_PYTHON=ON            | Python                                 |   
-| -DPython_FIND_VIRTUALENV=ONLY  | Python from only the conda environment |
-| -DZeroMQ_HINT=/usr/lib64       | Use system zmq instead                 |    
+| -DPython_FIND_VIRTUALENV=ONLY  | Python from only the conda env         | 
 | -DSLS_USE_GUI=ON               | GUI                                    |
+| -DSLS_USE_HDF5=ON              | HDF5                                   |
+| -DSLS_USE_SIMULATOR=ON         | Simulator                              |
 
+> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for cmake option to hint library location](#Pybind-and-Zeromq).
 
-###### Build using in-built cmk.sh script
+### Build using in-built cmk.sh script
 
 ```
 The binaries are generated in slsDetectorPackage/build/bin directory.
 
-Usage: ./cmk.sh [-b] [-c] [-d <HDF5 directory>] [e] [g] [-h] [i] [-j <Number of threads>] 
-[-k <CMake command>] [-l <Install directory>] [m] [n] [-p] [-q <Zmq hint directory>] 
-[r] [s] [t] [u] [z]  
+Usage: $0 [-b] [-c] [-d <HDF5 directory>] [-e] [-g] [-h] [-i]
+[-j <Number of threads>] [-k <CMake command>] [-l <Install directory>]
+[-m] [-n] [-p] [-r] [-s] [-t] [-u] [-z]
 -[no option]: only make
 -b: Builds/Rebuilds CMake files normal mode
 -c: Clean
@@ -128,14 +121,13 @@ Usage: ./cmk.sh [-b] [-c] [-d <HDF5 directory>] [e] [g] [-h] [i] [-j <Number of
 -m: Manuals
 -n: Manuals without compiling doxygen (only rst)
 -p: Builds/Rebuilds Python API
--q: Zmq hint directory
 -r: Build/Rebuilds only receiver
 -s: Simulator
 -t: Build/Rebuilds only text client
 -u: Chip Test Gui
 -z: Moench zmq processor
 
-    
+
 # display all options
 ./cmk.sh -?
 
@@ -145,11 +137,14 @@ Usage: ./cmk.sh [-b] [-c] [-d <HDF5 directory>] [e] [g] [-h] [i] [-j <Number of
 # new build, python and compile in parallel:
 ./cmk.sh -cbpj5
 
-#To use the system zmq (/usr/lib64) instead
-./cmk.sh -cbj5 -q /usr/lib64
+#For rebuilding only certain sections
+./cmk.sh -tg #only text client and gui
+./cmk.sh -r #only receiver
 ```
 
-###### Build on old distributions
+> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for cmk script option to hint library location](#Pybind-and-Zeromq).
+
+### Build on old distributions
 
 If your linux distribution doesn't come with a C++11 compiler (gcc>4.8) then 
 it's possible to install a newer gcc using conda and build the slsDetectorPackage
@@ -166,7 +161,10 @@ cmake ../slsDetectorPackage -DCMAKE_PREFIX_PATH=$CONDA_PREFIX
 make -j12
 ```
 
-###### Build slsDetectorGui (Qt5)
+> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for dependencies for conda](#Pybind-and-Zeromq).
+
+
+### Build slsDetectorGui (Qt5)
 
 1. Using pre-built binary on conda
 ```
@@ -180,7 +178,14 @@ yum install qt5-qtbase-devel.x86_64
 yum install qt5-qtsvg-devel.x86_64 
 ```
 
-3. Using conda
+3. Using system installation on RHEL8
+```
+yum install qt5-qtbase-devel.x86_64
+yum install qt5-qtsvg-devel.x86_64 
+yum install expat-devel.x86_64
+```
+
+4. Using conda
 ```
 #Add channels for dependencies and our library
 conda config --add channels conda-forge
@@ -208,13 +213,15 @@ cd slsDetectorPackage
 ./cmk.sh -cbgj9
 ```
 
-###### Build documentation from package
+> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for dependencies for conda](#Pybind-and-Zeromq).
+
+### Build documentation from package
 The documentation for the slsDetectorPackage is build using a combination 
 of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies
 is to use conda 
 
 ```
-conda create -n myenv python sphinx_rtd_theme breathe
+conda create -n myenv python=3.12 sphinx sphinx_rtd_theme breathe doxygen numpy
 ```
 
 ```
@@ -228,6 +235,47 @@ make rst # rst only, saves time in case the API did not change
 ```
 
 
+
+## Pybind and Zeromq
+
+### Pybind11 for Python
+**v8.0.0+**:
+pybind11 is built
+* by default from tar file in repo (libs/pybind/v2.1x.0.tar.gz)
+* or use advanced option SLS_FETCH_PYBIND11_FROM_GITHUB [link].
+   * v9.0.0+: pybind11 (v2.13.6)
+   * v8.x.x : pybind11 (v2.11.0)
+
+**v7.x.x**:
+pybind11 packaged into ‘libs/pybind’. No longer a submodule. No need for “recursive” or “submodule update”.
+
+**Older versions**:
+pybind11 is a submodule. Must be cloned using “recursive” and updated when switching between versions using the following commands.
+
+```
+# Note: Only for v6.x.x versions and older
+
+# clone using recursive to get pybind11 submodule
+git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git
+
+# update submodule when switching between releases
+cd slsDetectorPackage
+git submodule update --init
+```
+
+### Zeromq
+**v8.0.0+**:
+zeromq (v4.3.4) is built
+* by default from tar file in repo (libs/libzmq/libzmq-4.3.4.tar.gz)
+* or use advanced option SLS_FETCH_ZMQ_FROM_GITHUB [link].
+
+**v7.x.x and older**:
+zeromq-devel must be installed and one can hint its location using
+* cmake option:’-DZeroMQ_HINT=/usr/lib64’ or
+* option ‘-q’ in cmk.sh script: : ./cmk.sh -cbj5 -q /usr/lib64
+* ‘zeromq’ dependency added when installing using conda
+
+
 ## Support
     dhanya.thattil@psi.ch
-    erik.frojdh@psi.ch
+    erik.frojdh@psi.ch

RELEASE.txt

@@ -1,21 +1,13 @@
-SLS Detector Package Major Release x.x.x released on xx.xx.202x
-===============================================================
+SLS Detector Package Minor Release 9.2.0 released on 02.06.2025
+==================================================================
 
-This document describes the differences between vx.x.x and vx.0.2   
+This document describes the differences between v9.2.0 and v9.1.1
 
 
 
     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           New or Changed Features
     2           On-board Detector Server Compatibility
     3           Firmware Requirements
     4           Kernel Requirements
@@ -24,10 +16,21 @@ This document describes the differences between vx.x.x and vx.0.2
 
 
 
-1 New, Changed or Resolved Features
-=====================================
+1 New or Changed Features
+=========================
 
 
+    Python
+    ------
+
+
+    *   Python module is now built using scikit-build-core
+    
+
+    *   slsdet is available on PyPI from this release onwards
+
+
+    *   Updated documentation on python module installation
 
 
 
@@ -36,8 +39,8 @@ This document describes the differences between vx.x.x and vx.0.2
 
 
     Eiger       9.0.0
-    Jungfrau    9.0.0
-    Mythen3     9.0.0
+    Jungfrau    9.1.0
+    Mythen3     9.1.1
     Gotthard2   9.0.0
     Gotthard    9.0.0
     Moench      9.0.0
@@ -66,14 +69,14 @@ This document describes the differences between vx.x.x and vx.0.2
 
     Eiger       02.10.2023 (v32)                    (updated in 7.0.3)
     
-    Jungfrau    01.10.2024 (v1.6, HW v1.0)          (updated in 9.0.0)
-                01.10.2024 (v2.6, HW v2.0)          (updated in 9.0.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     11.10.2024 (v1.5)                   (updated in 9.0.0)
+    Mythen3     13.11.2024 (v2.0)                   (updated in 9.0.0)
 
     Gotthard2   03.10.2024 (v1.0)                   (updated in 9.0.0)
 
-    Moench      26.10.2023 (v2.0)                   (updated in 9.0.0)
+    Moench      26.10.2023 (v2.0)                   (updated in 8.0.2)
 
     Gotthard    08.02.2018 (50um and 25um Master)
                 09.02.2018 (25 um Slave) 
@@ -211,4 +214,5 @@ This document describes the differences between vx.x.x and vx.0.2
     -------
 
         dhanya.thattil@psi.ch
-        erik.frojdh@psi.ch
+        erik.frojdh@psi.ch
+        alice.mazzoleni@psi.ch

VERSION

@@ -0,0 +1 @@
+9.2.0

conda-recepie/build_pylib.sh

@@ -1,6 +0,0 @@
-# SPDX-License-Identifier: LGPL-3.0-or-other
-# Copyright (C) 2021 Contributors to the SLS Detector Package
-
-echo "|<-------- starting python build"
-cd python
-${PYTHON} setup.py install

conda-recepie/conda_build_config.yaml

@@ -1,7 +0,0 @@
-python:
-    - 3.8
-    - 3.9
-    - 3.10
-    - 3.11 
-    - 3.12
-    

conda-recepie/copy_ctbgui.sh

@@ -1,11 +0,0 @@
-# SPDX-License-Identifier: LGPL-3.0-or-other
-# Copyright (C) 2021 Contributors to the SLS Detector Package
-mkdir $PREFIX/lib
-mkdir $PREFIX/bin
-mkdir $PREFIX/include
-
-
-
-cp build/bin/ctbGui $PREFIX/bin/.
-cp build/bin/libctbRootLib.so $PREFIX/lib/.
-

conda-recepie/meta.yaml

@@ -1,126 +0,0 @@
-
-package:
-  name: sls_detector_software
-  version: {{ environ.get('GIT_DESCRIBE_TAG', '') }}
-
-source:
-  - path: ..
-
-build:
-  number: 0
-  binary_relocation: True
-  rpaths:
-    - lib/
-
-requirements:
-  build:
-    - {{ compiler('c') }}
-    - {{compiler('cxx')}}
-    - cmake
-    - qt 5.*
-    - xorg-libx11
-    - xorg-libice
-    - xorg-libxext
-    - xorg-libsm
-    - xorg-libxau
-    - xorg-libxrender
-    - xorg-libxfixes
-    - {{ cdt('mesa-libgl-devel') }}      # [linux]
-    - {{ cdt('mesa-libegl-devel') }}     # [linux]
-    - {{ cdt('mesa-dri-drivers') }}      # [linux]
-    - {{ cdt('libselinux') }}            # [linux]
-    - {{ cdt('libxdamage') }}            # [linux]
-    - {{ cdt('libxxf86vm') }}            # [linux]
-    - expat
-
-  host:
-    - libstdcxx-ng
-    - libgcc-ng
-    - xorg-libx11
-    - xorg-libice
-    - xorg-libxext
-    - xorg-libsm
-    - xorg-libxau
-    - xorg-libxrender
-    - xorg-libxfixes
-    - expat
-
-  run:
-    - libstdcxx-ng
-    - libgcc-ng 
-
-
-outputs:
-  - name: slsdetlib
-    script: copy_lib.sh
-
-    requirements:
-      build:
-        - {{ compiler('c') }}
-        - {{compiler('cxx')}}
-        - libstdcxx-ng
-        - libgcc-ng
-
-
-      run: 
-        - libstdcxx-ng
-        - libgcc-ng
-
-  - name: slsdet
-
-    script: build_pylib.sh
-
-    requirements:
-      build:
-        - python
-        - {{ compiler('c') }}
-        - {{compiler('cxx')}}
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-        - setuptools
-        - pybind11=2.11
-
-      host:
-        - python
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-        - pybind11=2.11
-
-
-      run:
-        - libstdcxx-ng
-        - libgcc-ng
-        - python
-        - numpy
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-
-
-    test:
-      imports:
-        - slsdet
-
-  - name: slsdetgui
-    script: copy_gui.sh
-    requirements:
-
-      build:
-        - {{ compiler('c') }}
-        - {{compiler('cxx')}}
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-
-      run:
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-        - qt 5.*
-        - expat
-
-  - name: moenchzmq
-    script: copy_moench.sh
-    requirements:
-
-      build:
-        - {{ compiler('c') }}
-        - {{compiler('cxx')}}
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-
-
-      run:
-        - {{ pin_subpackage('slsdetlib', exact=True) }}
-        - expat

conda-recepie/run_test.sh

@@ -1,3 +0,0 @@
-# SPDX-License-Identifier: LGPL-3.0-or-other
-# Copyright (C) 2021 Contributors to the SLS Detector Package
-ctest -j2

conda-recipes/main-library/build.sh

@@ -1,10 +1,14 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
 
-mkdir build
-mkdir install
+if [ ! -d "build" ]; then
+    mkdir build
+fi
+if [ ! -d "install" ]; then
+    mkdir install
+fi
 cd build
-cmake .. \
+cmake .. -G Ninja \
       -DCMAKE_PREFIX_PATH=$CONDA_PREFIX \
       -DCMAKE_INSTALL_PREFIX=install \
       -DSLS_USE_TEXTCLIENT=ON \
@@ -14,7 +18,7 @@ cmake .. \
       -DSLS_USE_TESTS=ON \
       -DSLS_USE_PYTHON=OFF \
       -DCMAKE_BUILD_TYPE=Release \
-      -DSLS_USE_HDF5=OFF\
+      -DSLS_USE_HDF5=OFF \
      
 NCORES=$(getconf _NPROCESSORS_ONLN)
 echo "Building using: ${NCORES} cores"

conda-recipes/main-library/conda_build_config.yaml

@@ -0,0 +1,13 @@
+
+c_compiler:
+  - gcc                        # [linux]
+
+c_stdlib:
+  - sysroot                    # [linux]
+
+cxx_compiler:
+  - gxx                        # [linux]
+
+
+c_stdlib_version:              # [linux]
+  - 2.17                       # [linux]

conda-recipes/main-library/copy_lib.sh

@@ -4,18 +4,20 @@
 mkdir -p $PREFIX/lib
 mkdir -p $PREFIX/bin
 mkdir -p $PREFIX/include/sls
-# mkdir $PREFIX/include/slsDetectorPackage
 
 #Shared and static libraries
 cp build/install/lib/* $PREFIX/lib/
 
 #Binaries
 cp build/install/bin/sls_detector_acquire $PREFIX/bin/.
+cp build/install/bin/sls_detector_acquire_zmq $PREFIX/bin/.
 cp build/install/bin/sls_detector_get $PREFIX/bin/.
 cp build/install/bin/sls_detector_put $PREFIX/bin/.
 cp build/install/bin/sls_detector_help $PREFIX/bin/.
+cp build/install/bin/sls_detector $PREFIX/bin/.
 cp build/install/bin/slsReceiver $PREFIX/bin/.
 cp build/install/bin/slsMultiReceiver $PREFIX/bin/.
+cp build/install/bin/slsFrameSynchronizer $PREFIX/bin/.
 
 
 cp build/install/include/sls/* $PREFIX/include/sls

conda-recipes/main-library/meta.yaml

@@ -0,0 +1,78 @@
+source:
+  path: ../..
+
+{% set version = load_file_regex(load_file = 'VERSION', regex_pattern = '(\d+(?:\.\d+)*(?:[\+\w\.]+))').group(1) %}
+package:
+  name: sls_detector_software
+  version: {{ version }} 
+  
+build:
+  number: 0
+  binary_relocation: True
+  rpaths: 
+    - lib/
+
+requirements:
+  build:
+    - {{ compiler('c') }}
+    - {{ stdlib("c") }}
+    - {{ compiler('cxx') }}
+    - git
+    - cmake
+    - ninja
+    - qt 5.*
+
+  host:
+    - libstdcxx-ng
+    - libgcc-ng
+    - libgl-devel  # [linux]
+    - libtiff
+    - zlib
+    - expat
+
+  run:
+    - libstdcxx-ng
+    - libgcc-ng 
+
+
+outputs:
+  - name: slsdetlib
+    script: copy_lib.sh
+
+    requirements:
+      build:
+        - {{ compiler('c') }}
+        - {{ stdlib("c") }}
+        - {{ compiler('cxx') }}
+
+      run: 
+        - libstdcxx-ng
+        - libgcc-ng
+
+
+  - name: slsdetgui
+    script: copy_gui.sh
+    requirements:
+
+      build:
+        - {{ compiler('c') }}
+        - {{compiler('cxx')}}
+        - {{ pin_subpackage('slsdetlib', exact=True) }}
+
+      run:
+        - {{ pin_subpackage('slsdetlib', exact=True) }}
+        - qt 5.*
+
+
+  - name: moenchzmq
+    script: copy_moench.sh
+    requirements:
+
+      build:
+        - {{ compiler('c') }}
+        - {{compiler('cxx')}}
+        - {{ pin_subpackage('slsdetlib', exact=True) }}
+
+
+      run:
+        - {{ pin_subpackage('slsdetlib', exact=True) }}

conda-recipes/python-client/conda_build_config.yaml

@@ -0,0 +1,16 @@
+python:
+    - 3.11 
+    - 3.12
+    - 3.13
+
+c_compiler:
+  - gcc                        # [linux]
+
+c_stdlib:
+  - sysroot                    # [linux]
+
+cxx_compiler:
+  - gxx                        # [linux]
+
+c_stdlib_version:              # [linux]
+  - 2.17                       # [linux]

conda-recipes/python-client/meta.yaml

@@ -0,0 +1,45 @@
+source:
+  path: ../..
+
+{% set version = load_file_regex(load_file = 'VERSION', regex_pattern = '(\d+(?:\.\d+)*(?:[\+\w\.]+))').group(1) %}
+package:
+  name: slsdet
+  version: {{ version }} 
+
+build:
+  number: 0
+  script:
+    - unset CMAKE_GENERATOR && {{ PYTHON }} -m pip install . -vv  # [not win]
+
+requirements:
+  build:
+    - python {{python}}
+    - {{ compiler('c') }}
+    - {{ stdlib("c") }}
+    - {{ compiler('cxx') }}
+
+  host:
+    - cmake
+    - ninja
+    - python {{python}}
+    - pip
+    - scikit-build-core
+    - pybind11 >=2.13.0
+    - fmt
+    - zeromq
+    - nlohmann_json
+    - catch2
+
+  run:
+    - python {{python}}
+    - numpy
+
+
+test:
+  imports:
+    - slsdet
+
+
+about:
+  summary: An example project built with pybind11 and scikit-build.
+  # license_file: LICENSE

docs/CMakeLists.txt

@@ -58,6 +58,12 @@ set(SPHINX_SOURCE_FILES
   src/udpheader.rst
   src/udpconfig.rst
   src/udpdetspec.rst
+  src/fileformat.rst
+  src/slsreceiverheaderformat.rst
+  src/masterfileattributes.rst
+  src/binaryfileformat.rst
+  src/hdf5fileformat.rst
+  src/zmqjsonheaderformat.rst
 )
 
 foreach(filename ${SPHINX_SOURCE_FILES})

docs/conf.py.in

@@ -63,4 +63,4 @@ html_static_path = ['static']
 
 
 def setup(app):
-    app.add_stylesheet('css/extra.css')  # may also be an URL
+    app.add_css_file('css/extra.css')  # may also be an URL

docs/src/binaryfileformat.rst

@@ -0,0 +1,438 @@
+Binary File Format
+====================
+
+This is the default file format that can be configured using command `fformat <commandline.html#term-fformat-binary-hdf5>`_.
+
+    .. code-block:: bash
+
+        sls_detector_put fformat binary
+
+
+Master File
+--------------
+
+* File Name: [fpath]/[fname]_master_[findex].json :ref:`Details here<file name format>`
+
+* It is in json format and created for every acquisition.
+
+* It contains :ref:`attributes<master file attributes>` relevant to the acquisition. This can vary with detector type shown in :ref:`master json file examples <json master file examples>` here.
+
+* It shows the :ref:`**SLS Receiver Header** <sls receiver header format>` format used in data files.
+
+* Enabled/disabled using command `fmaster <commandline.html#term-fmaster-0-1>`_. 
+
+
+Data File
+----------
+
+* File Name: [fpath]/[fname]_dx_fy_[findex].raw :ref:`Details here<file name format>`
+
+* It store multiple frames sequentially, with total number of frames determined by `rx_framesperfile <commandline.html#term-rx_framesperfile-n_frames>`_ parameter.
+
+* Each frame includes a :ref:`**sls_receiver_header** <sls receiver header format>` structure, followed by the actual frame data.
+
+
+
+.. _json master file examples:
+
+JSON Master File Examples
+---------------------------------------------------
+
+Eiger
+^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 15:46:30 2024",
+        "Detector Type": "Eiger",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 2,
+            "y": 1
+        },
+        "Image Size in bytes": 262144,
+        "Pixels": {
+            "x": 512,
+            "y": 256
+        },
+        "Max Frames Per File": 10000,
+        "Frame Discard Policy": "nodiscard",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 1,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Dynamic Range": 16,
+        "Ten Giga": 0,
+        "Exptime": "1s",
+        "Period": "1s",
+        "Threshold Energy": -1,
+        "Sub Exptime": "2.62144ms",
+        "Sub Period": "2.62144ms",
+        "Quad": 0,
+        "Number of rows": 256,
+        "Rate Corrections": "[0]",
+        "Frames in File": 1,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }
+
+
+
+Jungfrau
+^^^^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 13:03:53 2024",
+        "Detector Type": "Jungfrau",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 1,
+            "y": 1
+        },
+        "Image Size in bytes": 1048576,
+        "Pixels": {
+            "x": 1024,
+            "y": 512
+        },
+        "Max Frames Per File": 10000,
+        "Frame Discard Policy": "nodiscard",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 1000,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Exptime": "10us",
+        "Period": "2ms",
+        "Number of UDP Interfaces": 1,
+        "Number of rows": 512,
+        "Frames in File": 10,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }
+
+
+Gotthard2
+^^^^^^^^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 14:18:17 2024",
+        "Detector Type": "Gotthard2",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 1,
+            "y": 1
+        },
+        "Image Size in bytes": 2560,
+        "Pixels": {
+            "x": 1280,
+            "y": 1
+        },
+        "Max Frames Per File": 20000,
+        "Frame Discard Policy": "nodiscard",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 10,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Exptime": "0ns",
+        "Period": "0ns",
+        "Burst Mode": "burst_internal",
+        "Frames in File": 10,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }
+
+Mythen3
+^^^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 14:39:14 2024",
+        "Detector Type": "Mythen3",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 1,
+            "y": 1
+        },
+        "Image Size in bytes": 15360,
+        "Pixels": {
+            "x": 3840,
+            "y": 1
+        },
+        "Max Frames Per File": 10000,
+        "Frame Discard Policy": "nodiscard",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 1,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Dynamic Range": 32,
+        "Ten Giga": 1,
+        "Period": "2ms",
+        "Counter Mask": "0x7",
+        "Exptime1": "0.1s",
+        "Exptime2": "0.1s",
+        "Exptime3": "0.1s",
+        "GateDelay1": "0ns",
+        "GateDelay2": "0ns",
+        "GateDelay3": "0ns",
+        "Gates": 1,
+        "Threshold Energies": "[-1, -1, -1]",
+        "Frames in File": 1,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }
+
+
+Moench
+^^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 14:41:32 2024",
+        "Detector Type": "Moench",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 1,
+            "y": 1
+        },
+        "Image Size in bytes": 320000,
+        "Pixels": {
+            "x": 400,
+            "y": 400
+        },
+        "Max Frames Per File": 100000,
+        "Frame Discard Policy": "discardpartial",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 1,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Exptime": "10us",
+        "Period": "2ms",
+        "Number of UDP Interfaces": 1,
+        "Number of rows": 400,
+        "Frames in File": 1,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }
+
+Gotthard I
+^^^^^^^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 15:16:19 2024",
+        "Detector Type": "Gotthard",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 1,
+            "y": 1
+        },
+        "Image Size in bytes": 2560,
+        "Pixels": {
+            "x": 1280,
+            "y": 1
+        },
+        "Max Frames Per File": 20000,
+        "Frame Discard Policy": "nodiscard",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 1,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Exptime": "1.00001ms",
+        "Period": "1s",
+        "Detector Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295
+        },
+        "Frames in File": 1,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }
+
+Chip Test Board
+^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+    {
+        "Version": 7.2,
+        "Timestamp": "Wed Nov 13 15:32:59 2024",
+        "Detector Type": "ChipTestBoard",
+        "Timing Mode": "auto",
+        "Geometry": {
+            "x": 1,
+            "y": 1
+        },
+        "Image Size in bytes": 48018,
+        "Pixels": {
+            "x": 3,
+            "y": 1
+        },
+        "Max Frames Per File": 20000,
+        "Frame Discard Policy": "nodiscard",
+        "Frame Padding": 1,
+        "Scan Parameters": "[disabled]",
+        "Total Frames": 1,
+        "Receiver Roi": {
+            "xmin": 4294967295,
+            "xmax": 4294967295,
+            "ymin": 4294967295,
+            "ymax": 4294967295
+        },
+        "Exptime": "0ns",
+        "Period": "0.18s",
+        "Ten Giga": 0,
+        "ADC Mask": "0x2202",
+        "Analog Flag": 1,
+        "Analog Samples": 8003,
+        "Digital Flag": 0,
+        "Digital Samples": 1000,
+        "Dbit Offset": 0,
+        "Dbit Bitset": 0,
+        "Transceiver Mask": "0x3",
+        "Transceiver Flag": 0,
+        "Transceiver Samples": 1,
+        "Frames in File": 1,
+        "Frame Header Format": {
+            "Frame Number": "8 bytes",
+            "SubFrame Number/ExpLength": "4 bytes",
+            "Packet Number": "4 bytes",
+            "Bunch ID": "8 bytes",
+            "Timestamp": "8 bytes",
+            "Module Id": "2 bytes",
+            "Row": "2 bytes",
+            "Column": "2 bytes",
+            "Reserved": "2 bytes",
+            "Debug": "4 bytes",
+            "Round Robin Number": "2 bytes",
+            "Detector Type": "1 byte",
+            "Header Version": "1 byte",
+            "Packets Caught Mask": "64 bytes"
+        }
+    }

docs/src/commandline.rst

@@ -4,11 +4,54 @@ Command line interface
 Usage
 -------------
 
-Commands can be used either with sls_detector_get or sls_detector_put
+The syntax is *'[detector index]-[module index]:[command]'*, where the indices are by default '0', when not specified.
+
+Module index
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Modules are indexed based on their order in the hostname command. They are used to configure a specific module within a detector and are followed by a ':' in syntax.
+
+    .. code-block::
+
+        # Applies to all modules of detector 0
+        sls_detector_put exptime 5s
+
+        # Applies to only the 4th module
+        sls_detector_put 3:exptime 5s
+
+
+Detector index
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This index is useful when configuring multiple detectors from a single host. Each detector uses a unique shared memory identified by a detector index, derived again from the hostname command. It is followed by a '-'. 
+
+    .. code-block::
+
+        # For detector with index 2 in shared memory
+        sls_detector_put 2-hostname bchip133+bchip123+bchip456
+        
+        # Without '-', the detector index defaults to 0
+        sls_detector_put hostname bchip133+bchip123+bchip456
+
+        # Accessing all modules with detector index 2
+        sls_detector_put 2-exptime
+
+        # Starting acquisition only for detector with index 2
+        sls_detector_put 2-start
+
+        # Applies only to the 2nd detector, 4th module
+        sls_detector_put 1-3:exptime 5s
+
+
+Command Execution
+^^^^^^^^^^^^^^^^^^^^^^^
+Commands can be executed using:
+
+*   **sls_detector_put**: setting values
+*   **sls_detector_get**: getting values
+*   **sls_detector**: automatically infers based on the number of arguments.
+*   **sls_detector_help**: gets help on the specific command
+*   **sls_detector_acquire**: initiates acquisition with the detector. This command blocks until the entire acquisition process is completed.
 
-.. code-block::
 
-    sls_detector_get vrf
 
 Help
 --------
@@ -24,6 +67,19 @@ Help
     # get help for a particular command
     sls_detector_get -h fpath
     sls_detector_help fpath
+
+    # list of deprecated commands
+    list deprecated
+
+
+Autocompletion
+---------------
+
+bash_autocomplete.sh or zsh_autocomplete.sh must be sourced from the main package folder to enable auto completion of commands and arguments for the command line on that shell.
+
+.. code-block::
+
+    source bash_autocomplete.sh
   
 
 Commands

docs/src/dependencies.rst

@@ -20,8 +20,8 @@ the shared libraries these are needed:
 Python bindings
 -----------------------
 
- * Python > 3.6
- * pybind11 2.11.0 (packaged in libs)
+ * Python >= 3.8
+ * pybind11 2.13.6 (packaged in libs)
 
 .. note ::  
 

docs/src/detector.rst

@@ -13,7 +13,6 @@ containing results from all modules. (:ref:`Result class<Result Class>`)
 
 Here are some :ref:`examples <Cplusplus Api Examples>` on how to use the API.
 
-.. _Cplusplus Api Examples:
 .. doxygenclass:: sls::Detector
    :members:
    :undoc-members:

docs/src/fileformat.rst

@@ -0,0 +1,62 @@
+File format
+================================
+
+If `fwrite <commandline.html#term-fwrite-0-1>`_ is enabled, the receiver will write data to files. 
+
+Number of Files
+----------------
+
+Every acquisition will create a master file and data files. 
+
+An acquisition can have multiple data files for a single frame. The number of files is determined by the number of UDP ports per module and the number of modules.
+
+    * Every modules has its own receiver process. Every receiver process can have 1 or 2 UDP ports.
+    * Each UDP port will create its own file. Therefore, each receiver can write 1 or 2 files.
+    * So, for example a detector with 4 modules with 2 UDP ports each will create a total of 8 files with file names containing UDP port index **'_d0'** to **'_d7'**.
+
+A new file containing **'_f[file_index]'** in file name is also created when reaching the maximum frames per file. Configured using `rx_framesperfile <commandline.html#term-rx_framesperfile-n_frames>`_.
+
+.. _file name format:
+
+Naming
+-------
+| Master File Name: [fpath]/[fname]_master_[findex].[ext]
+
+
+| Data File Name: [fpath]/[fname]_dx_fy_[findex].[ext] 
+
+   * fpath: file path set using command `fpath <commandline.html#term-fpath-path>`_. Default: '/'
+   * fname: file name prefix using command `fname <commandline.html#term-fname-name>`_. Default: "run"
+   * findex: acquisition index using command `findex <commandline.html#term-findex-n_value>`_. Automatically incremented for every acquisition with `sls_detector_acquire <commandline.html#term-acquire>`_ (if `fwrite <commandline.html#term-fwrite-0-1>`_ enabled).
+   * x: unique udp port index. New file per UDP port.
+   * y: file index. New file created after reaching max frames per file.
+   * ext: file extension. Default: "raw"(data file) or "json"(master file)
+
+
+Some file name examples:
+
+    .. code-block:: bash
+
+        # first file
+        path-to-file/run_d0_f0_0.raw
+
+        # first file for second UDP port
+        path-to-file/run_d1_f0_0.raw
+
+        # second file after reaching max frames in first file
+        path-to-file/run_d0_f1_0.raw
+        
+        # second acquisition, first file
+        path-to-file/run_d0_f0_1.raw
+
+
+Formats
+--------
+
+There are 2 file formats supported by the receiver:
+
+    * Binary - extension .json (master file) or .raw (data files)
+    * HDF5 - extension .h5
+
+The default is binary. HDF5 can be enabled by compiling the package with HDF5 option enabled. The file format is set using the command `fformat <commandline.html#term-fformat-binary-hdf5>`_.
+

docs/src/firmware.rst

@@ -98,7 +98,7 @@ Upgrade
 
     * 6.1.2 server has a fix for seamless fpga programming
 
-    * We recommend first updating the on-board detector server to 6.1.2 (with client 6.1.x) using command 'updatedetectorserver' or 'copydetectorserver'.
+    * We recommend first updating the on-board detector server to 6.1.2 (with client 6.1.x) using command `updatedetectorserver <commandline.html#term-updatedetectorserver-server_name-with-full-path>`_.
 
     * Then use command 'programfpga' to only update firmware or use command 'update' to update firmware and server to the latest release.
 
@@ -257,7 +257,7 @@ Upgrade
 
     * 6.1.2 server has a fix for seamless fpga programming
 
-    * We recommend first updating the on-board detector server to 6.1.2 (with client 6.1.x) using command 'updatedetectorserver' or 'copydetectorserver'.
+    * We recommend first updating the on-board detector server to 6.1.2 (with client 6.1.x) using command `updatedetectorserver <commandline.html#term-updatedetectorserver-server_name-with-full-path>`_.
 
     * Then use command 'programfpga' to only update firmware or use command 'update' to update firmware and server to the latest release.
 

docs/src/gendoc.cpp

@@ -11,7 +11,7 @@
 #include <string>
 #include <vector>
 
-#include "CmdProxy.h"
+#include "Caller.h"
 #include "sls/Detector.h"
 #include "sls/sls_detector_defs.h"
 
@@ -37,8 +37,8 @@ int main() {
 
     std::cout << "Generating command line documentation!\n";
 
-    sls::CmdProxy proxy(nullptr);
-    auto commands = proxy.GetProxyCommands();
+    sls::Caller caller(nullptr);
+    auto commands = caller.getAllCommands();
 
     std::ofstream fs("commands.rst");
     fs << ".. glossary::\n";
@@ -46,7 +46,7 @@ int main() {
     for (const auto &cmd : commands) {
         std::ostringstream os;
         std::cout << cmd << '\n';
-        proxy.Call(cmd, {}, -1, slsDetectorDefs::HELP_ACTION, os);
+        caller.call(cmd, {}, -1, slsDetectorDefs::HELP_ACTION, os);
 
         auto tmp = os.str().erase(0, cmd.size());
         auto usage = tmp.substr(0, tmp.find_first_of('\n'));
@@ -57,7 +57,7 @@ int main() {
 
     std::ofstream fs2("deprecated.csv");
     fs2 << "Old, New\n";
-    auto cmds = proxy.GetDeprecatedCommands();
+    auto cmds = caller.GetDeprecatedCommands();
     for (auto it : cmds) {
         fs2 << it.first << ", " << it.second << '\n';
     }

docs/src/hdf5fileformat.rst

@@ -0,0 +1,89 @@
+
+
+HDF5 File Format
+================================
+
+Compilation
+-------------
+
+#. Compile the package with HDF5 option enabled
+
+    #. Using cmk script: ./cmk.sh -hj9 -d [path of hdf5 dir] (-d is optional and for custom installation folder)
+
+    #. Enable using cmake option **-DSLS_USE_HDF5=ON** and **-DCMAKE_INSTALL_PREFIX=/path/to/custom/hdf/installation** (optional).
+
+
+Setup
+-------
+
+#. Start Receiver process
+
+#. Load config file
+
+#. Set file format using command `fformat <commandline.html#term-fformat-binary-hdf5>`_.
+
+    .. code-block:: bash
+
+        sls_detector_put fformat hdf5
+
+
+Master File
+-------------
+
+* File Name: [fpath]/[fname]_master_[findex].h5 :ref:`Details here<file name format>`
+
+* It contains  :ref:`attributes<master file attributes>` relevant to the acquisition. This can vary with detector type.
+
+.. code-block:: text
+
+    /                                               # Root level
+    |---> entry                                     # entry group
+    |    |---> data                                 # data group
+    |         |---> column                          # dataset of each sls_receiver_header member
+    |         |---> data
+    |         |---> detector header version
+    |         |---> detector specific 1
+    |         |---> detector specific 2
+    |         |---> detector specific 3
+    |         |---> detector specific 4
+    |         |---> detector type
+    |         |---> exp length or sub exposure time
+    |         |---> frame number
+    |         |---> mod id
+    |         |---> packets caught
+    |         |---> packets caught bit mask
+    |         |---> row
+    |         |---> timestamp
+    |    |---> instrument                           # instrument group
+    |         |---> beam                            # beam group
+    |         |---> detector                        # detector group
+    |              |---> Master File Attribute 1    # dataset of each master file attribute
+    |              |---> Master File Attribute 2
+    |              |---> Master File Attribute 3
+    |              |---> Master File Attribute ..
+    |    |---> sample                               # sample group
+
+
+If more than 1 data file per frame:
+    * The dataset of each :ref:`**SLS Receiver Header** <sls receiver header format>` member is a virtual dataset.
+    * **data** dataset is a virtual dataset.
+
+
+More details regarding master file attributes can be found :ref:`here<master file attributes>`.
+
+Data File
+-----------
+
+* File Name: [fpath]/[fname]_dx_fy_[findex].h5 :ref:`Details here<file name format>`
+
+
+Virtual Data File
+------------------
+
+* File Name: [fpath]/[fname]_virtual_[findex].h5 :ref:`Details here<file name format>`
+
+* For multiple modules, a virtual file linking data from all the modules is created. The individual files are expected to be present.
+
+* It is linked in the master file.
+
+

docs/src/index.rst

@@ -12,7 +12,7 @@ Welcome to slsDetectorPackage's documentation!
     For further documentation, visit the official page: https://www.psi.ch/en/detectors/documentation
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 3
     :caption: Installation:
 
     installation
@@ -39,7 +39,7 @@ Welcome to slsDetectorPackage's documentation!
 
 .. toctree::
     :caption: Command line
-    :maxdepth: 2
+    :maxdepth: 1
 
     commandline  
     quick_start_guide
@@ -79,8 +79,25 @@ Welcome to slsDetectorPackage's documentation!
     :caption: Receiver
     :maxdepth: 2
 
-    receivers
     slsreceiver
+    receivers
+    
+
+.. toctree::
+    :caption: Receiver Files
+    :maxdepth: 3
+
+    fileformat
+    slsreceiverheaderformat
+    masterfileattributes
+    binaryfileformat
+    hdf5fileformat
+
+.. toctree::
+    :caption: Receiver ZMQ Stream
+    :maxdepth: 2
+
+    zmqjsonheaderformat
 
 .. toctree::
     :caption: Troubleshooting

docs/src/installation.rst

@@ -1,9 +1,4 @@
-.. warning ::
-    
-    Before building from source make sure that you have the 
-    :doc:`dependencies <../dependencies>` installed. If installing using conda, conda will 
-    manage the dependencies. Avoid also installing packages with pip. 
-   
+
 
 .. _Installation:
 
@@ -11,18 +6,47 @@
 Installation
 ===============
 
-Install binaries using conda
--------------------------------
+.. contents::
+   :local:
+   :depth: 2
+   :backlinks: top
+
+
+Overview
+--------------
+
+The ``slsDetectorPackage`` provides core detector software implemented in C++, along with Python bindings packaged as the ``slsdet`` Python extension module. Choose the option that best fits your environment and use case.
+
+:ref:`conda pre-built binaries`: 
+Install pre-built binaries for the C++ client, receiver, GUI and the Python API (``slsdet``), simplifying setup across platforms.
+
+:ref:`pip`:
+Install only the Python extension module, either by downloading the pre-built library from PyPI or by building the extension locally from source. Available only from v9.2.0 onwards.
+
+:ref:`build from source`: 
+Compile the entire package yourself, including both the C++ core and the Python bindings, for maximum control and customization. However, make sure that you have the :doc:`dependencies <../dependencies>` installed. If installing using conda, conda will manage the dependencies. Avoid installing packages with pip and conda simultaneously.
+
+
+
+   
+.. _conda pre-built binaries:
+
+1. Install pre-built binaries using conda (Recommended)
+--------------------------------------------------------
 
 Conda is not only useful to manage python environments but can also
 be used as a user space package manager. Dates in the tag (for eg. 2020.07.23.dev0) 
 are from the developer branch. Please use released tags for stability.
 
-We have three different packages available:
-
-    * **slsdetlib** shared libraries and command line utilities 
-    * **slsdetgui** GUI
-    * **slsdet** Python bindings
+We have four different packages available:
+    ==============     =============================================
+    Package             Description
+    ==============     =============================================
+    slsdetlib           shared libraries and command line utilities 
+    slsdetgui           GUI
+    slsdet              Python bindings
+    moenchzmq           moench
+    ==============     =============================================
 
 .. code-block:: bash
 
@@ -38,7 +62,7 @@ We have three different packages available:
 
     #ready to use
     sls_detector_get exptime
-    etc ...
+    ...
 
 
 .. code-block:: bash
@@ -50,14 +74,33 @@ We have three different packages available:
     conda search slsdet
     # gui
     conda search slsdetgui
+    # moench
+    conda search moenchzmq
 
 
+.. _pip:
+
+2. Pip
+-------
+The Python extension module ``slsdet`` can be installed using pip. This is available from v9.2.0 onwards.
+
+.. code-block:: bash
+    
+    #Install the Python extension module from PyPI
+    pip install slsdet
+
+    # or install the python extension locally from source
+    git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch 9.2.0
+    cd slsDetectorPackage
+    pip install .
 
 
-Build from source
--------------------
+.. _build from source:
 
-1. Download Source Code from github
+3. Build from source
+-------------------------
+
+3.1. Download Source Code from github
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: bash
@@ -72,11 +115,13 @@ Build from source
 
 
 
-2. Build from Source
+3.2. Build from Source
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Build using CMake
-^^^^^^^^^^^^^^^^^^^^^^
+One can either build using cmake or use the in-built cmk.sh script.
+
+3.2.1. Build using CMake
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: bash
 
@@ -103,7 +148,7 @@ Instead of the cmake command, one can use ccmake to get a list of options to con
     ccmake ..
  
     # choose the options
-    # first press [c] - configure (maybe multiple times till you see [g])
+    # first press [c] - configure (until you see [g])
     # then press [g] - generate
 
 
@@ -122,8 +167,8 @@ Example cmake options               Comment
     For v7.x.x of slsDetectorPackage and older, refer :ref:`zeromq notes for cmake option to hint library location. <zeromq for different slsDetectorPackage versions>` 
 
 
-Build using in-built cmk.sh script
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+3.2.2. Build using in-built cmk.sh script
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
 .. code-block:: bash
@@ -172,8 +217,8 @@ Build using in-built cmk.sh script
     For v7.x.x of slsDetectorPackage and older, refer :ref:`zeromq notes for cmk script option to hint library location. <zeromq for different slsDetectorPackage versions>` 
 
 
-Build on old distributions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+3.3. Build on old distributions using conda
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If your linux distribution doesn't come with a C++11 compiler (gcc>4.8) then 
 it's possible to install a newer gcc using conda and build the slsDetectorPackage
@@ -197,10 +242,11 @@ using this compiler
 
 
 
-Build slsDetectorGui (Qt5)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+3.4. Build slsDetectorGui (Qt5)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 1. Using pre-built binary on conda
+
     .. code-block:: bash
 
         conda create -n myenv slsdetgui=7.0.0
@@ -208,13 +254,22 @@ Build slsDetectorGui (Qt5)
 
 
 2. Using system installation on RHEL7
+
     .. code-block:: bash
 
         yum install qt5-qtbase-devel.x86_64
         yum install qt5-qtsvg-devel.x86_64 
 
+3. Using system installation on RHEL8
+
+    .. code-block:: bash
+
+        yum install qt5-qtbase-devel.x86_64
+        yum install qt5-qtsvg-devel.x86_64 
+        yum install expat-devel.x86_64
+
+4. Using conda
 
-3. Using conda
     .. code-block:: bash
 
         #Add channels for dependencies and our library
@@ -248,8 +303,8 @@ Build slsDetectorGui (Qt5)
 
 
 
-Build this documentation
-^^^^^^^^^^^^^^^^^^^^^^^^
+3.5. Build this documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The documentation for the slsDetectorPackage is build using a combination 
 of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies
@@ -271,17 +326,19 @@ is to use conda
     make rst # rst only, saves time in case the API did not change
 
 
-Pybind and Zeromq
-^^^^^^^^^^^^^^^^^^^
+4. Pybind and Zeromq
+-------------------------
 
 .. _pybind for different slsDetectorPackage versions:
 
 
-| **Pybind for Python**
-| v8.0.0+:
-|   pybind11 (v2.11.0) is built 
-|   * by default from tar file in repo (libs/pybind/v2.11.0.tar.gz) 
+| **Pybind11 for Python**
+| v8.0.0+: 
+|   pybind11 is built
+|   * by default from tar file in repo (libs/pybind/v2.1x.0.tar.gz) 
 |   * or use advanced option SLS_FETCH_PYBIND11_FROM_GITHUB [`link <https://github.com/pybind/pybind11>`__].
+|      * v9.0.0+: pybind11 (v2.13.6)
+|      * v8.x.x : pybind11 (v2.11.0)
 |
 | v7.x.x:
 |   pybind11 packaged into 'libs/pybind'. No longer a submodule. No need for "recursive" or "submodule update".
@@ -312,7 +369,7 @@ Pybind and Zeromq
 |   * or use advanced option SLS_FETCH_ZMQ_FROM_GITHUB [`link <https://github.com/zeromq/libzmq.git>`__].
 |
 | v7.x.x and older:
-|   zeromq must be installed and one can hint its location using
+|   zeromq-devel must be installed and one can hint its location using
 |   * cmake option:'-DZeroMQ_HINT=/usr/lib64' or 
 |   * option '-q' in cmk.sh script: : ./cmk.sh -cbj5 -q /usr/lib64
 |   * 'zeromq' dependency added when installing using conda

docs/src/masterfileattributes.rst

@@ -0,0 +1,409 @@
+
+.. _master file attributes:
+
+Master File Attributes
+=======================
+
+These attributes are the same in binary and HDF5 file, but vary depending on detector type.
+
+
+Eiger
+^^^^^
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Dynamic Range         | Bits per pixel                                  |
+   +-----------------------+-------------------------------------------------+
+   | Ten Giga              | 10GbE enable for data                           |
+   +-----------------------+-------------------------------------------------+
+   | Exptime               | Exposure time                                   |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Threshold Energy      | Threshold energy                                |
+   +-----------------------+-------------------------------------------------+
+   | Sub Exptime           | Sub exposure time in 32 bit mode                |
+   +-----------------------+-------------------------------------------------+
+   | Sub Period            | Sub period between frames in 32 bit mode        |
+   +-----------------------+-------------------------------------------------+
+   | Quad                  | Quad enable (hardware)                          |
+   +-----------------------+-------------------------------------------------+
+   | Number of rows        | Number of rows enabled for readout              |
+   +-----------------------+-------------------------------------------------+
+   | Rate Corrections      | Rate Corrections                                |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+
+
+
+Jungfrau
+^^^^^^^^
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Exptime               | Exposure time                                   |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Number of UDP         | Number of UDP Interfaces enabled per module     |
+   | Interfaces            |                                                 |
+   +-----------------------+-------------------------------------------------+
+   | Number of rows        | Number of rows enabled for readout              |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+
+
+Gotthard II
+^^^^^^^^^^^^
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Exptime               | Exposure time                                   |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Burst Mode            | Burst mode of detector                          |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+
+
+Mythen3
+^^^^^^^
+
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Dynamic Range         | Bits per pixel                                  |
+   +-----------------------+-------------------------------------------------+
+   | Ten Giga              | 10GbE enable for data                           |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Counter Mask          | Mask of counters enabled                        |
+   +-----------------------+-------------------------------------------------+
+   | Exptime1              | Exposure time of counter 1                      |
+   +-----------------------+-------------------------------------------------+
+   | Exptime2              | Exposure time of counter 2                      |
+   +-----------------------+-------------------------------------------------+
+   | Exptime3              | Exposure time of counter 3                      |
+   +-----------------------+-------------------------------------------------+
+   | GateDelay1            | Gate delay of counter 1                         |
+   +-----------------------+-------------------------------------------------+
+   | GateDelay2            | Gate delay of counter 2                         |
+   +-----------------------+-------------------------------------------------+
+   | GateDelay3            | Gate delay of counter 3                         |
+   +-----------------------+-------------------------------------------------+
+   | Gates                 | Number of gates                                 |
+   +-----------------------+-------------------------------------------------+
+   | Threshold energies    | Threshold energy of all 3 counters              |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+
+
+
+Moench
+^^^^^^
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Exptime               | Exposure time                                   |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Number of UDP         | Number of UDP Interfaces enabled per module     |
+   | Interfaces            |                                                 |
+   +-----------------------+-------------------------------------------------+
+   | Number of rows        | Number of rows enabled for readout              |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+
+
+Gotthard I
+^^^^^^^^^^^
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Exptime               | Exposure time                                   |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Detector Roi          | Roi in detector restricted to an ADC.           |
+   |                       | Includes xmax                                   |
+   +-----------------------+-------------------------------------------------+
+   | Burst Mode            | Burst mode of detector                          |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+
+
+Chip Test Board
+^^^^^^^^^^^^^^^
+
+
+   +-----------------------+-------------------------------------------------+
+   | **Key**               | **Description**                                 |
+   +-----------------------+-------------------------------------------------+
+   | Version               | Version of the master file                      |
+   |                       | Current value:8.0                               |
+   +-----------------------+-------------------------------------------------+
+   | Timestamp             | Timestamp of creation of master file            |
+   +-----------------------+-------------------------------------------------+
+   | Detector Type         | Detector type                                   |
+   +-----------------------+-------------------------------------------------+
+   | Timing Mode           | Timing Mode                                     |
+   +-----------------------+-------------------------------------------------+
+   | Geometry              | Number of UDP ports in x and y dimension for    |
+   |                       | complete detector                               |
+   +-----------------------+-------------------------------------------------+
+   | Image Size in bytes   | Image size in bytes per UDP port                |
+   +-----------------------+-------------------------------------------------+
+   | Pixels                | Number of pixels in x and y dimension           |
+   |                       | per UDP port                                    |
+   +-----------------------+-------------------------------------------------+
+   | Max Frames Per File   | Maximum frames per file                         |
+   +-----------------------+-------------------------------------------------+
+   | Frame Discard Policy  | Receiever Frame discard policy                  |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Frame Padding         | Receiver Frame padding enable                   |
+   |                       | for partial frames                              |
+   +-----------------------+-------------------------------------------------+
+   | Scan Parameters       | Scanning mode on detector                       |
+   +-----------------------+-------------------------------------------------+
+   | Total Frames          | Total number of frames and triggers expected    |
+   +-----------------------+-------------------------------------------------+
+   | Receiver Roi          | Receiver ROI in file including xmax and ymax    |
+   +-----------------------+-------------------------------------------------+
+   | Exptime               | Exposure time                                   |
+   +-----------------------+-------------------------------------------------+
+   | Period                | Period between frames                           |
+   +-----------------------+-------------------------------------------------+
+   | Ten Giga              | Ten giga enable                                 |
+   +-----------------------+-------------------------------------------------+
+   | ADC Mask              | Mask of channels enabled in ADC                 |
+   +-----------------------+-------------------------------------------------+
+   | Analog Flag           | Analog readout enable                           |
+   +-----------------------+-------------------------------------------------+
+   | Analog Samples        | Number of analog samples                        |
+   +-----------------------+-------------------------------------------------+
+   | Digital Flag          | Digital readout enable                          |
+   +-----------------------+-------------------------------------------------+
+   | Digital Samples       | Number of digital samples                       |
+   +-----------------------+-------------------------------------------------+
+   | Dbit Offset           | Digital offset of valid data in bytes           |
+   +-----------------------+-------------------------------------------------+
+   | Dbit Bitset           | Digital 64 bit mask of bits enabled in receiver |
+   +-----------------------+-------------------------------------------------+
+   | Transceiver Mask      | Mask of channels enabled in Transceiver         |
+   +-----------------------+-------------------------------------------------+
+   | Transceiver Flag      | Transceiver readout enable                      |
+   +-----------------------+-------------------------------------------------+
+   | Transceiver Samples   | Number of transceiver samples                   |
+   +-----------------------+-------------------------------------------------+
+   | Frames in File        | Number of frames written to file by Receiver 0  |
+   +-----------------------+-------------------------------------------------+
+   | Frame Header Format   | Expected frame header format for the data files |
+   +-----------------------+-------------------------------------------------+

docs/src/pygettingstarted.rst

@@ -6,7 +6,7 @@ Getting Started
 Which Python?  
 --------------------
 
-We require at least Python 3.6 and strongly recommended that you don't use the system
+We require at least Python 3.8 and strongly recommended that you don't use the system
 Python installation. The examples in this documentation uses `conda
 <https://docs.conda.io/en/latest/miniconda.html>`_ since it provides good support
 also for non Python packages but there are also other alternatives like, pyenv. 

docs/src/quick_start_guide.rst

@@ -128,6 +128,10 @@ For Multiple Modules
         # set file path
         fpath /tmp
 
+.. note ::   
+    The **hostname** and **detsize** command in a multi module system can affect the row and column values in the udp/zmq header. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on. 
+
+    
 Gui
 ----
 

docs/src/receivers.rst

@@ -1,25 +1,25 @@
-Receivers
+Custom Receiver
 =================
 
-Receiver processes can be run on same or different machines as the client, receives the data from the detector (via UDP packets).
-When using the slsReceiver/ slsMultiReceiver, they can be further configured by the client control software (via TCP/IP) to set file name, file path, progress of acquisition etc.
+The receiver essentially listens to UDP data packets sent out by the detector.
+
+To know more about detector receiver setup in the config file, please check out :ref:`the detector-receiver UDP configuration in the config file<detector udp header config>` and the :ref:`detector udp format<detector udp header>`.
 
 
-To know more about detector receiver configuration, please check out :ref:`detector udp header and udp commands in the config file <detector udp header>`
+| Please note the following when using a custom receiver:
 
-Custom Receiver
-----------------
+* **udp_dstmac** must be configured in the config file. This parameter is not required when using an in-built receiver.
 
-| When using  custom receiver with our package, ensure that **udp_dstmac** is also configured in the config file. This parameter is not required when using slsReceiver.
+* Cannot use "auto" for **udp_dstip**.
 
-| Cannot use "auto" for **udp_dstip**.
+* No **rx_** commands in the config file. These commands are for configuring the slsReceiver.
 
-| Also ensure that there are no **rx_** commands in the config file. These commands are for configuring the slsReceiver.
+
+
+The main difference is the lack of **rx_** commands or file commands (eg. **f**write, **f**path) and the **udp_dstmac** is required in config file.
 
 Example of a custom receiver config file
 
-* The main difference is the lack of **rx_** commands or file commands (eg. fwrite, fpath) and the udp_dstmac is required in config file.
-
 .. code-block:: bash
 
     # detector hostname

docs/src/servers.rst

@@ -39,13 +39,13 @@ Arguments
 
 
 .. _Automatic start servers:
+
 Automatic start 
 ------------------
 
 One can start the on-board detector server automatically upon powering on the board.
 
-#. Create a soft link to the binary on board 
-   :
+#. Create a soft link to the binary on board:
       .. code-block:: bash
       
          ln -sf someDetectorServervx.x.x someDetectorServer
@@ -87,8 +87,7 @@ One can start the on-board detector server automatically upon powering on the bo
          /root/xxxDetectorServer >> /dev/null &
 
 
-#. Sync, reboot and verify
-   :
+#. Sync, reboot and verify:
       .. code-block:: bash
       
          sync

docs/src/serverupgrade.rst

@@ -1,4 +1,5 @@
 .. _Detector Server Upgrade:
+
 Upgrade
 ========
 

docs/src/slsreceiver.rst

@@ -1,16 +1,55 @@
-slsReceiver/ slsMultiReceiver
+In-built Receiver   
 ================================
 
-| One has to start the slsReceiver before loading config file or using any receiver commands (prefix: **rx_** )
 
+
+The receiver essentially listens to UDP data packets sent out by the detector. It's main features are:
+
+- **Listening**: Receives UDP data from the detector.
+- **Writing to File**: Optionally writes received data to disk.
+- **Streaming via ZMQ**: Optionally streams out the data using ZeroMQ.
+
+Each of these operations runs asynchronously and in parallel for each UDP port.
+
+
+.. note ::   
+
+    * Can be run on the same or different machine as the client.
+    * Can be configured by the client. (set file name/ discard policy, get progress etc.)
+    * Has to be started before the client runs any receiver specific command.
+
+
+Receiver Variants
+-----------------
+There are three main receiver types. How to start them is described :ref:`below<Starting up the Receiver>`.
+
++----------------------+--------------------+-----------------------------------------+--------------------------------+
+| Receiver Type        | slsReceiver        | slsMultiReceiver                        |slsFrameSynchronizer            | 
++======================+====================+=========================================+================================+
+| Modules Supported    | 1                  | Multiple                                | Multiple                       |
++----------------------+--------------------+-----------------------------------------+--------------------------------+
+| Internal Architecture| Threads per porttt | Multiple child processes of slsReceiver | Multi-threading of slsReceiver |
++----------------------+--------------------+-----------------------------------------+--------------------------------+
+| ZMQ Streaming        | Disabled by default| Disabled by default                     | Enabled, not optional          |
++----------------------+--------------------+-----------------------------------------+--------------------------------+
+| ZMQ Synchronization  | No                 | No                                      | Yes, across ports              |
++----------------------+--------------------+-----------------------------------------+--------------------------------+
+| Image Reconstruction | No                 | No                                      | No                             |
++----------------------+--------------------+-----------------------------------------+--------------------------------+
+
+
+
+
+.. _Starting up the Receiver:
+
+Starting up the Receiver
+-------------------------
 For a Single Module
     .. code-block:: bash  
+        
+        slsReceiver # default port 1954
 
-        # default port 1954
-        slsReceiver
-
-        # custom port 2012
-        slsReceiver -t2012
+        slsReceiver -t2012 # custom port 2012
 
 
 For Multiple Modules
@@ -18,57 +57,66 @@ For Multiple Modules
 
         # each receiver (for each module) requires a unique tcp port (if all on same machine)
 
-        # using slsReceiver in multiple consoles
+        # option 1 (one for each module)
         slsReceiver
         slsReceiver -t1955
 
-        # slsMultiReceiver [starting port] [number of receivers]
+        # option 2
         slsMultiReceiver 2012 2
 
-        # slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]
-        slsMultiReceiver 2012 2 1
+        # option 3
+        slsFrameSynchronizer 2012 2
+
 
 
 Client Commands 
 -----------------
 
-| One can remove **udp_dstmac** from the config file, as the slsReceiver fetches this from the **udp_ip**.
+* Client commands to the receiver begin with **rx_** or **f_** (file commands).
 
-| One can use "auto" for **udp_dstip** if one wants to use default ip of **rx_hostname**.
+* **rx_hostname** has to be the first command to the receiver so the client knows which receiver process to communicate with.
 
-| The first command to the receiver (**rx_** commands) should be **rx_hostname**. The following are the different ways to establish contact.
+* Can use 'auto' for **udp_dstip** if using 1GbE interface or the :ref:`virtual simulators<Virtual Detector Servers>`.
+
+
+To know more about detector receiver setup in the config file, please check out :ref:`the detector-receiver UDP configuration in the config file<detector udp header config>` and the :ref:`detector udp format<detector udp header>`.
+
+
+The following are the different ways to establish contact using **rx_hostname** command.
 
     .. code-block:: bash  
 
-        # default receiver tcp port (1954)
+        # ---single module---
+
+        # default receiver port at 1954
+        rx_hostname xxx
+       
+        # custom receiver port
+        rx_hostname xxx:1957 # option 1
+       
+        rx_tcpport 1957  # option 2
         rx_hostname xxx
 
-        # custom receiver port
-        rx_hostname xxx:1957
 
-        # custom receiver port
-        rx_tcpport 1954
-        rx_hostname xxx
+        # ---multi module---
 
-        # multi modules with custom ports
-        rx_hostname xxx:1955+xxx:1956+
-        
-        
-        # multi modules using increasing tcp ports when using multi detector command
+        # using increasing tcp ports
         rx_tcpport 1955
         rx_hostname xxx
 
-        # or specify multi modules with custom ports on same rxr pc
-        0:rx_tcpport 1954
+        # custom ports
+        rx_hostname xxx:1955+xxx:1958+ # option 1
+
+        0:rx_tcpport 1954 # option 2
         1:rx_tcpport 1955
         2:rx_tcpport 1956
         rx_hostname xxx
 
-        # multi modules with custom ports on different rxr pc
+        # custom ports on different receiver machines
         0:rx_tcpport 1954
         0:rx_hostname xxx
         1:rx_tcpport 1955
-        1:rx_hostname yyy
+        1:rx_hostname yyyrxr
 
 
 | Example commands:
@@ -91,245 +139,32 @@ Client Commands
         sls_detector_get -h rx_framescaught
 
 
-ZMQ: Json Header Format
-------------------------
+Example of a config file using in-built receiver
 
+.. code-block:: bash
 
-**Change in field names from slsDetectorPackage v6.x.x to v7.0.0**
+    # detector hostname
+    hostname bchip052+bchip053+
 
-* detSpec1 <- bunchId
-* detSpec2 <- reserved
-* detSpec3 <- debug
-* detSpec4 <- roundRNumber
+    # udp destination port (receiver)
+    # sets increasing destination udp ports starting at 50004
+    udp_dstport 50004
 
+    # udp destination ip (receiver)
+    0:udp_dstip 10.0.1.100
+    1:udp_dstip 10.0.2.100
 
-**Format**
+    # udp source ip (same subnet as udp_dstip)
+    0:udp_srcip 10.0.1.184
+    1:udp_srcip 10.0.2.184
 
-    .. code-block:: bash 
+    # udp destination mac - not required (picked up from udp_dstip)
+    #udp_dstmac 22:47:d5:48:ad:ef
 
-        {
-            "jsonversion": unsigned int,
-            "bitmode": unsigned int,
-            "fileIndex": unsigned long int,
-            "detshape": [
-                unsigned int,
-                unsigned int
-            ],
-            "shape": [
-                unsigned int,
-                unsigned int
-            ],
-            "size": unsigned int,
-            "acqIndex": unsigned long int,
-            "frameIndex": unsigned long int,
-            "progress": double,
-            "fname": string,
-            "data": unsigned int,
-            "completeImage": unsigned int,
+    # connects to receivers at increasing tcp port starting at 1954
+    rx_hostname mpc3434
+    # same as rx_hostname mpc3434:1954+mpc3434:1955+
 
-            "frameNumber": unsigned long long int,
-            "expLength": unsigned int,
-            "packetNumber": unsigned int,
-            "detSpec1": unsigned long int,
-            "timestamp": unsigned long int,
-            "modId": unsigned int,
-            "row": unsigned int,
-            "column": unsigned int,
-            "detSpec2": unsigned int,
-            "detSpec3": unsigned int,
-            "detSpec4": unsigned int,
-            "detType": unsigned int,
-            "version": unsigned int,
-            
-            "flipRows": unsigned int,
-            "quad": unsigned int,
-            "addJsonHeader": {
-                string : string
-            }
-        }
-
-   +--------------+----------------------------------------------+
-   |   Field      |       Description                            |
-   +--------------+----------------------------------------------+
-   | jsonversion  | Version of the json header.                  |
-   |              | Value at 4 for v6.x.x and v7.x.x             |
-   +--------------+----------------------------------------------+
-   | bitmode      | Bits per pixel [4|8|16|32]                   |
-   +--------------+----------------------------------------------+
-   | fileIndex    | Current file acquisition index               |
-   +--------------+----------------------------------------------+
-   | detshape     | Geometry of the entire detector              |
-   +--------------+----------------------------------------------+
-   | shape        | Geometry of the current port streamed out    |
-   +--------------+----------------------------------------------+
-   | size         | Size of image of current port in bytesout    |
-   +--------------+----------------------------------------------+
-   | acqIndex     | Frame number from the detector (redundant)   |
-   +--------------+----------------------------------------------+
-   | frameIndex   | Frame number of current acquisition          |
-   |              | (Starting at 0)                              |
-   +--------------+----------------------------------------------+
-   | progress     | Progress of current acquisition in %         |
-   +--------------+----------------------------------------------+
-   | fname        | Current file name                            |
-   +--------------+----------------------------------------------+
-   | data         | 1 if there is data following                 |
-   |              | 0 if dummy header                            |
-   +--------------+----------------------------------------------+
-   | completeImage| 1 if no missing packets for this frame       |
-   |              | in this port, else 0                         |
-   +--------------+----------------------------------------------+
-   | frameNumber  | Frame number                                 |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | expLength    | subframe number (32 bit eiger)               |
-   |              | or real time exposure time in 100ns (others) |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | packetNumber | Number of packets caught for that frame      |
-   +--------------+----------------------------------------------+
-   | detSpec1     | See :ref:`here<Detector Specific Fields>`    |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | timestamp    | Timestamp with 10 MHz clock                  |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | modId        | Module Id                                    |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | row          | Row number in detector                       |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | column       | Column number in detector                    |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | detSpec2     | See :ref:`here<Detector Specific Fields>`    |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | detSpec3     | See :ref:`here<Detector Specific Fields>`    |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | detSpec4     | See :ref:`here<Detector Specific Fields>`    |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | detType      | Detector type enum                           |
-   | detSpec3     | See :ref:`Detector enum<Detector Enum>`      |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | version      | Detector header version. At 2                |
-   |              | [From detector udp header]                   |
-   +--------------+----------------------------------------------+
-   | flipRows     | 1 if rows should be flipped.                 |
-   |              | Usually for Eiger bottom.                    |
-   +--------------+----------------------------------------------+
-   | quad         | 1 if its an Eiger quad.                      |
-   +--------------+----------------------------------------------+
-   | addJsonHeader| Optional custom parameters that is required  |
-   |              | for processing code.                         |
-   +--------------+----------------------------------------------+
-
-
-SLS Receiver Header Format
---------------------------
-
-It is 112 bytes and consists of:
-    * 48 bytes of the SLS Detector Header (described in :ref:`the current detector header <detector udp header>`)
-    * 64 bytes of packet mask
-
-.. code-block:: cpp 
-    
-    typedef struct {
-        uint64_t frameNumber;
-        uint32_t expLength;
-        uint32_t packetNumber;
-        uint64_t detSpec1;
-        uint64_t timestamp;
-        uint16_t modId;
-        uint16_t row;
-        uint16_t column;
-        uint16_t detSpec2;
-        uint32_t detSpec3;
-        uint16_t detSpec4;
-        uint8_t detType;
-        uint8_t version;
-    } sls_detector_header;
-
-    struct sls_receiver_header {
-        sls_detector_header detHeader; /**< is the detector header */
-        sls_bitset packetsMask;        /**< is the packets caught bit mask */
-    };
-
-
-.. note :: 
-
-    | The packetNumber in the SLS Receiver Header will be modified to number of packets caught by receiver for that frame. For eg. Jungfrau will have 128 packets per frame. If it is less, then this is a partial frame due to missing packets.
-    
-    | Furthermore, the bit mask will specify which packets have been received.
-
-
-
-
-File format
---------------
-
-Master file is in json format.
-
-The file name format is [fpath]/[fname]_dx_fy_[findex].raw, where x is module index and y is file index. **fname** is file name prefix and by default "run". **fpath** is '/' by default.
-
-
-Each acquisition will have an increasing acquisition index or findex (if file write enabled). This can be retrieved by using **findex** command. 
-
-
-Each acquisition can have multiple files (the file index number **y**), with **rx_framesperfile** being the maximum number of frames per file. The default varies for each detector type.
-
-
-Some file name examples:
-
-    .. code-block:: bash
-
-        # first file
-        path-to-file/run_d0_f0_0.raw
-
-        # second file after reaching max frames in first file
-        path-to-file/run_d0_f1_0.raw
-        
-        # second acquisition, first file
-        path-to-file/run_d0_f0_1.raw
-
-
-Each acquisition will create a master file that can be enabled/disabled using **fmaster**. This should have parameters relevant to the acquisition.
-
-
-**Binary file format**
-
-This is the default file format. 
-
-
-Each data file will consist of frames, each consisting of slsReceiver Header followed by data for 1 frame.
-
-
-Master file is of ASCII format and will also include the format of the slsReceiver Header.
-
-
-**HDF5 file formats**
-
-#. Compile the package with HDF5 option enabled
-
-    #. Using cmk script: ./cmk.sh -hj9 -d [path of hdf5 dir]
-
-    #. Enable using cmake **-DCMAKE_INSTALL_PREFIX=/path/to/hdf/installation** and **-DSLS_USE_HDF5=ON**
-
-#. Start Receiver process
-
-#. Load config file
-
-#. Set file format from client or in config file
-    .. code-block:: bash
-
-        sls_detector_put fformat hdf5
-
-
-| For multiple, modules, a virtual file linking all the modules is created. Both the data files and virtual files are linked in the master file.
 
 
 Performance 

docs/src/slsreceiverheaderformat.rst

@@ -0,0 +1,40 @@
+
+.. _sls receiver header format:
+
+SLS Receiver Header Format
+====================================================
+
+It is 112 bytes and consists of:
+    * 48 bytes of the SLS Detector Header 
+    * 64 bytes of packet mask
+
+.. code-block:: cpp 
+    
+    typedef struct {
+        uint64_t frameNumber;
+        uint32_t expLength;
+        uint32_t packetNumber;
+        uint64_t detSpec1;
+        uint64_t timestamp;
+        uint16_t modId;
+        uint16_t row;
+        uint16_t column;
+        uint16_t detSpec2;
+        uint32_t detSpec3;
+        uint16_t detSpec4;
+        uint8_t detType;
+        uint8_t version;
+    } sls_detector_header;
+
+    struct sls_receiver_header {
+        sls_detector_header detHeader; /**< is the detector header */
+        sls_bitset packetsMask;        /**< is the packets caught bit mask */
+    };
+
+
+
+| **sls_detector_header** (described in :ref:`the current detector header <detector udp header>`)
+    
+| The **packetNumber** from detector UDP header is modified in **sls_receiver_header** to number of packets caught by receiver for that frame and the bit mask for each packet caught is the **packetsMask**. The packetsMask is a total of 512 bits due to the largest number of packets per frame among our detectors.
+
+| For eg. Jungfrau has 128 packets per frame. If **packetNumeber** is 128, then this frame is complete. If it is 127 or less, it is a partial frame due to missing packets. If one would still like to use it, the **packetsMask** will specify which packet has been received or is missing.

docs/src/troubleshooting.rst

@@ -394,6 +394,14 @@ Missing first frame or next frame after a delay
 Connect the data link from the Module directly to receiver pc or to a private network.
 
 
+Mythen3
+--------
+
+Detector status is waiting even in auto timing mode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Check if the control board or the flat band cable is connected properly. If not, connect them properly and try again.
+
+
 Jungfrau
 ---------
 

docs/src/udpconfig.rst

@@ -1,4 +1,4 @@
-.. _detector udp header:
+.. _detector udp header config:
 
 
 Config file

docs/src/udpheader.rst

@@ -3,7 +3,7 @@
 Format
 =======
 
-The UDP data format for the packets consist of a common header for all detectors, followed by the data for that one packet.
+The UDP data format for the packets consist of a common header of 48 bytes for all detectors, followed by the data for that one packet.
 
 
 Current Version
@@ -11,6 +11,25 @@ Current Version
 
 **v2.0 (slsDetectorPackage v7.0.0+)**
 
+.. code-block:: cpp 
+    
+    typedef struct {
+        uint64_t frameNumber;
+        uint32_t expLength;
+        uint32_t packetNumber;
+        uint64_t detSpec1;
+        uint64_t timestamp;
+        uint16_t modId;
+        uint16_t row;
+        uint16_t column;
+        uint16_t detSpec2;
+        uint32_t detSpec3;
+        uint16_t detSpec4;
+        uint8_t detType;
+        uint8_t version;
+    } sls_detector_header;
+
+
 .. table:: <---------------------------------------------------- 8 bytes per row --------------------------------------------->
     :align: center
     :widths: 30,30,30,15,15
@@ -54,15 +73,17 @@ Description
 
 * **modId**: module ID picked up from det_id_[detector type].txt on the detector cpu.
 
-* **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command.
+* **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
 
-* **column**: column position of the module in the detector system.  It is calculated by the order of the module in hostname command, as well as the detsize command.
+* **column**: column position of the module in the detector system.  It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
 
 * **detType**: detector type from enum of detectorType in the package.
 
 * **version**: current version of the detector header (0x2).
 
 
+.. _detector enum:
+
 Detector Enum
 --------------
 

docs/src/virtualserver.rst

@@ -1,4 +1,5 @@
 .. _Virtual Detector Servers:
+
 Simulators
 ===========
 

docs/src/zmqjsonheaderformat.rst

@@ -0,0 +1,137 @@
+ZMQ: Json Header Format
+========================
+
+
+**Change in field names from slsDetectorPackage v6.x.x to v7.0.0**
+
+* detSpec1 <- bunchId
+* detSpec2 <- reserved
+* detSpec3 <- debug
+* detSpec4 <- roundRNumber
+
+
+**Format**
+
+    .. code-block:: bash 
+
+        {
+            "jsonversion": unsigned int,
+            "bitmode": unsigned int,
+            "fileIndex": unsigned long int,
+            "detshape": [
+                unsigned int,
+                unsigned int
+            ],
+            "shape": [
+                unsigned int,
+                unsigned int
+            ],
+            "size": unsigned int,
+            "acqIndex": unsigned long int,
+            "frameIndex": unsigned long int,
+            "progress": double,
+            "fname": string,
+            "data": unsigned int,
+            "completeImage": unsigned int,
+
+            "frameNumber": unsigned long long int,
+            "expLength": unsigned int,
+            "packetNumber": unsigned int,
+            "detSpec1": unsigned long int,
+            "timestamp": unsigned long int,
+            "modId": unsigned int,
+            "row": unsigned int,
+            "column": unsigned int,
+            "detSpec2": unsigned int,
+            "detSpec3": unsigned int,
+            "detSpec4": unsigned int,
+            "detType": unsigned int,
+            "version": unsigned int,
+            
+            "flipRows": unsigned int,
+            "quad": unsigned int,
+            "addJsonHeader": {
+                string : string
+            }
+        }
+
+   +--------------+----------------------------------------------+
+   |   Field      |       Description                            |
+   +--------------+----------------------------------------------+
+   | jsonversion  | Version of the json header.                  |
+   |              | Value at 4 for v6.x.x and v7.x.x             |
+   +--------------+----------------------------------------------+
+   | bitmode      | Bits per pixel [4|8|16|32]                   |
+   +--------------+----------------------------------------------+
+   | fileIndex    | Current file acquisition index               |
+   +--------------+----------------------------------------------+
+   | detshape     | Geometry of the entire detector              |
+   +--------------+----------------------------------------------+
+   | shape        | Geometry of the current port streamed out    |
+   +--------------+----------------------------------------------+
+   | size         | Size of image of current port in bytesout    |
+   +--------------+----------------------------------------------+
+   | acqIndex     | Frame number from the detector (redundant)   |
+   +--------------+----------------------------------------------+
+   | frameIndex   | Frame number of current acquisition          |
+   |              | (Starting at 0)                              |
+   +--------------+----------------------------------------------+
+   | progress     | Progress of current acquisition in %         |
+   +--------------+----------------------------------------------+
+   | fname        | Current file name                            |
+   +--------------+----------------------------------------------+
+   | data         | 1 if there is data following                 |
+   |              | 0 if dummy header                            |
+   +--------------+----------------------------------------------+
+   | completeImage| 1 if no missing packets for this frame       |
+   |              | in this port, else 0                         |
+   +--------------+----------------------------------------------+
+   | frameNumber  | Frame number                                 |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | expLength    | subframe number (32 bit eiger)               |
+   |              | or real time exposure time in 100ns (others) |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | packetNumber | Number of packets caught for that frame      |
+   +--------------+----------------------------------------------+
+   | detSpec1     | See :ref:`here<Detector Specific Fields>`    |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | timestamp    | Timestamp with 10 MHz clock                  |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | modId        | Module Id                                    |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | row          | Row number in detector                       |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | column       | Column number in detector                    |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | detSpec2     | See :ref:`here<Detector Specific Fields>`    |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | detSpec3     | See :ref:`here<Detector Specific Fields>`    |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | detSpec4     | See :ref:`here<Detector Specific Fields>`    |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | detType      | Detector type enum                           |
+   | detSpec3     | See :ref:`Detector enum<detector enum>`      |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | version      | Detector header version. At 2                |
+   |              | [From detector udp header]                   |
+   +--------------+----------------------------------------------+
+   | flipRows     | 1 if rows should be flipped.                 |
+   |              | Usually for Eiger bottom.                    |
+   +--------------+----------------------------------------------+
+   | quad         | 1 if its an Eiger quad.                      |
+   +--------------+----------------------------------------------+
+   | addJsonHeader| Optional custom parameters that is required  |
+   |              | for processing code.                         |
+   +--------------+----------------------------------------------+
+

libs/libzmq/libzmq_cmake_version.patch

@@ -0,0 +1,18 @@
+diff --git a/CMakeLists.txt b/CMakeLists.txt
+index dd3d8eb9..c0187747 100644
+--- a/CMakeLists.txt
++++ b/CMakeLists.txt
+@@ -1,11 +1,8 @@
+ # CMake build script for ZeroMQ
+ project(ZeroMQ)
+ 
+-if(${CMAKE_SYSTEM_NAME} STREQUAL Darwin)
+-  cmake_minimum_required(VERSION 3.0.2)
+-else()
+-  cmake_minimum_required(VERSION 2.8.12)
+-endif()
++cmake_minimum_required(VERSION 3.15)
++message(STATUS "Patched cmake version")
+ 
+ include(CheckIncludeFiles)
+ include(CheckCCompilerFlag)

psi-pmodules/DetectorSoftware/slsDetectorPackage/files/variants

@@ -11,4 +11,6 @@ slsDetectorPackage/8.0.1_rh7 stable cmake/3.15.5 Qt/5.12.10
 slsDetectorPackage/8.0.1_rh8 stable cmake/3.15.5 Qt/5.12.10
 slsDetectorPackage/8.0.2_rh7 stable cmake/3.15.5 Qt/5.12.10
 slsDetectorPackage/8.0.2_rh8 stable cmake/3.15.5 Qt/5.12.10
+slsDetectorPackage/9.0.0_rh8 stable cmake/3.15.5 Qt/5.12.10
+
 

pyctbgui/pyctbgui/services/ADC.py

@@ -14,6 +14,8 @@ from pyctbgui.utils.defines import Defines
 import pyctbgui.utils.pixelmap as pm
 from pyctbgui.utils.recordOrApplyPedestal import recordOrApplyPedestal
 
+from slsdet import detectorType
+
 if typing.TYPE_CHECKING:
     from pyctbgui.services import AcquisitionTab, PlotTab
 
@@ -30,6 +32,7 @@ class AdcTab(QtWidgets.QWidget):
         self.acquisitionTab: AcquisitionTab | None = None
         self.legend: LegendItem | None = None
         self.logger = logging.getLogger('AdcTab')
+        self.tengiga = True
 
     def setup_ui(self):
         self.plotTab = self.mainWindow.plotTab
@@ -42,6 +45,12 @@ class AdcTab(QtWidgets.QWidget):
         self.legend.clear()
         # subscribe to toggle legend
         self.plotTab.subscribeToggleLegend(self.updateLegend)
+        
+        if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+            self.view.checkBoxADC0_15Inv.setDisabled(True)
+            self.view.checkBoxADC16_31Inv.setDisabled(True)
+            self.view.lineEditADCInversion.setDisabled(True)
+            self.view.labelADCInversion.setDisabled(True)
 
     def initializeAllAnalogPlots(self):
         self.mainWindow.plotAnalogWaveform = pg.plot()
@@ -67,7 +76,8 @@ class AdcTab(QtWidgets.QWidget):
 
     def connect_ui(self):
         for i in range(Defines.adc.count):
-            getattr(self.view, f"checkBoxADC{i}Inv").stateChanged.connect(partial(self.setADCInv, i))
+            if self.det.type == detectorType.CHIPTESTBOARD:
+                getattr(self.view, f"checkBoxADC{i}Inv").stateChanged.connect(partial(self.setADCInv, i))
             getattr(self.view, f"checkBoxADC{i}En").stateChanged.connect(partial(self.setADCEnable, i))
             getattr(self.view, f"checkBoxADC{i}Plot").stateChanged.connect(partial(self.setADCEnablePlot, i))
             getattr(self.view, f"pushButtonADC{i}").clicked.connect(partial(self.selectADCColor, i))
@@ -77,15 +87,17 @@ class AdcTab(QtWidgets.QWidget):
         self.view.checkBoxADC0_15Plot.stateChanged.connect(partial(self.setADCEnablePlotRange, 0, Defines.adc.half))
         self.view.checkBoxADC16_31Plot.stateChanged.connect(
             partial(self.setADCEnablePlotRange, Defines.adc.half, Defines.adc.count))
-        self.view.checkBoxADC0_15Inv.stateChanged.connect(partial(self.setADCInvRange, 0, Defines.adc.half))
-        self.view.checkBoxADC16_31Inv.stateChanged.connect(
-            partial(self.setADCInvRange, Defines.adc.half, Defines.adc.count))
-        self.view.lineEditADCInversion.editingFinished.connect(self.setADCInvReg)
         self.view.lineEditADCEnable.editingFinished.connect(self.setADCEnableReg)
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.view.checkBoxADC0_15Inv.stateChanged.connect(partial(self.setADCInvRange, 0, Defines.adc.half))
+            self.view.checkBoxADC16_31Inv.stateChanged.connect(
+            partial(self.setADCInvRange, Defines.adc.half, Defines.adc.count))
+            self.view.lineEditADCInversion.editingFinished.connect(self.setADCInvReg)
 
     def refresh(self):
         self.updateADCNames()
-        self.updateADCInv()
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.updateADCInv()
         self.updateADCEnable()
 
         # ADCs Tab functions
@@ -196,9 +208,11 @@ class AdcTab(QtWidgets.QWidget):
         return decoder.decode(analog_array, pm.moench04_analog())
 
     def getADCEnableReg(self):
-        retval = self.det.adcenable
-        if self.det.tengiga:
-            retval = self.det.adcenable10g
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.tengiga = self.det.tengiga
+        retval = self.det.adcenable10g
+        if not self.tengiga:
+            retval = self.det.adcenable
         self.view.lineEditADCEnable.editingFinished.disconnect()
         self.view.lineEditADCEnable.setText("0x{:08x}".format(retval))
         self.view.lineEditADCEnable.editingFinished.connect(self.setADCEnableReg)
@@ -207,8 +221,8 @@ class AdcTab(QtWidgets.QWidget):
     def setADCEnableReg(self):
         self.view.lineEditADCEnable.editingFinished.disconnect()
         try:
-            mask = int(self.mainWindow.lineEditADCEnable.text(), 16)
-            if self.det.tengiga:
+            mask = int(self.view.lineEditADCEnable.text(), 16)
+            if self.tengiga:
                 self.det.adcenable10g = mask
             else:
                 self.det.adcenable = mask
@@ -239,7 +253,7 @@ class AdcTab(QtWidgets.QWidget):
     def setADCEnable(self, i):
         checkBox = getattr(self.view, f"checkBoxADC{i}En")
         try:
-            if self.det.tengiga:
+            if self.tengiga:
                 enableMask = manipulate_bit(checkBox.isChecked(), self.det.adcenable10g, i)
                 self.det.adcenable10g = enableMask
             else:
@@ -265,7 +279,7 @@ class AdcTab(QtWidgets.QWidget):
         for i in range(start_nr, end_nr):
             mask = manipulate_bit(checkBox.isChecked(), mask, i)
         try:
-            if self.det.tengiga:
+            if self.tengiga:
                 self.det.adcenable10g = mask
             else:
                 self.det.adcenable = mask
@@ -344,7 +358,7 @@ class AdcTab(QtWidgets.QWidget):
     def setADCInvReg(self):
         self.view.lineEditADCInversion.editingFinished.disconnect()
         try:
-            self.det.adcinvert = int(self.mainWindow.lineEditADCInversion.text(), 16)
+            self.det.adcinvert = int(self.view.lineEditADCInversion.text(), 16)
         except Exception as e:
             QtWidgets.QMessageBox.warning(self.mainWindow, "ADC Inversion Fail", str(e), QtWidgets.QMessageBox.Ok)
             pass
@@ -395,7 +409,12 @@ class AdcTab(QtWidgets.QWidget):
         self.updateADCInv()
 
     def saveParameters(self) -> list[str]:
-        return [
-            f"adcenable {self.view.lineEditADCEnable.text()}",
-            f"adcinvert {self.view.lineEditADCInversion.text()}",
-        ]
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            return [
+                f"adcenable {self.view.lineEditADCEnable.text()}",
+                f"adcinvert {self.view.lineEditADCInversion.text()}",
+            ]
+        else:
+            return [
+                f"adcenable {self.view.lineEditADCEnable.text()}"
+            ]     

pyctbgui/pyctbgui/services/Acquisition.py

@@ -7,7 +7,7 @@ import zmq
 from PyQt5 import QtWidgets, uic
 import logging
 
-from slsdet import readoutMode, runStatus
+from slsdet import readoutMode, runStatus, detectorType
 from pyctbgui.utils.defines import Defines
 from pyctbgui.utils.numpyWriter.npy_writer import NumpyFileManager
 from pyctbgui.utils.numpyWriter.npz_writer import NpzFileWriter
@@ -49,20 +49,37 @@ class AcquisitionTab(QtWidgets.QWidget):
         self.adcTab = self.mainWindow.adcTab
         self.plotTab = self.mainWindow.plotTab
         self.toggleStartButton(False)
+        if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+            self.view.labelRunF.setDisabled(True)
+            self.view.labelADCF.setDisabled(True)
+            self.view.labelADCPhase.setDisabled(True)
+            self.view.labelADCPipeline.setDisabled(True)
+            self.view.labelDBITF.setDisabled(True)
+            self.view.labelDBITPhase.setDisabled(True)
+            self.view.labelDBITPipeline.setDisabled(True)
+            self.view.spinBoxRunF.setDisabled(True)
+            self.view.spinBoxADCF.setDisabled(True)
+            self.view.spinBoxADCPhase.setDisabled(True)
+            self.view.spinBoxADCPipeline.setDisabled(True)
+            self.view.spinBoxDBITF.setDisabled(True)
+            self.view.spinBoxDBITPhase.setDisabled(True)
+            self.view.spinBoxDBITPipeline.setDisabled(True)
 
     def connect_ui(self):
         # For Acquistions Tab
         self.view.comboBoxROMode.currentIndexChanged.connect(self.setReadOut)
-        self.view.spinBoxRunF.editingFinished.connect(self.setRunFrequency)
         self.view.spinBoxTransceiver.editingFinished.connect(self.setTransceiver)
         self.view.spinBoxAnalog.editingFinished.connect(self.setAnalog)
         self.view.spinBoxDigital.editingFinished.connect(self.setDigital)
-        self.view.spinBoxADCF.editingFinished.connect(self.setADCFrequency)
-        self.view.spinBoxADCPhase.editingFinished.connect(self.setADCPhase)
-        self.view.spinBoxADCPipeline.editingFinished.connect(self.setADCPipeline)
-        self.view.spinBoxDBITF.editingFinished.connect(self.setDBITFrequency)
-        self.view.spinBoxDBITPhase.editingFinished.connect(self.setDBITPhase)
-        self.view.spinBoxDBITPipeline.editingFinished.connect(self.setDBITPipeline)
+        
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.view.spinBoxRunF.editingFinished.connect(self.setRunFrequency)
+            self.view.spinBoxADCF.editingFinished.connect(self.setADCFrequency)
+            self.view.spinBoxADCPhase.editingFinished.connect(self.setADCPhase)
+            self.view.spinBoxADCPipeline.editingFinished.connect(self.setADCPipeline)
+            self.view.spinBoxDBITF.editingFinished.connect(self.setDBITFrequency)
+            self.view.spinBoxDBITPhase.editingFinished.connect(self.setDBITPhase)
+            self.view.spinBoxDBITPipeline.editingFinished.connect(self.setDBITPipeline)
 
         self.view.checkBoxFileWriteRaw.stateChanged.connect(self.setFileWrite)
         self.view.checkBoxFileWriteNumpy.stateChanged.connect(self.setFileWriteNumpy)
@@ -77,16 +94,19 @@ class AcquisitionTab(QtWidgets.QWidget):
 
     def refresh(self):
         self.getReadout()
-        self.getRunFrequency()
         self.getTransceiver()
         self.getAnalog()
         self.getDigital()
-        self.getADCFrequency()
-        self.getADCPhase()
-        self.getADCPipeline()
-        self.getDBITFrequency()
-        self.getDBITPhase()
-        self.getDBITPipeline()
+
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.getRunFrequency()
+            self.getADCFrequency()
+            self.getADCPhase()
+            self.getADCPipeline()
+            self.getDBITFrequency()
+            self.getDBITPhase()
+            self.getDBITPipeline()
+
         self.getFileWrite()
         self.getFileName()
         self.getFilePath()
@@ -697,23 +717,39 @@ class AcquisitionTab(QtWidgets.QWidget):
         self.socket.subscribe("")
 
     def saveParameters(self) -> list[str]:
-        return [
-            f'romode {self.view.comboBoxROMode.currentText().lower()}',
-            f'runclk {self.view.spinBoxRunF.value()}',
-            f'adcclk {self.view.spinBoxADCF.value()}',
-            f'adcphase {self.view.spinBoxADCPhase.value()}',
-            f'adcpipeline {self.view.spinBoxADCPipeline.value()}',
-            f'dbitclk {self.view.spinBoxDBITF.value()}',
-            f'dbitphase {self.view.spinBoxDBITPhase.value()}',
-            f'dbitpipeline {self.view.spinBoxDBITPipeline.value()}',
-            f'fwrite {int(self.view.checkBoxFileWriteRaw.isChecked())}',
-            f'fname {self.view.lineEditFileName.text()}',
-            f'fpath {self.view.lineEditFilePath.text()}',
-            f'findex {self.view.spinBoxAcquisitionIndex.value()}',
-            f'frames {self.view.spinBoxFrames.value()}',
-            f'triggers {self.view.spinBoxTriggers.value()}',
-            f'period {self.view.spinBoxPeriod.value()} {self.view.comboBoxPeriod.currentText().lower()}',
-            f'asamples {self.view.spinBoxAnalog.value()}',
-            f'dsamples {self.view.spinBoxDigital.value()}',
-            f'tsamples {self.view.spinBoxTransceiver.value()}',
-        ]
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            return [
+                f'romode {self.view.comboBoxROMode.currentText().lower()}',
+                f'runclk {self.view.spinBoxRunF.value()}',
+                f'adcclk {self.view.spinBoxADCF.value()}',
+                f'adcphase {self.view.spinBoxADCPhase.value()}',
+                f'adcpipeline {self.view.spinBoxADCPipeline.value()}',
+                f'dbitclk {self.view.spinBoxDBITF.value()}',
+                f'dbitphase {self.view.spinBoxDBITPhase.value()}',
+                f'dbitpipeline {self.view.spinBoxDBITPipeline.value()}',
+                f'fwrite {int(self.view.checkBoxFileWriteRaw.isChecked())}',
+                f'fname {self.view.lineEditFileName.text()}',
+                f'fpath {self.view.lineEditFilePath.text()}',
+                f'findex {self.view.spinBoxAcquisitionIndex.value()}',
+                f'frames {self.view.spinBoxFrames.value()}',
+                f'triggers {self.view.spinBoxTriggers.value()}',
+                f'period {self.view.spinBoxPeriod.value()} {self.view.comboBoxPeriod.currentText().lower()}',
+                f'asamples {self.view.spinBoxAnalog.value()}',
+                f'dsamples {self.view.spinBoxDigital.value()}',
+                f'tsamples {self.view.spinBoxTransceiver.value()}',
+            ]
+        else:
+            return [
+                f'romode {self.view.comboBoxROMode.currentText().lower()}',
+                f'fwrite {int(self.view.checkBoxFileWriteRaw.isChecked())}',
+                f'fname {self.view.lineEditFileName.text()}',
+                f'fpath {self.view.lineEditFilePath.text()}',
+                f'findex {self.view.spinBoxAcquisitionIndex.value()}',
+                f'frames {self.view.spinBoxFrames.value()}',
+                f'triggers {self.view.spinBoxTriggers.value()}',
+                f'period {self.view.spinBoxPeriod.value()} {self.view.comboBoxPeriod.currentText().lower()}',
+                f'asamples {self.view.spinBoxAnalog.value()}',
+                f'dsamples {self.view.spinBoxDigital.value()}',
+                f'tsamples {self.view.spinBoxTransceiver.value()}',
+            ] 
+

pyctbgui/pyctbgui/services/DACs.py

@@ -4,7 +4,7 @@ from pathlib import Path
 from PyQt5 import QtWidgets, uic
 from pyctbgui.utils.defines import Defines
 
-from slsdet import dacIndex
+from slsdet import dacIndex, detectorType
 
 
 class DacTab(QtWidgets.QWidget):
@@ -19,7 +19,14 @@ class DacTab(QtWidgets.QWidget):
             dac = getattr(dacIndex, f"DAC_{i}")
             getattr(self.view, f"spinBoxDAC{i}").setValue(self.det.getDAC(dac)[0])
 
-        if self.det.highvoltage == 0:
+        if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+            self.view.checkBoxHighVoltage.setDisabled(True)
+            self.view.spinBoxHighVoltage.setDisabled(True)
+            self.view.labelHighVoltage.setDisabled(True)
+            self.view.labelADCVppDacName.setDisabled(True)
+            self.view.labelADCVpp.setDisabled(True)
+            self.view.comboBoxADCVpp.setDisabled(True)
+        elif self.det.highvoltage == 0:
             self.view.spinBoxHighVoltage.setDisabled(True)
             self.view.checkBoxHighVoltage.setChecked(False)
 
@@ -30,9 +37,11 @@ class DacTab(QtWidgets.QWidget):
             getattr(self.view, f"checkBoxDAC{i}").stateChanged.connect(partial(self.setDACTristate, i))
             getattr(self.view, f"checkBoxDAC{i}mV").stateChanged.connect(partial(self.getDAC, i))
 
-        self.view.comboBoxADCVpp.currentIndexChanged.connect(self.setADCVpp)
-        self.view.spinBoxHighVoltage.editingFinished.connect(self.setHighVoltage)
-        self.view.checkBoxHighVoltage.stateChanged.connect(self.setHighVoltage)
+        if self.view.comboBoxADCVpp.isEnabled():
+            self.view.comboBoxADCVpp.currentIndexChanged.connect(self.setADCVpp)
+        if self.view.checkBoxHighVoltage.isEnabled():
+            self.view.spinBoxHighVoltage.editingFinished.connect(self.setHighVoltage)
+            self.view.checkBoxHighVoltage.stateChanged.connect(self.setHighVoltage)
 
     def refresh(self):
         self.updateDACNames()
@@ -40,8 +49,10 @@ class DacTab(QtWidgets.QWidget):
             self.getDACTristate(i)
             self.getDAC(i)
 
-        self.getADCVpp()
-        self.getHighVoltage()
+        if self.view.comboBoxADCVpp.isEnabled():
+            self.getADCVpp()
+        if self.view.checkBoxHighVoltage.isEnabled():
+            self.getHighVoltage()
 
     def updateDACNames(self):
         for i, name in enumerate(self.det.getDacNames()):
@@ -165,6 +176,8 @@ class DacTab(QtWidgets.QWidget):
                 unit = " mV" if inMV else ""
                 commands.append(f"dac {i} {value}{unit}")
 
-        commands.append(f"adcvpp {self.view.comboBoxADCVpp.currentText()} mV")
-        commands.append(f"highvoltage {self.view.spinBoxHighVoltage.value()}")
+        if self.view.comboBoxADCVpp.isEnabled():
+            commands.append(f"adcvpp {self.view.comboBoxADCVpp.currentText()} mV")
+        if self.view.checkBoxHighVoltage.isEnabled():
+            commands.append(f"highvoltage {self.view.spinBoxHighVoltage.value()}")
         return commands

pyctbgui/pyctbgui/services/PowerSupplies.py

@@ -4,7 +4,7 @@ from pathlib import Path
 from PyQt5 import QtWidgets, uic
 from pyctbgui.utils.defines import Defines
 
-from slsdet import dacIndex
+from slsdet import dacIndex, detectorType
 
 
 class PowerSuppliesTab(QtWidgets.QWidget):
@@ -18,7 +18,8 @@ class PowerSuppliesTab(QtWidgets.QWidget):
         self.updateVoltageNames()
         for i in Defines.powerSupplies:
             self.getVoltage(i)
-            self.getCurrent(i)
+            if self.det.type == detectorType.CHIPTESTBOARD:
+                self.getCurrent(i)
 
     def connect_ui(self):
         for i in Defines.powerSupplies:
@@ -38,6 +39,12 @@ class PowerSuppliesTab(QtWidgets.QWidget):
             if retval == 0:
                 checkBox.setChecked(False)
                 spinBox.setDisabled(True)
+            if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+                label = getattr(self.view, f"labelI{i}")
+                label.setDisabled(True)
+        if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+            self.view.spinBoxVChip.setDisabled(True)
+
 
     def updateVoltageNames(self):
         retval = self.det.getPowerNames()
@@ -56,7 +63,10 @@ class PowerSuppliesTab(QtWidgets.QWidget):
         spinBox.editingFinished.disconnect()
         checkBox.stateChanged.disconnect()
 
-        retval = self.det.getMeasuredPower(voltageIndex)[0]
+        if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+            retval = self.det.getPower(voltageIndex)[0]
+        else:
+            retval = self.det.getMeasuredPower(voltageIndex)[0]
         # spinBox.setValue(retval)
         if retval > 1:
             checkBox.setChecked(True)
@@ -68,8 +78,9 @@ class PowerSuppliesTab(QtWidgets.QWidget):
 
         spinBox.editingFinished.connect(partial(self.setVoltage, i))
         checkBox.stateChanged.connect(partial(self.setVoltage, i))
-
-        self.getVChip()
+        
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.getVChip()
 
         # TODO: handle multiple events when pressing enter (twice)
 
@@ -91,7 +102,8 @@ class PowerSuppliesTab(QtWidgets.QWidget):
         # TODO: (properly) disconnecting and connecting to handle multiple events (out of focus and pressing enter).
         spinBox.editingFinished.connect(partial(self.setVoltage, i))
         self.getVoltage(i)
-        self.getCurrent(i)
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.getCurrent(i)
 
     def getCurrent(self, i):
         label = getattr(self.view, f"labelI{i}")

pyctbgui/pyctbgui/services/SlowADCs.py

@@ -4,7 +4,7 @@ from pathlib import Path
 from PyQt5 import uic, QtWidgets
 
 from pyctbgui.utils.defines import Defines
-from slsdet import dacIndex
+from slsdet import dacIndex, detectorType
 
 
 class SlowAdcTab(QtWidgets.QWidget):
@@ -17,7 +17,8 @@ class SlowAdcTab(QtWidgets.QWidget):
         self.det = None
 
     def setup_ui(self):
-        pass
+        if self.det.type == detectorType.XILINX_CHIPTESTBOARD:
+            self.view.pushButtonTemp.setDisabled(True)      
 
     def connect_ui(self):
         for i in range(Defines.slowAdc.count):
@@ -28,7 +29,8 @@ class SlowAdcTab(QtWidgets.QWidget):
         self.updateSlowAdcNames()
         for i in range(Defines.slowAdc.count):
             self.updateSlowAdc(i)
-        self.updateTemperature()
+        if self.det.type == detectorType.CHIPTESTBOARD:
+            self.updateTemperature()
 
     def updateSlowAdcNames(self):
         for i, name in enumerate(self.mainWindow.det.getSlowADCNames()):

pyctbgui/pyctbgui/ui/Dacs.ui

@@ -817,7 +817,7 @@ Only pressing enter on spinbox will set DAC (with this condition).</string>
      </widget>
     </item>
     <item row="18" column="0">
-     <widget class="QLabel" name="label_125">
+     <widget class="QLabel" name="labelADCVppDacName">
       <property name="text">
        <string>ADC_VPP</string>
       </property>

pyctbgui/pyctbgui/ui/acquisition.ui

@@ -118,7 +118,7 @@
      </widget>
     </item>
     <item row="1" column="4">
-     <widget class="QLabel" name="label_70">
+     <widget class="QLabel" name="labelRunF">
       <property name="text">
        <string>Run Clock Frequency (MHz):</string>
       </property>
@@ -218,7 +218,7 @@
    </property>
    <layout class="QGridLayout" name="gridLayout_6">
     <item row="2" column="3">
-     <widget class="QLabel" name="label_74">
+     <widget class="QLabel" name="labelDBITF">
       <property name="minimumSize">
        <size>
         <width>200</width>
@@ -231,7 +231,7 @@
      </widget>
     </item>
     <item row="2" column="0">
-     <widget class="QLabel" name="label_71">
+     <widget class="QLabel" name="labelADCF">
       <property name="sizePolicy">
        <sizepolicy hsizetype="Minimum" vsizetype="Preferred">
         <horstretch>0</horstretch>
@@ -278,7 +278,7 @@
      </widget>
     </item>
     <item row="4" column="3">
-     <widget class="QLabel" name="label_76">
+     <widget class="QLabel" name="labelDBITPipeline">
       <property name="text">
        <string>DBIT Pipeline:</string>
       </property>
@@ -338,21 +338,21 @@
      </widget>
     </item>
     <item row="4" column="0">
-     <widget class="QLabel" name="label_73">
+     <widget class="QLabel" name="labelADCPipeline">
       <property name="text">
        <string>ADC Pipeline:</string>
       </property>
      </widget>
     </item>
     <item row="3" column="0">
-     <widget class="QLabel" name="label_72">
+     <widget class="QLabel" name="labelADCPhase">
       <property name="text">
        <string>ADC Clock Phase (a.u.):</string>
       </property>
      </widget>
     </item>
     <item row="3" column="3">
-     <widget class="QLabel" name="label_75">
+     <widget class="QLabel" name="labelDBITPhase">
       <property name="text">
        <string>DBIT Clock Phase (a.u.):</string>
       </property>

pyctbgui/pyctbgui/ui/adc.ui

@@ -19,7 +19,7 @@
   <property name="windowTitle">
    <string>Form</string>
   </property>
-  <widget class="QFrame" name="frame_7">
+  <widget class="QFrame" name="frame_ADC">
    <property name="geometry">
     <rect>
      <x>0</x>
@@ -3142,7 +3142,7 @@
       </property>
       <layout class="QGridLayout" name="gridLayout_20">
        <item row="0" column="0">
-        <widget class="QLabel" name="label_67">
+        <widget class="QLabel" name="labelADCInversion">
          <property name="font">
           <font>
            <pointsize>10</pointsize>
@@ -3188,7 +3188,7 @@
         </widget>
        </item>
        <item row="0" column="3">
-        <widget class="QLabel" name="label_68">
+        <widget class="QLabel" name="labelADCEnable">
          <property name="font">
           <font>
            <pointsize>10</pointsize>

pyctbgui/pyctbgui/ui/slowAdcs.ui

@@ -19,7 +19,7 @@
   <property name="windowTitle">
    <string>Form</string>
   </property>
-  <widget class="QFrame" name="frame_4">
+  <widget class="QFrame" name="frame_slowadcs">
    <property name="geometry">
     <rect>
      <x>0</x>

pyproject.toml

@@ -0,0 +1,37 @@
+[tool.scikit-build.metadata.version]
+provider = "scikit_build_core.metadata.regex"
+input = "VERSION"
+regex = '^(?P<version>\d+(?:\.\d+)*(?:[\.\+\w]+)?)$'
+result = "{version}" 
+
+[build-system]
+requires = [ "scikit-build-core>=0.10", "pybind11", "numpy",]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "slsdet"
+dynamic = ["version"]
+dependencies = [
+    "numpy", 
+]
+
+[tool.cibuildwheel]
+before-all = "uname -a"
+build = "cp{311,312,313}-manylinux_x86_64"
+
+[tool.scikit-build.build]
+verbose = true
+
+[tool.scikit-build.cmake]
+build-type = "Release"
+
+[tool.scikit-build.install]
+components = [ "python",]
+
+[tool.scikit-build.cmake.define]
+SLS_USE_RECEIVER = "OFF"
+SLS_USE_RECEIVER_BINARIES = "OFF"
+SLS_USE_TEXTCLIENT = "OFF"
+SLS_BUILD_SHARED_LIBRARIES = "OFF"
+SLS_USE_PYTHON = "ON"
+SLS_INSTALL_PYTHONEXT = "ON"

python/CMakeLists.txt

@@ -20,7 +20,7 @@ target_link_libraries(_slsdet PUBLIC
 
 
 set_target_properties(_slsdet PROPERTIES
-                        LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
+                        LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin/slsdet
                     )
 
 #Copy Python code 
@@ -49,7 +49,6 @@ set( PYTHON_FILES
     slsdet/temperature.py
     slsdet/lookup.py
     slsdet/utils.py
-
 )
 
 foreach(FILE ${PYTHON_FILES})
@@ -58,7 +57,6 @@ foreach(FILE ${PYTHON_FILES})
 
 endforeach(FILE ${PYTHON_FILES})
 
-
 configure_file( scripts/basic.py  
     ${CMAKE_BINARY_DIR}/basic.py 
 )
@@ -66,12 +64,29 @@ configure_file( scripts/test_virtual.py
     ${CMAKE_BINARY_DIR}/test_virtual.py 
 )
 
+configure_file(scripts/frameSynchronizerPullSocket.py 
+    ${CMAKE_BINARY_DIR}/bin/frameSynchronizerPullSocket.py COPYONLY)
+
+
+configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/../VERSION  
+    ${CMAKE_BINARY_DIR}/bin/slsdet/VERSION
+)
 
 if(SLS_INSTALL_PYTHONEXT)
     install(TARGETS _slsdet
         EXPORT "${TARGETS_EXPORT_NAME}"
-        LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/python
+        LIBRARY DESTINATION slsdet
+        COMPONENT python
     )
+    install(
+        FILES ${PYTHON_FILES} 
+        DESTINATION slsdet
+        COMPONENT python
+        )
+    install(
+        FILES ../VERSION 
+        DESTINATION slsdet
+        COMPONENT python
+        )
 
-    install(FILES ${PYTHON_FILES} DESTINATION ${CMAKE_INSTALL_PREFIX}/python/slsdet)
-endif()
+endif()

python/scripts/frameSynchronizerPullSocket.py

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+# Script to get combined zmq packets from frame synchronizer using pull zmq sockets
+import json
+import zmq
+
+c = zmq.Context()
+s = c.socket(zmq.PULL)
+s.connect("tcp://127.0.0.1:5555")
+
+while True:
+     m = s.recv_multipart()
+     for p in m:
+         if p.startswith(b"{"):
+             print(p.decode().strip())
+         else:
+             print("binary")
+     print("--------")
+

python/scripts/generate_functions.py

@@ -123,6 +123,9 @@ def visit(node):
     if node.kind == cindex.CursorKind.CLASS_DECL:
         if node.displayname == "Detector":
             for child in node.get_children():
+                # Skip assignment operators
+                if child.kind == cindex.CursorKind.CXX_METHOD and child.spelling == "operator=":
+                    continue
                 if (
                     child.kind == cindex.CursorKind.CXX_METHOD
                     and child.access_specifier == cindex.AccessSpecifier.PUBLIC

python/setup.py

@@ -1,73 +0,0 @@
-# SPDX-License-Identifier: LGPL-3.0-or-other
-# Copyright (C) 2021 Contributors to the SLS Detector Package
-"""
-Setup file for slsdet
-Build upon the pybind11 example found here: https://github.com/pybind/python_example
-"""
-
-import os
-import sys
-from setuptools import setup, find_packages
-from pybind11.setup_helpers import Pybind11Extension, build_ext
-
-
-import subprocess
-def get_git_tag():
-    try:
-        return subprocess.check_output(['git', 'describe', '--tags', '--abbrev=0']).strip().decode('utf-8')
-    except subprocess.CalledProcessError:
-        return 'developer'
-__version__ = get_git_tag()
-
-
-def get_conda_path():
-    """
-    Keep this a function if we need some fancier logic later
-    """
-    print('Prefix: ', os.environ['CONDA_PREFIX'])
-    return os.environ['CONDA_PREFIX']
-
-
-#TODO migrate to CMake build or fetch files from cmake? 
-ext_modules = [
-    Pybind11Extension(
-        '_slsdet',
-        ['src/main.cpp',
-        'src/enums.cpp',
-        'src/current.cpp',
-        'src/detector.cpp',
-        'src/network.cpp',
-        'src/pattern.cpp',
-        'src/scan.cpp',
-        'src/duration.cpp',
-        'src/DurationWrapper.cpp',
-        'src/pedestal.cpp',
-        ]
-        
-        
-        ,
-        include_dirs=[
-            os.path.join(get_conda_path(), 'include'),
-
-        ],
-        libraries=['SlsDetector', 'SlsSupport', 'SlsReceiver'],
-        library_dirs=[
-            os.path.join(get_conda_path(), 'lib'),
-        ],
-        language='c++'
-    ),
-]
-
-setup(
-    name='slsdet',
-    version=__version__,
-    author='Erik Frojdh',
-    author_email='erik.frojdh@psi.ch',
-    url='https://github.com/slsdetectorgroup/slsDetectorPackage',
-    description='Detector API for SLS Detector Group detectors',
-    long_description='',
-    packages=find_packages(exclude=['contrib', 'docs', 'tests']),
-    ext_modules=ext_modules,
-    cmdclass={"build_ext": build_ext},
-    zip_safe=False,
-)

python/slsdet/__init__.py

@@ -14,7 +14,7 @@ from .moench import Moench
 from .pattern import Pattern, patternParameters
 from .gaincaps import Mythen3GainCapsWrapper
 
-import _slsdet
+from . import _slsdet
 xy = _slsdet.xy
 defs = _slsdet.slsDetectorDefs
 
@@ -22,6 +22,7 @@ defs = _slsdet.slsDetectorDefs
 from .enums import *
 from .defines import *
 
+
 IpAddr = _slsdet.IpAddr
 MacAddr = _slsdet.MacAddr
 scanParameters = _slsdet.scanParameters
@@ -29,12 +30,17 @@ currentSrcParameters = _slsdet.currentSrcParameters
 DurationWrapper = _slsdet.DurationWrapper
 pedestalParameters = _slsdet.pedestalParameters
 
-
-import subprocess
-def get_git_tag():
+import os
+def read_version():
     try:
-        return subprocess.check_output(['git', 'describe', '--tags', '--abbrev=0']).strip().decode('utf-8')
-    except subprocess.CalledProcessError:
-        return 'developer'
-__version__ = get_git_tag()
+        version_file = os.path.join(os.path.dirname(__file__), 'VERSION')
+        with open(version_file, "r") as f:
+            return f.read().strip()
+    except:
+        raise RuntimeError("VERSION file not found in slsdet package from init.py")
+    
+__version__ = read_version()
+
+
+
 

python/slsdet/ctb.py

@@ -4,7 +4,7 @@ from .detector import Detector, freeze
 from .utils import element_if_equal
 from .dacs import DetectorDacs, NamedDacs
 from .powers import DetectorPowers, NamedPowers
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/dacs.py

@@ -3,7 +3,7 @@
 from .detector_property import DetectorProperty
 from functools import partial
 import numpy as np
-import _slsdet
+from . import _slsdet
 from .detector import freeze
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 class Dac(DetectorProperty):

python/slsdet/detector.py

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
-from _slsdet import CppDetectorApi
-from _slsdet import slsDetectorDefs
-from _slsdet import IpAddr, MacAddr
+from ._slsdet import CppDetectorApi
+from ._slsdet import slsDetectorDefs
+from ._slsdet import IpAddr, MacAddr
 
 runStatus = slsDetectorDefs.runStatus
 timingMode = slsDetectorDefs.timingMode
@@ -15,7 +15,7 @@ defs = slsDetectorDefs
 
 from .utils import element_if_equal, all_equal, get_set_bits, list_to_bitmask
 from .utils import Geometry, to_geo, element, reduce_time, is_iterable, hostname_list
-from _slsdet import xy
+from ._slsdet import xy
 from .gaincaps import Mythen3GainCapsWrapper
 from . import utils as ut
 from .proxy import JsonProxy, SlowAdcProxy, ClkDivProxy, MaxPhaseProxy, ClkFreqProxy, PatLoopProxy, PatNLoopProxy, PatWaitProxy, PatWaitTimeProxy 
@@ -151,6 +151,10 @@ class Detector(CppDetectorApi):
     def hostname(self):
         """Frees shared memory and sets hostname (or IP address) of all modules concatenated by + 
         Virtual servers can already use the port in hostname separated by ':' and ports incremented by 2 to accomodate the stop server as well.
+
+        Note
+        -----
+        The row and column values in the udp/zmq header are affected by the order in this command and the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on. This only affects row and column in udp/zmq header.
         
         Example
         -------
@@ -2566,7 +2570,7 @@ class Detector(CppDetectorApi):
 
         Note
         -----
-        By default, the on-chip gain switching is active during the entire exposure. This mode disables the on-chip gain switching comparator automatically after 93.75% of exposure time (only for longer than 100us). The % is only for chipv1.0, the duration can be set for chipv1.1.\n
+        By default, the on-chip gain switching is active during the entire exposure. This mode disables the on-chip gain switching comparator automatically and the duration is set using compdisabletime.\n
         Default is 0 or this mode disabled (comparator enabled throughout). 1 enables mode. 0 disables mode. 
         """
         return self.getAutoComparatorDisable()
@@ -2580,10 +2584,6 @@ class Detector(CppDetectorApi):
     def compdisabletime(self):
         """[Jungfrau] Time before end of exposure when comparator is disabled. 
 
-        Note
-        -----
-        It is only possible for chipv1.1.
-
         :getter: always returns in seconds. To get in DurationWrapper, use getComparatorDisableTime
 
         Example
@@ -2913,7 +2913,7 @@ class Detector(CppDetectorApi):
     @property
     @element
     def timing_info_decoder(self):
-        """[Jungfrau] [Jungfrau] Advanced Command and only for SWISSFEL and SHINE. Sets the bunch id or timing info decoder. Default is SWISSFEL.
+        """[Jungfrau] [Jungfrau] Advanced Command and only for SWISSFEL and SHINE. Sets the bunch id or timing info decoder. Default is SWISSFEL. Only allowed for pcbv2.0.
         Enum: timingInfoDecoder
         """
         return self.getTimingInfoDecoder()

python/slsdet/eiger.py

@@ -11,7 +11,7 @@ Created on Wed Dec  6 11:51:18 2017
 from .detector import Detector
 from .temperature import Temperature, DetectorTemperature
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/enums.py

@@ -15,8 +15,8 @@ if dt === detectorType.EIGER:
 """
 
 
-import _slsdet
+from . import _slsdet
 for name, cls in _slsdet.slsDetectorDefs.__dict__.items():
     if isinstance(cls, type):
-        exec(f'{name} = {cls.__module__}.{cls.__qualname__}')
+        exec(f'{name} = _slsdet.{cls.__qualname__}')
 

python/slsdet/gaincaps.py

@@ -1,6 +1,6 @@
 
 
-import _slsdet
+from . import _slsdet
 gc = _slsdet.slsDetectorDefs.M3_GainCaps
 
 

python/slsdet/gotthard.py

@@ -9,7 +9,7 @@ This file contains the specialization for the Moench detector
 
 from .detector import Detector, freeze
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/gotthard2.py

@@ -11,7 +11,7 @@ from .detector import Detector, freeze
 
 # from .adcs import Adc, DetectorAdcs
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/jungfrau.py

@@ -11,7 +11,7 @@ from .detector import Detector, freeze
 
 # from .adcs import Adc, DetectorAdcs
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 
@@ -24,7 +24,7 @@ class JungfrauDacs(DetectorDacs):
              ('vdd_prot',   dacIndex.VDD_PROT, 0, 4000,    3000),
              ('vin_com',    dacIndex.VIN_COM, 0, 4000,    1053),
              ('vref_prech', dacIndex.VREF_PRECH, 0, 4000,    1450),
-             ('vb_pixbuff', dacIndex.VB_PIXBUF, 0, 4000,     750),
+             ('vb_pixbuf', dacIndex.VB_PIXBUF, 0, 4000,     750),
              ('vb_ds',      dacIndex.VB_DS, 0, 4000,    1000),
              ('vref_ds',    dacIndex.VREF_DS, 0, 4000,     480),
              ('vref_comp',  dacIndex.VREF_COMP, 0, 4000,     420),

python/slsdet/moench.py

@@ -9,7 +9,7 @@ This file contains the specialization for the Moench detector
 
 from .detector import Detector, freeze
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/mythen3.py

@@ -11,7 +11,7 @@ from .detector import Detector, freeze
 
 # from .adcs import Adc, DetectorAdcs
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 gc_enums = _slsdet.slsDetectorDefs.M3_GainCaps
 from .detector_property import DetectorProperty

python/slsdet/pattern.py

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
-import _slsdet
+from . import _slsdet
 
-from _slsdet import Pattern
+from ._slsdet import Pattern
 
 
 class patternParameters(_slsdet.patternParameters):

python/slsdet/powers.py

@@ -3,7 +3,7 @@
 from .detector_property import DetectorProperty
 from functools import partial
 import numpy as np
-import _slsdet
+from . import _slsdet
 from .detector import freeze
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 class Power(DetectorProperty):

python/slsdet/proxy.py

@@ -3,7 +3,7 @@
 from .utils import element_if_equal
 from .enums import dacIndex
 from .defines import M3_MAX_PATTERN_LEVELS, MAX_PATTERN_LEVELS
-from _slsdet import slsDetectorDefs
+from ._slsdet import slsDetectorDefs
 detectorType = slsDetectorDefs.detectorType
 
 

python/slsdet/utils.py

@@ -6,7 +6,7 @@ but not directly used in controlling the detector
 """
 
 from collections import namedtuple
-import _slsdet  #C++ lib
+from . import _slsdet  #C++ lib
 import functools
 import datetime as dt
 import pathlib

python/src/detector.cpp

@@ -21,11 +21,13 @@ void init_det(py::module &m) {
     using sls::Positions;
     using sls::Result;
 
+    m.def("freeSharedMemory",
+          (void (*)(const int, const int)) & sls::freeSharedMemory,
+          py::arg() = 0, py::arg() = -1);
+
     py::class_<Detector> CppDetectorApi(m, "CppDetectorApi");
     CppDetectorApi.def(py::init<int>());
 
-    CppDetectorApi.def("freeSharedMemory",
-                       (void (Detector::*)()) & Detector::freeSharedMemory);
     CppDetectorApi.def("loadConfig",
                        (void (Detector::*)(const std::string &)) &
                            Detector::loadConfig,

python/src/detector_in.cpp

@@ -18,8 +18,10 @@ void init_det(py::module &m) {
     using sls::Positions;
     using sls::Result;
 
+    m.def("freeSharedMemory", (void (*)(const int, const int)) &sls::freeSharedMemory, py::arg() = 0, py::arg() = -1);
+    
     py::class_<Detector> CppDetectorApi(m, "CppDetectorApi");
     CppDetectorApi.def(py::init<int>());
-
+    
         [[FUNCTIONS]]
 }

python/src/duration.cpp

@@ -1,3 +1,4 @@
+#include <chrono>
 #include "py_headers.h"
 
 #include "DurationWrapper.h"
@@ -19,4 +20,25 @@ void init_duration(py::module &m) {
                << " count: " << self.count() << ")";
             return ss.str();
         });
+
+    m.def(
+        "test_return_DurationWrapper",
+        []() {
+            DurationWrapper t(1.3);
+            return t;
+        },
+        R"(
+          Test function to return a DurationWrapper object. Ensures that the automatic conversion in typecaster.h works.
+          )");
+
+    m.def(
+        "test_duration_to_ns",
+        [](const std::chrono::nanoseconds t) {
+            //Duration wrapper is used to be able to convert from time in python to chrono::nanoseconds
+            //return count to have something to test 
+            return t.count();
+        },
+        R"(
+          Test function convert DurationWrapper or number to chrono::ns. Ensures that the automatic conversion in typecaster.h works.
+          )"); // default value to test the default constructor
 }

python/src/typecaster.h

@@ -54,11 +54,16 @@ template <> struct type_caster<std::chrono::nanoseconds> {
                 value = duration_cast<nanoseconds>(duration<double>(PyFloat_AsDouble(src.ptr())));
                 return true;
             }
+            // If invoked with an int we assume it is nanoseconds and convert, same as in chrono.h
+            if (PyLong_Check(src.ptr())) {
+                value = duration_cast<nanoseconds>(duration<int64_t>(PyLong_AsLongLong(src.ptr())));
+                return true;
+            }
 
 
             // Lastly if we were actually called with a DurationWrapper object we get
             // the number of nanoseconds and create a std::chrono::nanoseconds from it
-            py::object py_cls = py::module::import("_slsdet").attr("DurationWrapper");
+            py::object py_cls = py::module::import("slsdet._slsdet").attr("DurationWrapper");
             if (py::isinstance(src, py_cls)){
                 sls::DurationWrapper *cls = src.cast<sls::DurationWrapper *>();
                 value = nanoseconds(cls->count());
@@ -77,7 +82,7 @@ template <> struct type_caster<std::chrono::nanoseconds> {
          * set the count from chrono::nanoseconds and return
          */
         static handle cast(std::chrono::nanoseconds src, return_value_policy /* policy */, handle /* parent */) {
-            py::object py_cls = py::module::import("_slsdet").attr("DurationWrapper");
+            py::object py_cls = py::module::import("slsdet._slsdet").attr("DurationWrapper");
             py::object* obj = new py::object;
             *obj = py_cls();
             sls::DurationWrapper *dur = obj->cast<sls::DurationWrapper *>();

python/tests/test_DurationWrapper.py

@@ -0,0 +1,58 @@
+import pytest
+
+from slsdet import DurationWrapper
+
+#import the compiled extension to use test functions for the automatic conversion
+from slsdet import _slsdet
+
+
+def test_default_construction_of_DurationWrapper():
+    """Test default construction of DurationWrapper"""
+    t = DurationWrapper()
+    assert t.count() == 0
+    assert t.total_seconds() == 0
+
+def test_construction_of_DurationWrapper():
+    """Test construction of DurationWrapper with total_seconds"""
+    t = DurationWrapper(5)
+    assert t.count() == 5e9
+    assert t.total_seconds() == 5
+
+def test_set_count_on_DurationWrapper():
+    """Test set_count on DurationWrapper"""
+    t = DurationWrapper()
+    t.set_count(10)
+    assert t.count() == 10
+    assert t.total_seconds() == 10e-9
+    t.set_count(0)
+    assert t.count() == 0
+    assert t.total_seconds() == 0
+
+
+def test_return_a_DurationWrapper_from_cpp():
+    """Test returning a DurationWrapper from C++"""
+    t = _slsdet.test_return_DurationWrapper()
+    assert t.count() == 1.3e9
+    assert t.total_seconds() == 1.3
+
+def test_call_a_cpp_function_with_a_duration_wrapper():
+    """C++ functions can accept a DurationWrapper"""
+    t = DurationWrapper(5)
+    assert _slsdet.test_duration_to_ns(t) == 5e9
+    
+def test_call_a_cpp_function_converting_number_to_DurationWrapper():
+    """int and float can be converted to std::chrono::nanoseconds"""
+    assert _slsdet.test_duration_to_ns(0) == 0
+    assert _slsdet.test_duration_to_ns(3) == 3e9
+    assert _slsdet.test_duration_to_ns(1.3) == 1.3e9
+    assert _slsdet.test_duration_to_ns(10e-9) == 10
+
+def test_call_a_cpp_function_with_datetime_timedelta():
+    """datetime.timedelta can be converted to std::chrono::nanoseconds"""
+    import datetime
+    t = datetime.timedelta(seconds=5)
+    assert _slsdet.test_duration_to_ns(t) == 5e9
+    t = datetime.timedelta(seconds=0)
+    assert _slsdet.test_duration_to_ns(t) == 0
+    t = datetime.timedelta(seconds=1.3)
+    assert _slsdet.test_duration_to_ns(t) == 1.3e9

serverBin/ctbDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/ctbDetectorServer/bin/ctbDetectorServer_developer

serverBin/ctbDetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/ctbDetectorServer/bin/ctbDetectorServerv9.1.0

serverBin/eigerDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/eigerDetectorServer/bin/eigerDetectorServer_developer

serverBin/eigerDetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/eigerDetectorServer/bin/eigerDetectorServerv9.0.0

serverBin/gotthard2DetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/gotthard2DetectorServer/bin/gotthard2DetectorServer_developer

serverBin/gotthard2DetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/gotthard2DetectorServer/bin/gotthard2DetectorServerv9.0.0

serverBin/gotthardDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/gotthardDetectorServer/bin/gotthardDetectorServer_developer

serverBin/gotthardDetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/gotthardDetectorServer/bin/gotthardDetectorServerv9.0.0

serverBin/jungfrauDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/jungfrauDetectorServer/bin/jungfrauDetectorServer_developer

serverBin/jungfrauDetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/jungfrauDetectorServer/bin/jungfrauDetectorServerv9.1.0

serverBin/moenchDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/moenchDetectorServer/bin/moenchDetectorServer_developer

serverBin/moenchDetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/moenchDetectorServer/bin/moenchDetectorServerv9.0.0

serverBin/mythen3DetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/mythen3DetectorServer/bin/mythen3DetectorServer_developer

serverBin/mythen3DetectorServerv9.1.1

@@ -0,0 +1 @@
+../slsDetectorServers/mythen3DetectorServer/bin/mythen3DetectorServerv9.1.1

serverBin/xilinx_ctbDetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/xilinx_ctbDetectorServer/bin/xilinx_ctbDetectorServerv9.1.0