bug fix in startDetector vector

updatemode

.clang-tidy

@@ -18,7 +18,8 @@ Checks:          '*,
                     -google-readability-todo, 
                     -google-readability-braces-around-statements,
                     -modernize-use-trailing-return-type,
-                    -readability-isolate-declaration'
+                    -readability-isolate-declaration,
+                    -llvmlibc-*'
 
 HeaderFilterRegex: \.h
 AnalyzeTemporaryDtors: false

.travis.yml

@@ -31,7 +31,7 @@ script:
 
 deploy:
   provider: script
-  script: find $HOME/miniconda/envs/testenv/conda-bld/${TRAVIS_OS_NAME}-64 -name "*.tar.bz2" -exec anaconda -t $CONDA_TOKEN upload --force {} \;
+  script: find $HOME/miniconda/envs/testenv/conda-bld/${TRAVIS_OS_NAME}-64 -name "*.tar.bz2" -exec anaconda -v --show-traceback -t $CONDA_TOKEN upload --force {} \;
   on:
     branch: developer
     tags: true

CMakeLists.txt

@@ -1,12 +1,17 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 cmake_minimum_required(VERSION 3.12)
 project(slsDetectorPackage)
-set(PROJECT_VERSION 5.0.0)
-include(CheckIPOSupported)
+set(PROJECT_VERSION 6.1.1)
+
 set(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG")
 
 cmake_policy(SET CMP0074 NEW)
 include(cmake/project_version.cmake)
 
+#functions to add compiler flags
+include(cmake/SlsAddFlag.cmake)
+
 # Include additional modules that are used unconditionally
 include(GNUInstallDirs)
 
@@ -32,13 +37,16 @@ if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
     set(SLS_MASTER_PROJECT ON)
 endif()
 
-option (SLS_USE_HDF5 "HDF5 File format" OFF)
-option (SLS_USE_TEXTCLIENT "Text Client" ON)
-option (SLS_USE_RECEIVER "Receiver" ON)
-option (SLS_USE_GUI "GUI" OFF)
-option (SLS_USE_SIMULATOR "Simulator" OFF)
-option (SLS_USE_TESTS "TESTS" OFF)
-option (SLS_USE_INTEGRATION_TESTS "Integration Tests" OFF)
+option(SLS_USE_HDF5 "HDF5 File format" OFF)
+option(SLS_BUILD_SHARED_LIBRARIES "Build shared libaries" ON)
+option(SLS_USE_TEXTCLIENT "Text Client" ON)
+option(SLS_USE_DETECTOR "Detector libs" ON)
+option(SLS_USE_RECEIVER "Receiver" ON)
+option(SLS_USE_RECEIVER_BINARIES "Receiver binaries" ON)
+option(SLS_USE_GUI "GUI" OFF)
+option(SLS_USE_SIMULATOR "Simulator" OFF)
+option(SLS_USE_TESTS "TESTS" OFF)
+option(SLS_USE_INTEGRATION_TESTS "Integration Tests" OFF)
 option(SLS_USE_SANITIZER "Sanitizers for debugging" OFF)
 option(SLS_USE_PYTHON "Python bindings" OFF)
 option(SLS_USE_CTBGUI "ctb GUI" OFF)
@@ -48,8 +56,20 @@ option(SLS_TUNE_LOCAL "tune to local machine" OFF)
 option(SLS_DEVEL_HEADERS "install headers for devel" OFF)
 option(SLS_USE_MOENCH "compile zmq and post processing for Moench" OFF)
 
-# set(ClangFormat_BIN_NAME clang-format)
-set(ClangFormat_EXCLUDE_PATTERNS  "build/" 
+#Convenience option to switch off defaults when building Moench binaries only
+option(SLS_BUILD_ONLY_MOENCH "compile only Moench" OFF)
+if(SLS_BUILD_ONLY_MOENCH)
+    message(STATUS "Build MOENCH binaries only!")
+    set(SLS_BUILD_SHARED_LIBRARIES OFF CACHE BOOL "Disabled for MOENCH_ONLY" FORCE)
+    set(SLS_USE_TEXTCLIENT OFF CACHE BOOL "Disabled for MOENCH_ONLY" FORCE)
+    set(SLS_USE_DETECTOR OFF CACHE BOOL "Disabled for MOENCH_ONLY" FORCE)
+    set(SLS_USE_RECEIVER OFF CACHE BOOL "Disabled for MOENCH_ONLY" FORCE)
+    set(SLS_USE_RECEIVER_BINARIES OFF CACHE BOOL "Disabled for MOENCH_ONLY" FORCE)
+    set(SLS_USE_MOENCH ON CACHE BOOL "Enable" FORCE)
+endif()
+
+
+set(ClangFormat_EXCLUDE_PATTERNS    "build/" 
                                     "libs/" 
                                     "slsDetectorCalibration/" 
                                     "ctbGui/" 
@@ -59,22 +79,9 @@ set(ClangFormat_EXCLUDE_PATTERNS  "build/"
                                     ${CMAKE_BINARY_DIR})
 find_package(ClangFormat)
 
-#Enable LTO if available
-check_ipo_supported(RESULT SLS_LTO_AVAILABLE)
 
 
-# # Use ld.gold if it is available and isn't disabled explicitly
-# option(SLS_USE_LD_GOLD "Use GNU gold linker" ON)
-# if (SLS_USE_LD_GOLD)
-#     execute_process(COMMAND ${CMAKE_C_COMPILER} -fuse-ld=gold -Wl,--version ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)
-#     if ("${LD_VERSION}" MATCHES "GNU gold")
-#         set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
-#         set(CMAKE_STATIC_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
-#         set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
-#     else ()
-#         message(WARNING "GNU gold linker isn't available, using the default system linker.")
-#     endif ()
-# endif ()
+
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
@@ -83,6 +90,16 @@ if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
 endif()
 
 
+#Enable LTO if available
+include(CheckIPOSupported)
+check_ipo_supported(RESULT SLS_LTO_AVAILABLE)
+if((CMAKE_BUILD_TYPE STREQUAL "Release") AND SLS_LTO_AVAILABLE)
+    message(STATUS "Building with link time optimization")
+else()
+    message(STATUS "Building without link time optimization")
+endif()
+
+
 #Add two fake libraries to manage options
 add_library(slsProjectOptions INTERFACE)
 add_library(slsProjectWarnings INTERFACE)
@@ -90,7 +107,7 @@ target_compile_features(slsProjectOptions INTERFACE cxx_std_11)
 target_compile_options(slsProjectWarnings INTERFACE 
                                             -Wall
                                             -Wextra
-                                            -Wno-unused-parameter #Needs to be slowly mitigated
+                                            -Wno-unused-parameter
                                             # -Wold-style-cast
                                             -Wnon-virtual-dtor
                                             -Woverloaded-virtual
@@ -101,40 +118,45 @@ target_compile_options(slsProjectWarnings INTERFACE
                                             -Wvla
                                             -Wdouble-promotion
                                             -Werror=return-type
-
                                  )
 
+#Settings for C code
+add_library(slsProjectCSettings INTERFACE)
+target_compile_options(slsProjectCSettings INTERFACE 
+                                            -std=gnu99 #fixed
+                                            -Wall
+                                            -Wextra
+                                            -Wno-unused-parameter
+                                            -Wdouble-promotion
+                                            -Wformat=2
+                                            -Wredundant-decls
+                                            -Wdouble-promotion
+                                            -Werror=return-type
+                                )
+
 
 #Testing for minimum version for compilers
 if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
     if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 3.2)
         message(FATAL_ERROR "Clang version must be at least 3.2!")
     endif()
-    target_compile_options(slsProjectWarnings INTERFACE -Wshadow) #Clag does not warn on constructor
 elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
     if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.8)
             message(FATAL_ERROR "GCC version must be at least 4.8!")
     endif()
-
     if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 5)
             target_compile_options(slsProjectWarnings INTERFACE 
                                              -Wno-missing-field-initializers)
     endif()
-    
-    if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER 6.0)
-        target_compile_options(slsProjectWarnings INTERFACE 
-                                                -Wno-misleading-indentation # mostly in rapidjson remove using clang format
-                                                -Wduplicated-cond
-                                                -Wnull-dereference )
-
-    endif()
-    if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER 8.0)
-        target_compile_options(slsProjectWarnings INTERFACE 
-                                                -Wno-class-memaccess )
-
-    endif()
 endif()
 
+# Add or disable warnings depending on if the compiler supports them 
+# The function checks internally and sets HAS_warning-name
+sls_enable_cxx_warning("-Wnull-dereference")
+sls_enable_cxx_warning("-Wduplicated-cond")
+sls_disable_cxx_warning("-Wclass-memaccess")
+sls_disable_c_warning("-Wstringop-truncation")
+
 
 if(SLS_USE_SANITIZER)
     target_compile_options(slsProjectOptions INTERFACE -fsanitize=address,undefined -fno-omit-frame-pointer)
@@ -168,8 +190,38 @@ set(CMAKE_INSTALL_RPATH $ORIGIN)
 set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
 
 
+set(ZeroMQ_HINT "" CACHE STRING "Hint where ZeroMQ could be found")
+#Adapted from: https://github.com/zeromq/cppzmq/
+if (NOT TARGET libzmq)
+    if(ZeroMQ_HINT)
+        message(STATUS "Looking for ZeroMQ in: ${ZeroMQ_HINT}")
+        find_package(ZeroMQ 4 
+            NO_DEFAULT_PATH
+            HINTS ${ZeroMQ_DIR}
+        )
+    else()
+        find_package(ZeroMQ 4 QUIET)
+    endif()
     
-find_package(ZeroMQ 4 REQUIRED)
+  # libzmq autotools install: fallback to pkg-config
+  if(NOT ZeroMQ_FOUND)
+    message(STATUS "CMake libzmq package not found, trying again with pkg-config (normal install of zeromq)")
+    list (APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/libzmq-pkg-config)
+    find_package(ZeroMQ 4 REQUIRED)
+  endif()
+
+  # TODO "REQUIRED" above should already cause a fatal failure if not found, but this doesn't seem to work
+  if(NOT ZeroMQ_FOUND)
+    message(FATAL_ERROR "ZeroMQ was not found, neither as a CMake package nor via pkg-config")
+  endif()
+
+  if (ZeroMQ_FOUND AND NOT TARGET libzmq)
+    message(FATAL_ERROR "ZeroMQ version not supported!")
+  endif()
+endif()
+
+get_target_property(VAR libzmq INTERFACE_INCLUDE_DIRECTORIES)
+message(STATUS "zmq: ${VAR}")
 
 if (SLS_USE_TESTS)
     enable_testing()
@@ -177,29 +229,19 @@ if (SLS_USE_TESTS)
 endif(SLS_USE_TESTS)
 
 
-
-
 # Common functionallity to detector and receiver
 add_subdirectory(slsSupportLib)
 
-if (SLS_USE_TEXTCLIENT)
+if (SLS_USE_DETECTOR OR SLS_USE_TEXTCLIENT)
     add_subdirectory(slsDetectorSoftware)
-endif (SLS_USE_TEXTCLIENT)
-
+endif ()
 
 if (SLS_USE_RECEIVER)
-    if (SLS_USE_HDF5)
-        find_package(HDF5 1.10 COMPONENTS CXX REQUIRED)
-    endif (SLS_USE_HDF5)
     add_subdirectory(slsReceiverSoftware) 
 endif (SLS_USE_RECEIVER)
 
 if (SLS_USE_GUI)   
-    find_package(Qt4 REQUIRED)
-    find_package(Qwt 6.1 REQUIRED)
-    if (QT4_FOUND AND QWT_FOUND)
-        add_subdirectory(slsDetectorGui)
-    endif()
+    add_subdirectory(slsDetectorGui)
 endif (SLS_USE_GUI)
 
 if (SLS_USE_SIMULATOR)
@@ -211,7 +253,7 @@ if (SLS_USE_INTEGRATION_TESTS)
 endif (SLS_USE_INTEGRATION_TESTS)
 
 if (SLS_USE_PYTHON)
-    set(PYBIND11_CPP_STANDARD -std=c++11)
+    find_package (Python 3.6 COMPONENTS Interpreter Development)
     add_subdirectory(libs/pybind11)
     add_subdirectory(python)
 endif(SLS_USE_PYTHON)
@@ -232,16 +274,13 @@ if(SLS_BUILD_DOCS)
     add_subdirectory(docs)
 endif(SLS_BUILD_DOCS)
 
-
 if(SLS_USE_MOENCH)
+    add_subdirectory(slsDetectorCalibration/tiffio)
     add_subdirectory(slsDetectorCalibration/moenchExecutables)
 endif(SLS_USE_MOENCH)
 
 if(SLS_MASTER_PROJECT)
-    # Set install dir CMake packages
     set(CMAKE_INSTALL_DIR "share/cmake/${PROJECT_NAME}")
-    # Set the list of exported targets
     set(PROJECT_LIBRARIES slsSupportShared slsDetectorShared slsReceiverShared)
-    # Generate and install package config file and version
     include(cmake/package_config.cmake)
 endif()

COPYING

@@ -0,0 +1,17 @@
+The SLS Detector Package is provided under:
+
+	SPDX-License-Identifier: LGPL-3.0-or-later
+
+Being under the terms of the GNU Lesser General Public License version 3 or later, 
+according with:
+
+	LICENSES/LGPL-3.0
+
+Source code under the Apache 2.0 License have the SPDX Identifier and are 
+according with:
+
+	LICENSES/ThirdParty/Apache-2.0
+
+All contributions to the SLS Detector Package are subject to this COPYING file.
+
+

LICENSES/GPL-3.0

@@ -0,0 +1,688 @@
+Valid-License-Identifier: GPL-3.0
+Valid-License-Identifier: GPL-3.0+
+SPDX-URL: https://spdx.org/licenses/GPL-3.0-or-later.html
+Usage-Guide:
+  To use this license in source code, put one of the following SPDX
+  tag/value pairs into a comment according to the placement
+  guidelines in the licensing rules documentation.
+  For 'GNU Library General Public License (LGPL) version 3.0 only' use:
+    SPDX-License-Identifier: GPL-3.0
+  For 'GNU Library General Public License (LGPL) version 3.0 or any later
+  version' use:
+    SPDX-License-Identifier: GPL-3.0-or-later
+License-Text:
+
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

LICENSES/LGPL-3.0

@@ -0,0 +1,179 @@
+Valid-License-Identifier: LGPL-3.0
+Valid-License-Identifier: LGPL-3.0+
+SPDX-URL: https://spdx.org/licenses/LGPL-3.0-or-later.html
+Usage-Guide:
+  To use this license in source code, put one of the following SPDX
+  tag/value pairs into a comment according to the placement
+  guidelines in the licensing rules documentation.
+  For 'GNU Library General Public License (LGPL) version 3.0 only' use:
+    SPDX-License-Identifier: LGPL-3.0
+  For 'GNU Library General Public License (LGPL) version 3.0 or any later
+  version' use:
+    SPDX-License-Identifier: LGPL-3.0-or-later
+License-Text:
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

LICENSES/Third Party/Apache-2.0

@@ -0,0 +1,210 @@
+Valid-License-Identifier: Apache-2.0
+SPDX-URL: https://spdx.org/licenses/Apache-2.0.html
+Usage-Guide:
+  To use this license in source code, put one of the following SPDX
+  tag/value pairs into a comment according to the placement
+  guidelines in the licensing rules documentation.
+    SPDX-License-Identifier: Apache-2.0
+License-Text:
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -4,7 +4,11 @@ Please do not update to any xxxx.xx.xx.dev0 tags. They are not releases, but tag
 Use only releases with tags such as x.x.x or x.x.x-rcx.
 
 ### Documentation
-Detailed documentation can be found on the [official site.](https://www.psi.ch/detectors/users-support)
+##### 5.0.0 - Latest Release
+Detailed documentation on the latest release 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).
+
+##### Older Releases
+Documentation is found in the package.
 
 ### Binaries
 Binaries for the slsDetectorPackage are available through conda. 
@@ -12,6 +16,7 @@ Binaries for the slsDetectorPackage are available through conda.
 #Add conda channels
 conda config --add channels conda-forge
 conda config --add channels slsdetectorgroup
+conda config --set channel_priority strict
 
 conda install slsdetlib   #only shared lib and command line
 conda install slsdet      #python bindings (includes slsdetlib)
@@ -29,10 +34,8 @@ git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git
 
 ```
 #### Dependencies 
-* Lib: c++11 compiler (gcc=>4.8), ZeroMQ 4
-* Gui: Qt 4.8 and Qwt 6.0
-* Calibration wizards and ctbGUI: ROOT
-* Optional: HDF5
+
+Refer [this page](https://slsdetectorgroup.github.io/devdoc/dependencies.html)  for dependencies.
 
 
 #### Compilation 
@@ -42,26 +45,38 @@ cmk.sh or directly with cmake for more control.
 
 **1. Compile using script cmk.sh**<br>
 
-After compiling, the libraries and executables will be found in `slsDetectorPackage/build/bin` directory<br>
+These are mainly aimed at those not familiar with using ccmake and cmake. 
+```
+    The binaries are generated in slsDetectorPackage/build/bin directory.
 
-Usage: [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [-h] [-d <HDF5 directory>] [-j] <Number of threads>
- -[no option]: only make
- -c: Clean
- -b: Builds/Rebuilds CMake files normal mode
- -p: Builds/Rebuilds Python API
- -h: Builds/Rebuilds Cmake files with HDF5 package
- -d: HDF5 Custom Directory
- -t: Build/Rebuilds only text client
- -r: Build/Rebuilds only receiver
- -g: Build/Rebuilds only gui
- -s: Simulator
- -u: Chip Test Gui
- -j: Number of threads to compile through
- -e: Debug mode
- -i: Builds tests
+    Usage: ./cmk.sh [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-l Install directory] [-k <CMake command>] [-j <Number of threads>]
+    -[no option]: only make
+    -c: Clean
+    -b: Builds/Rebuilds CMake files normal mode
+    -p: Builds/Rebuilds Python API
+    -h: Builds/Rebuilds Cmake files with HDF5 package
+    -d: HDF5 Custom Directory
+    -k: CMake command
+    -l: Install directory
+    -t: Build/Rebuilds only text client
+    -r: Build/Rebuilds only receiver
+    -g: Build/Rebuilds only gui
+    -s: Simulator
+    -u: Chip Test Gui
+    -j: Number of threads to compile through
+    -e: Debug mode
+    -i: Builds tests
+    -m: Manuals
+    -n: Manuals without compiling doxygen (only rst)
+    -z: Moench zmq processor
 
-eg. Rebuild when you switch to a new build and compile in parallel:
-./cmk.sh -bj5
+    
+    # get all options
+    ./cmk.sh -?
+
+    # new build  and compile in parallel:
+    ./cmk.sh -bj5
+```
  
 **2. Compile without script**<br>
 Use cmake to create out-of-source builds, by creating a build folder parallel to source directory. This would create a debug build with address sanitizers.
@@ -71,3 +86,17 @@ Use cmake to create out-of-source builds, by creating a build folder parallel to
     $ cmake ../slsDetectorPackage  -DCMAKE_BUILD_TYPE=Debug -DSLS_USE_SANITIZER=ON
     $ make -j12 #or whatever number of threads wanted
 ```
+
+To install binaries using CMake
+```
+    git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git
+    mkdir build && cd build
+    cmake ../slsDetectorPackage -DCMAKE_INSTALL_PREFIX=/your/install/path
+    make -j12 #or whatever number of cores you are using to build
+    make install
+```
+
+
+### Support
+    dhanya.thattil@psi.ch
+    erik.frojdh@psi.ch

RELEASE.txt

@@ -1,70 +1,134 @@
-SLS Detector Package 5.0.0-rc2 released on 09.10.2020 (Release Candidate 2)
-===========================================================================
+SLS Detector Package Minor Release 7.0.0 released on 25.11.2021
+===============================================================
+
+This document describes the differences between v7.0.0 and v6.x.x   
+
+
 
     CONTENTS
     --------
-    1.  Firmware Requirements
-    2.  Download, Documentation & Support
+    1.  New or Changed Features
+    2.  Resolved Issues
+    3.  Firmware Requirements
+    4.  Kernel Requirements
+    5.  Download, Documentation & Support
 
 
-1. Firmware Requirements
+
+
+1. New or Changed Features
+==========================
+
+- Fixed minor warnings (will fix commandline print of excess packets for missing packets)
+- ctb slow adcs and any other adcs (other than temp) goes to the control Server
+- number of udp interfaces is 2 for Eiger (CHANGE IN API??)
+- added module id for virtual servers into the udp header
+- refactoring (rxr)
+- fixed patsetbit and patsetmask for moench
+- changed default vref of adc9257 to 2V for moench (from 1.33V)
+- moench and ctb - can set the starting frame number of next acquisition
+- mythen server kernel check incompatible (cet timezone)
+- rx_arping
+- rx_threadsids max is now 9 (breaking api)
+- fixed datastream disabling for eiger. Its only available in 10g mode.
+- m3 server crash (vthrehsold)
+- allow vtrim to be interpolated for Eiger settings
+- m3 setThresholdEnergy and setAllThresholdEnergy was overwriting gaincaps with settings enum
+- can set localhost with virtual server with minimum configuration: (hostname localhost, rx_hostname localhost, udp_dstip auto)
+- increases the progress according to listened index. (not processed index)
+- current frame index points to listened frame index (not processed index)
+- when in discard partial frames or empty mode, the frame number doesnt increase by 1, it increases to that number (so its faster)
+- file write disabled by default
+- start non blocking acquisition at modular level
+- hostname cmd failed when connecting to servers in update mode (ctb, moench, jungfrau, eiger)
+- missingpackets signed (negative => extra packets)
+
+
+2. Resolved Issues
+==================
+
+
+3. Firmware Requirements
 ========================
         
-        Eiger
-        =====  
-        Compatible version : 08.09.2020 (v27)
+    Eiger
+    =====  
+    Compatible version : 08.10.2021 (v29)
     
-        Jungfrau
-        ========       
-        Compatible version : 24.07.2020 (v1.1, PCB v1.0) 
-                           : 21.07.2020 (v2.1, PCB v2.0)
+    Jungfrau
+    ========       
+    Compatible version : 31.08.2021 (v1.2, PCB v1.0) 
+                       : 08.10.2021 (v2.2, PCB v2.0)
 
-        Gotthard
-        ========   
-        Compatible version : 08.02.2018 (50um and 25um Master)
-                           : 09.02.2018 (25 um Slave) 
+    Gotthard
+    ========   
+    Compatible version : 08.02.2018 (50um and 25um Master)
+                       : 09.02.2018 (25 um Slave) 
 
-        Mythen3
-        =======
-        Compatible version : 25.09.2020 (development)
+    Mythen3
+    =======
+    Compatible version : 10.09.2021 (v1.1)
 
-        Gotthard2
-        =========
-        Compatible version : 25.09.2020 (development)
+    Gotthard2
+    =========
+    Compatible version : 27.05.2021 (v0.1)
 
-        Moench
-        ======
-        Compatible version : 10.05.2020 (v1.0)
+    Moench
+    ======
+    Compatible version : 05.10.2020 (v1.0)
 
-        Ctb
-        ===
-        Compatible version : 10.05.2019 (v1.0)
+    Ctb
+    ===
+    Compatible version : 05.10.2020 (v1.0)
+
+    Detector Upgrade
+    ================
+    The following can be upgraded remotely:
+    Eiger      via bit files
+    Jungfrau   via command <.pof>
+    Mythen3    via command <.rbf>
+    Gotthard2  via command <.rbf> 
+    Moench     via command <.pof>
+    Ctb        via command <.pof>
+
+    The following cannot be upgraded remotely:
+    Gotthard   
+
+    Instructions available at
+        https://slsdetectorgroup.github.io/devdoc/firmware.html
+    and
+        https://slsdetectorgroup.github.io/devdoc/serverupgrade.html
 
 
-        Detector Upgrade
-        ================
 
-        The following can be upgraded remotely:
-        Eiger      via bit files
-        Jungfrau   via command <.pof>
-        Mythen3    via command <.rbf>
-        Gotthard2  via command <.rbf> 
-        Moench     via command <.pof>
-        Ctb        via command <.pof>
+4. Kernel Requirements
+======================
 
-        The following cannot be upgraded remotely:
-        Gotthard   
+    Blackfin 
+    ========
+    Latest version: Fri Oct 29 00:00:00 2021
     
-        Instructions available at
-            https://slsdetectorgroup.github.io/devdoc/firmware.html
-        and
-            https://slsdetectorgroup.github.io/devdoc/serverupgrade.html
+    Older ones will work, but might have issues with programming firmware via
+    the package.
 
-        Please refer to the link below for more details on the firmware versions.
-            https://www.psi.ch/en/detectors/firmware
+    Nios
+    ====
+    Compatible version: Mon May 10 18:00:21 CEST 2021
+
+    Kernel Upgrade
+    ==============
+    Eiger   via bit files
+    Others  via command
+
+    Commands: udpatekernel, kernelversion
+    Instructions available at
+        https://slsdetectorgroup.github.io/devdoc/commandline.html
+        https://slsdetectorgroup.github.io/devdoc/detector.html
+        https://slsdetectorgroup.github.io/devdoc/pydetector.html
 
 
-2. Download, Documentation & Support
+
+5. Download, Documentation & Support
 ====================================
 
     Download
@@ -91,6 +155,9 @@ SLS Detector Package 5.0.0-rc2 released on 09.10.2020 (Release Candidate 2)
     Consuming slsDetectorPackage:
         https://slsdetectorgroup.github.io/devdoc/consuming.html
         
+    API Examples:
+        https://github.com/slsdetectorgroup/api-examples
+
     Command Line Documentation:
         https://slsdetectorgroup.github.io/devdoc/commandline.html
 
@@ -109,14 +176,18 @@ SLS Detector Package 5.0.0-rc2 released on 09.10.2020 (Release Candidate 2)
     Python API Example:
         https://slsdetectorgroup.github.io/devdoc/pyexamples.html
 
+    Receivers (including custom receiver):
+        https://slsdetectorgroup.github.io/devdoc/receivers.html
+        https://slsdetectorgroup.github.io/devdoc/slsreceiver.html
+
     TroubleShooting:
         https://slsdetectorgroup.github.io/devdoc/troubleshooting.html
         
     Further Documentation:
         https://www.psi.ch/en/detectors/documentation
         
-    Old Release notes:
-        https://www.psi.ch/en/detectors/latest-installation
+    Info on Releases:
+        https://www.psi.ch/en/detectors/software
 
 
     Support
@@ -124,4 +195,4 @@ SLS Detector Package 5.0.0-rc2 released on 09.10.2020 (Release Candidate 2)
 
         dhanya.thattil@psi.ch
         erik.frojdh@psi.ch
-        anna.bergamaschi@psi.ch
+

cmake/FindZeroMQ.cmake

@@ -1,112 +0,0 @@
-
-# This file is originally from https://github.com/zeromq/azmq and distributed 
-# under Boost Software Lincese 1.0
-# Boost Software License - Version 1.0 - August 17th, 2003
-
-# Permission is hereby granted, free of charge, to any person or organization
-# obtaining a copy of the software and accompanying documentation covered by
-# this license (the "Software") to use, reproduce, display, distribute,
-# execute, and transmit the Software, and to prepare derivative works of the
-# Software, and to permit third-parties to whom the Software is furnished to
-# do so, all subject to the following:
-
-# The copyright notices in the Software and this entire statement, including
-# the above license grant, this restriction and the following disclaimer,
-# must be included in all copies of the Software, in whole or in part, and
-# all derivative works of the Software, unless such copies or derivative
-# works are solely in the form of machine-executable object code generated by
-# a source language processor.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-# SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-# FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-# DEALINGS IN THE SOFTWARE.
-# --------------------------------------------------------------------------------
-
-# Find ZeroMQ Headers/Libs
-
-# Variables
-# ZMQ_ROOT - set this to a location where ZeroMQ may be found
-#
-# ZeroMQ_FOUND - True of ZeroMQ found
-# ZeroMQ_INCLUDE_DIRS - Location of ZeroMQ includes
-# ZeroMQ_LIBRARIES - ZeroMQ libraries
-
-include(FindPackageHandleStandardArgs)
-
-if (NOT ZMQ_ROOT)
-    set(ZMQ_ROOT "$ENV{ZMQ_ROOT}")
-endif()
-
-if (NOT ZMQ_ROOT)
-    find_path(_ZeroMQ_ROOT NAMES include/zmq.h)
-else()
-    set(_ZeroMQ_ROOT "${ZMQ_ROOT}")
-endif()
-
-find_path(ZeroMQ_INCLUDE_DIRS NAMES zmq.h HINTS ${_ZeroMQ_ROOT}/include)
-
-if (ZeroMQ_INCLUDE_DIRS)
-    set(_ZeroMQ_H ${ZeroMQ_INCLUDE_DIRS}/zmq.h)
-
-    function(_zmqver_EXTRACT _ZeroMQ_VER_COMPONENT _ZeroMQ_VER_OUTPUT)
-        set(CMAKE_MATCH_1 "0")
-        set(_ZeroMQ_expr "^[ \\t]*#define[ \\t]+${_ZeroMQ_VER_COMPONENT}[ \\t]+([0-9]+)$")
-        file(STRINGS "${_ZeroMQ_H}" _ZeroMQ_ver REGEX "${_ZeroMQ_expr}")
-        string(REGEX MATCH "${_ZeroMQ_expr}" ZeroMQ_ver "${_ZeroMQ_ver}")
-        set(${_ZeroMQ_VER_OUTPUT} "${CMAKE_MATCH_1}" PARENT_SCOPE)
-    endfunction()
-
-    _zmqver_EXTRACT("ZMQ_VERSION_MAJOR" ZeroMQ_VERSION_MAJOR)
-    _zmqver_EXTRACT("ZMQ_VERSION_MINOR" ZeroMQ_VERSION_MINOR)
-    _zmqver_EXTRACT("ZMQ_VERSION_PATCH" ZeroMQ_VERSION_PATCH)
-
-    message(STATUS "ZeroMQ version: ${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}.${ZeroMQ_VERSION_PATCH}")
-
-    # We should provide version to find_package_handle_standard_args in the same format as it was requested,
-    # otherwise it can't check whether version matches exactly.
-    if (ZeroMQ_FIND_VERSION_COUNT GREATER 2)
-        set(ZeroMQ_VERSION "${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}.${ZeroMQ_VERSION_PATCH}")
-    else()
-        # User has requested ZeroMQ version without patch part => user is not interested in specific patch =>
-        # any patch should be an exact match.
-        set(ZeroMQ_VERSION "${ZeroMQ_VERSION_MAJOR}.${ZeroMQ_VERSION_MINOR}")
-    endif()
-
-    if (NOT ${CMAKE_CXX_PLATFORM_ID} STREQUAL "Windows")
-        find_library(ZeroMQ_LIBRARIES NAMES zmq HINTS ${_ZeroMQ_ROOT}/lib)
-    else()
-        find_library(
-            ZeroMQ_LIBRARY_RELEASE
-            NAMES
-                libzmq
-                "libzmq-${CMAKE_VS_PLATFORM_TOOLSET}-mt-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
-            HINTS
-                ${_ZeroMQ_ROOT}/lib
-            )
-
-        find_library(
-            ZeroMQ_LIBRARY_DEBUG
-            NAMES
-                libzmq_d
-                "libzmq-${CMAKE_VS_PLATFORM_TOOLSET}-mt-gd-${ZeroMQ_VERSION_MAJOR}_${ZeroMQ_VERSION_MINOR}_${ZeroMQ_VERSION_PATCH}"
-            HINTS
-                ${_ZeroMQ_ROOT}/lib)
-
-        # On Windows we have to use corresponding version (i.e. Release or Debug) of ZeroMQ because of `errno` CRT global variable
-        # See more at http://www.drdobbs.com/avoiding-the-visual-c-runtime-library/184416623
-        set(ZeroMQ_LIBRARIES optimized "${ZeroMQ_LIBRARY_RELEASE}" debug "${ZeroMQ_LIBRARY_DEBUG}")
-    endif()
-endif()
-
-find_package_handle_standard_args(ZeroMQ FOUND_VAR ZeroMQ_FOUND
-    REQUIRED_VARS ZeroMQ_INCLUDE_DIRS ZeroMQ_LIBRARIES
-    VERSION_VAR ZeroMQ_VERSION)
-
-if (ZeroMQ_FOUND)
-    mark_as_advanced(ZeroMQ_INCLUDE_DIRS ZeroMQ_LIBRARIES ZeroMQ_VERSION
-        ZeroMQ_VERSION_MAJOR ZeroMQ_VERSION_MINOR ZeroMQ_VERSION_PATCH)
-endif()

cmake/SlsAddFlag.cmake

@@ -0,0 +1,64 @@
+include(CheckCXXCompilerFlag)
+include(CheckCCompilerFlag)
+
+
+function(enable_cxx_warning flag target)
+    string(REPLACE "-W" "HAS_" flag_name ${flag})
+    check_cxx_compiler_flag(${flag} ${flag_name})
+    if(${flag_name})
+        target_compile_options(${target} INTERFACE ${flag})
+        message(STATUS "Adding: ${flag} to ${target}")
+    else()
+        message(STATUS "Flag: ${flag} not supported")
+    endif()
+endfunction()
+
+function(enable_c_warning flag target)
+    string(REPLACE "-W" "HAS_" flag_name ${flag})
+    check_c_compiler_flag(${flag} ${flag_name})
+    if(${flag_name})
+        target_compile_options(${target} INTERFACE ${flag})
+        message(STATUS "Adding: ${flag} to ${target}")
+    else()
+        message(STATUS "Flag: ${flag} not supported")
+    endif()
+endfunction()
+
+
+function(disable_cxx_warning flag target)
+    string(REPLACE "-W" "HAS_" flag_name ${flag})
+    check_cxx_compiler_flag(${flag} ${flag_name})
+
+    if(${flag_name})
+        string(REPLACE "-W" "-Wno-" neg_flag ${flag})
+        message(STATUS "Adding: ${neg_flag} to ${target}")
+        target_compile_options(${target} INTERFACE ${neg_flag})
+    else()
+        message(STATUS "Warning: ${flag} not supported no need to disable")
+    endif()
+endfunction()
+
+function(disable_c_warning flag target)
+    string(REPLACE "-W" "HAS_" flag_name ${flag})
+    check_c_compiler_flag(${flag} ${flag_name})
+    if(${flag_name})
+        string(REPLACE "-W" "-Wno-" neg_flag ${flag})
+        message(STATUS "Adding: ${neg_flag} to ${target}")
+        target_compile_options(${target} INTERFACE ${neg_flag})
+    else()
+        message(STATUS "Warning: ${flag} not supported no need to disable")
+    endif()
+endfunction()
+
+
+function(sls_disable_c_warning flag)
+    disable_c_warning(${flag} slsProjectCSettings)
+endfunction()
+
+function(sls_enable_cxx_warning flag)
+    enable_cxx_warning(${flag} slsProjectWarnings)
+endfunction()
+
+function(sls_disable_cxx_warning flag)
+    disable_cxx_warning(${flag} slsProjectWarnings)
+endfunction()

cmake/package_config.cmake

@@ -25,6 +25,12 @@ install(FILES
   DESTINATION ${CMAKE_INSTALL_DIR}
 )
 
+install(FILES
+  "${CMAKE_SOURCE_DIR}/libzmq-pkg-config/FindZeroMQ.cmake"
+  COMPONENT devel
+  DESTINATION ${CMAKE_INSTALL_DIR}/libzmq-pkg-config
+)
+
 if (PROJECT_LIBRARIES OR PROJECT_STATIC_LIBRARIES)
   install(
     EXPORT "${TARGETS_EXPORT_NAME}"

cmake/project-config.cmake.in

@@ -12,8 +12,21 @@ include(CMakeFindDependencyMacro)
 
 set(SLS_USE_HDF5 "@SLS_USE_HDF5@")
 
-# Add optional dependencies here
+
+find_package(ZeroMQ 4 QUIET)
+# libzmq autotools install: fallback to pkg-config
+if(NOT ZeroMQ_FOUND)
+    list (APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/libzmq-pkg-config)
+    find_package(ZeroMQ 4 REQUIRED)
+endif()
+
+if(NOT ZeroMQ_FOUND)
+    message(FATAL_ERROR "ZeroMQ was NOT found!")
+endif()
+
 find_dependency(Threads)
+
+# Add optional dependencies here
 if (SLS_USE_HDF5)
     find_dependency(HDF5)
 endif ()

cmk.sh

@@ -1,5 +1,9 @@
 #!/bin/bash
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+CMAKE="cmake3"
 BUILDDIR="build"
+INSTALLDIR=""
 HDF5DIR="/opt/hdf5v1.10.0"
 HDF5=0
 COMPILERTHREADS=0
@@ -22,13 +26,15 @@ CMAKE_PRE=""
 CMAKE_POST=""
 
 usage() { echo -e "
-Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-j] <Number of threads>
+Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-l Install directory] [-k <CMake command>] [-j <Number of threads>]
  -[no option]: only make
  -c: Clean
  -b: Builds/Rebuilds CMake files normal mode
  -p: Builds/Rebuilds Python API
  -h: Builds/Rebuilds Cmake files with HDF5 package
  -d: HDF5 Custom Directory
+ -k: CMake command
+ -l: Install directory
  -t: Build/Rebuilds only text client
  -r: Build/Rebuilds only receiver
  -g: Build/Rebuilds only gui
@@ -75,7 +81,7 @@ For rebuilding only certain sections
  
  " ; exit 1; }
 
-while getopts ":bpchd:j:trgeisumnz" opt ; do
+while getopts ":bpchd:k:l:j:trgeisumnz" opt ; do
 	case $opt in
 	b) 
 		echo "Building of CMake files Required"
@@ -99,6 +105,14 @@ while getopts ":bpchd:j:trgeisumnz" opt ; do
 		echo "New HDF5 directory: $OPTARG" 
 		HDF5DIR=$OPTARG
 		;;
+	l)
+		echo "CMake install directory: $OPTARG"
+		INSTALLDIR="$OPTARG"
+		;;
+	k)
+		echo "CMake command: $OPTARG"
+		CMAKE="$OPTARG"
+		;;
 	j) 
 		echo "Number of compiler threads: $OPTARG" 
 		COMPILERTHREADS=$OPTARG
@@ -252,7 +266,15 @@ else
 fi
 
 
+#install
+if [ -n "$INSTALLDIR" ]; then
+	CMAKE_POST+=" -DCMAKE_INSTALL_PREFIX=$INSTALLDIR"
+	CMAKE_POST+=" -DCMAKE_FIND_ROOT_PATH=$INSTALLDIR"
+fi
+
+
 #enter build dir
+#pushd $BUILDDIR;
 cd $BUILDDIR;
 echo "in "$PWD
 
@@ -261,7 +283,7 @@ echo "in "$PWD
 #cmake
 if [ $REBUILD -eq 1 ]; then
 	rm -f CMakeCache.txt
-	BUILDCOMMAND="$CMAKE_PRE cmake3 $CMAKE_POST .."
+	BUILDCOMMAND="$CMAKE_PRE $CMAKE $CMAKE_POST .."
 	echo $BUILDCOMMAND
 	eval $BUILDCOMMAND
 fi
@@ -305,6 +327,13 @@ else
 fi
 
 
+#install
+if [ -n "$INSTALLDIR" ]; then
+	make install
+#	popd
+#	$CMAKE --build $BUILDDIR --target install
+fi
+
 
 
 

conda-recepie/build.sh

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 mkdir build
 mkdir install
@@ -8,13 +10,15 @@ cmake .. \
       -DSLS_USE_TEXTCLIENT=ON \
       -DSLS_USE_RECEIVER=ON \
       -DSLS_USE_GUI=ON \
+      -DSLS_USE_MOENCH=ON\
       -DSLS_USE_TESTS=ON \
       -DSLS_USE_PYTHON=OFF \
       -DCMAKE_BUILD_TYPE=Release \
       -DSLS_USE_HDF5=OFF\
      
-
-cmake --build . -- -j10
+NCORES=$(getconf _NPROCESSORS_ONLN)
+echo "Building using: ${NCORES} cores"
+cmake --build . -- -j${NCORES}
 cmake --build . --target install
 
 CTEST_OUTPUT_ON_FAILURE=1 ctest -j 2

conda-recepie/build_pylib.sh

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 echo "|<-------- starting python build"
 cd python

conda-recepie/conda_build_config.yaml

@@ -2,6 +2,8 @@ python:
     - 3.6
     - 3.7
     - 3.8
+    - 3.9
+    - 3.10
     
 numpy: 
     - 1.17

conda-recepie/copy_ctbgui.sh

@@ -1,3 +1,5 @@
+# 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

conda-recepie/copy_gui.sh

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #Copy the GUI 
-mkdir $PREFIX/bin
-cp build/bin/slsDetectorGui $PREFIX/bin/.
+mkdir -p $PREFIX/bin
+cp build/install/bin/slsDetectorGui $PREFIX/bin/.

conda-recepie/copy_lib.sh

@@ -1,14 +1,12 @@
+# 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
-mkdir $PREFIX/include/slsDetectorPackage
+mkdir -p $PREFIX/lib
+mkdir -p $PREFIX/bin
+mkdir -p $PREFIX/include/sls
+# mkdir $PREFIX/include/slsDetectorPackage
 
 #Shared and static libraries
-# cp build/bin/libSlsDetector.so $PREFIX/lib/.
-# cp build/bin/libSlsReceiver.so $PREFIX/lib/.
-# cp build/bin/libSlsSupport.so $PREFIX/lib/.
-
 cp build/install/lib/* $PREFIX/lib/
 
 #Binaries
@@ -20,5 +18,5 @@ cp build/install/bin/slsReceiver $PREFIX/bin/.
 cp build/install/bin/slsMultiReceiver $PREFIX/bin/.
 
 
-cp build/install/include/* $PREFIX/include/
+cp build/install/include/sls/* $PREFIX/include/sls
 cp -r build/install/share/ $PREFIX/share

conda-recepie/copy_moench.sh

@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+
+#Copy the Moench executables 
+mkdir -p $PREFIX/bin
+cp build/install/bin/moench* $PREFIX/bin/.

conda-recepie/meta.yaml

@@ -59,6 +59,16 @@ outputs:
     script: copy_lib.sh
 
     requirements:
+      build:
+        - {{ compiler('c') }}
+        - {{compiler('cxx')}}
+        - libstdcxx-ng
+        - libgcc-ng
+        - zeromq
+
+      host:
+        - zeromq
+
       run: 
         - libstdcxx-ng
         - libgcc-ng
@@ -78,6 +88,8 @@ outputs:
 
       host:
         - python
+        - {{ pin_subpackage('slsdetlib', exact=True) }}
+
 
       run:
         - libstdcxx-ng
@@ -94,8 +106,29 @@ outputs:
   - name: slsdetgui
     script: copy_gui.sh
     requirements:
+
+      build:
+        - {{ compiler('c') }}
+        - {{compiler('cxx')}}
+        - {{ pin_subpackage('slsdetlib', exact=True) }}
+        - qwt 6.*
+
       run:
         - {{ pin_subpackage('slsdetlib', exact=True) }}
         - qwt 6.*
         - qt 4.8.*
         - 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 +1,3 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 ctest -j2

ctbGui/CMakeLists.txt

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 
 find_package(ROOT CONFIG REQUIRED  COMPONENTS Core Gui)
@@ -32,7 +34,7 @@ add_executable(ctbGui
     ctbAdcs.cpp
     ctbPattern.cpp
     ctbAcquisition.cpp
-    ${CMAKE_SOURCE_DIR}/slsDetectorCalibration/tiffIO.cpp
+    ${CMAKE_SOURCE_DIR}/slsDetectorCalibration/tiffio/src/tiffIO.cpp
 )
 
 
@@ -41,6 +43,7 @@ target_include_directories(ctbGui PRIVATE
     ${CMAKE_SOURCE_DIR}/slsDetectorCalibration/dataStructures
     ${CMAKE_SOURCE_DIR}/slsDetectorCalibration/interpolations
     ${CMAKE_SOURCE_DIR}/slsDetectorCalibration/
+    ${CMAKE_SOURCE_DIR}/slsDetectorCalibration/tiffio/include/
 )
 
 # Headders needed for ROOT dictionary generation
@@ -59,7 +62,6 @@ set( HEADERS
 #set(ROOT_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
 
 # ROOT dictionary generation 
-include("${ROOT_DIR}/RootMacros.cmake")
 root_generate_dictionary(ctbDict ${HEADERS} LINKDEF ctbLinkDef.h)
 add_library(ctbRootLib SHARED ctbDict.cxx)
 target_include_directories(ctbRootLib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
@@ -85,3 +87,4 @@ set_target_properties(ctbGui PROPERTIES
     RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
 
 )
+

ctbGui/Makefile.root5

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 
 INCS=ctbMain.h ctbDacs.h   ctbPattern.h  ctbSignals.h  ctbAdcs.h ctbAcquisition.h ctbPowers.h   ctbSlowAdcs.h 

ctbGui/Makefile.root6

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 
 INCS=ctbMain.h ctbDacs.h   ctbPattern.h  ctbSignals.h  ctbAdcs.h ctbAcquisition.h ctbPowers.h   ctbSlowAdcs.h  

ctbGui/ctbAcquisition.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 //#define TESTADC
 
 
@@ -16,6 +18,7 @@
 #include <TColor.h>
 #include <TTimer.h>
 #include <TH2F.h>
+#include <TSystem.h>
 
 
 #include <stdio.h>
@@ -25,8 +28,8 @@
 
 #include "ctbAcquisition.h"
 #include "ctbDefs.h"
-#include "Detector.h"
-#include "sls_detector_defs.h"
+#include "sls/Detector.h"
+#include "sls/sls_detector_defs.h"
 #include "ctbMain.h"
 #include "moench03CtbData.h" 
 //#include "moench03TCtbData.h" 
@@ -43,7 +46,7 @@
 #include "moench04CtbZmqData.h"
 #include "moench04CtbZmq10GbData.h"
 #include "deserializer.h"
-#include "detectorData.h"
+#include "sls/detectorData.h"
 #include "imageZmq16bit.h"
 #include "imageZmq32bit.h"
 

ctbGui/ctbAcquisition.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #ifndef CTBACQUISITION_H
 #define CTBACQUISITION_H
 #include  <TGFrame.h>

ctbGui/ctbAdcs.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include <TApplication.h>
 #include <TGClient.h>
 #include <TCanvas.h>
@@ -25,7 +27,7 @@
 
 #include "ctbAdcs.h"
 #include "ctbDefs.h"
-#include "Detector.h"
+#include "sls/Detector.h"
 
 using namespace std;
 

ctbGui/ctbAdcs.h

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

ctbGui/ctbDacs.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 #include <stdio.h>
 #include <iostream>
@@ -10,8 +12,8 @@
 
 #include "ctbDacs.h"
 #include "ctbDefs.h"
-#include "Detector.h"
-#include "sls_detector_defs.h"
+#include "sls/Detector.h"
+#include "sls/sls_detector_defs.h"
 
 using namespace std;
 

ctbGui/ctbDacs.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 
 #ifndef CTBDACS_H

ctbGui/ctbDefs.h

@@ -1,11 +1,13 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #pragma once
 
 #include <string>
 #include <stdexcept>
 #include <chrono>
 
-//#include "sls_detector_exceptions.h"
-//#include "ansi.h"
+//#include "sls/sls_detector_exceptions.h"
+//#include "sls/ansi.h"
 #define RED    	 	"\x1b[31m"
 #define RESET   	"\x1b[0m"
 #define BOLD    	"\x1b[1m"

ctbGui/ctbGui.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include <TApplication.h>
 #include <TColor.h>
 
@@ -9,8 +11,8 @@
 #include <fstream>
 #include <string>
 
-#include "Detector.h"
-#include "sls_detector_defs.h"
+#include "sls/Detector.h"
+#include "sls/sls_detector_defs.h"
 //#include "sls_receiver_defs.h"
 #include "ctbMain.h"
 #include "ctbDefs.h"

ctbGui/ctbLinkDef.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #pragma link C++ class ctbMain;
 #pragma link C++ class ctbDacs;
 #pragma link C++ class ctbDac;

ctbGui/ctbMain.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include <TApplication.h>
 #include <TGClient.h>
 #include <TCanvas.h>
@@ -34,7 +36,7 @@
 #include <fstream>
 #include <string>
 
-#include "Detector.h"
+#include "sls/Detector.h"
 #include "ctbDefs.h"
 #include "ctbMain.h"
 #include "ctbDacs.h"

ctbGui/ctbMain.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #ifndef CTBMAIN_H
 #define CTBMAIN_H
 #include <TGFrame.h>

ctbGui/ctbPattern.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include <TApplication.h>
 #include <TGClient.h>
 #include <TCanvas.h>
@@ -25,7 +27,7 @@
 
 #include "ctbPattern.h"
 #include "ctbDefs.h"
-#include "Detector.h"
+#include "sls/Detector.h"
 #include <chrono>
 using namespace std;
 

ctbGui/ctbPattern.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #ifndef CTBPATTERN_H
 #define CTBPATTERN_H
 #include  <TGFrame.h>

ctbGui/ctbPowers.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include  <TGFrame.h>
 
 
@@ -13,8 +15,8 @@
 #include "ctbDefs.h"
 #include "ctbDacs.h"
 #include "ctbPowers.h"
-#include "Detector.h"
-#include "sls_detector_defs.h"
+#include "sls/Detector.h"
+#include "sls/sls_detector_defs.h"
 
 using namespace std;
 

ctbGui/ctbPowers.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #ifndef CTBPOWERS_H
 #define CTBPOWERS_H
 

ctbGui/ctbSignals.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include <TApplication.h>
 #include <TGClient.h>
 #include <TCanvas.h>
@@ -35,7 +37,7 @@
 
 #include "ctbSignals.h"
 #include "ctbDefs.h"
-#include "Detector.h"
+#include "sls/Detector.h"
 
 using namespace std;
 

ctbGui/ctbSignals.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #ifndef CTBSIGNALS_H
 #define CTBSIGNALS_H
 #include  <TGFrame.h>

ctbGui/ctbSlowAdcs.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 #include <stdio.h>
 #include <iostream>
@@ -10,8 +12,8 @@
 
 #include "ctbSlowAdcs.h"
 #include "ctbDefs.h"
-#include "Detector.h"
-#include "sls_detector_defs.h"
+#include "sls/Detector.h"
+#include "sls/sls_detector_defs.h"
 
 using namespace std;
 

ctbGui/ctbSlowAdcs.h

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 
 #ifndef CTBSLOWADCS_H

ctbGui/patternGenerator/deserializer.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 #include <stdlib.h>  
 #include <stdint.h>  

ctbGui/patternGenerator/generate.sh

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 if [ "$#" -eq 0 ]; then
     echo "Wrong number of arguments: usage should be $0 patname"
     exit 1
@@ -19,9 +21,10 @@ fi
 
 if [ -f "$infile" ]
 then
-gcc -DINFILE="\"$infile\"" -DOUTFILE="\"$outfile\""  -DOUTFILEBIN="\"$outfilebin\"" -o $exe generator.c ; 
+dir=$(dirname $infile)
+gcc -DINFILE="\"$infile\"" -DOUTFILE="\"$outfile\""  -DOUTFILEBIN="\"$outfilebin\"" -o $exe generator.c -I$dir; 
 echo compiling
-echo gcc -DINFILE="\"$infile\"" -DOUTFILE="\"$outfile\""  -DOUTFILEBIN="\"$outfilebin\"" -o $exe generator.c ; 
+echo gcc -DINFILE="\"$infile\"" -DOUTFILE="\"$outfile\""  -DOUTFILEBIN="\"$outfilebin\"" -o $exe generator.c  -I$dir; 
 $exe ; 
 echo cleaning
 rm $exe

ctbGui/patternGenerator/generator.c

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 /****************************************************************************
 usage to generate a patter test.pat from test.p
 
@@ -67,14 +69,14 @@ void setoutput(int bit) {
   mask=mask<<bit;
   iopat |= mask;
 }
-
+/*
 void setclk(int bit) {
   uint64_t mask=1;
   mask=mask<<bit;
   iopat |= mask;
   clkpat |= mask;
 }
-
+*/
 void clearbit(int bit){
   uint64_t mask=1;
   mask=mask<<bit;
@@ -155,7 +157,7 @@ main(void) {
 #include INFILE
 
   fprintf(fd,"patioctrl 0x%016llx\n",iopat);
-  fprintf(fd,"patclkctrl 0x%016llx\n",clkpat);
+  //fprintf(fd,"patclkctrl 0x%016llx\n",clkpat);
   fprintf(fd,"patlimits 0x%04x 0x%04x\n",start, stop);
 
   for (iloop=0; iloop<MAXLOOPS; iloop++) {

docs/CMakeLists.txt

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 find_package(Doxygen REQUIRED)
 find_package(Sphinx REQUIRED)
 
@@ -51,7 +53,8 @@ set(SPHINX_SOURCE_FILES
   src/serverdefaults.rst
   src/quick_start_guide.rst
   src/troubleshooting.rst
-  
+  src/receivers.rst
+  src/slsreceiver.rst
 )
 
 foreach(filename ${SPHINX_SOURCE_FILES})

docs/src/commandline.rst

@@ -30,3 +30,18 @@ Commands
 -----------
 
 .. include:: ../commands.rst
+
+
+Depreciated commands
+------------------------
+
+.. note ::
+	All the dac commands are preceded with the **dac** command. Use command **daclist** to get correct list of dac command arguments for current detector.
+
+.. csv-table:: Depreciated commands
+   :file: ../depreciated.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+
+

docs/src/consuming.rst

@@ -9,7 +9,7 @@ CMake approaches.
 One can test with :ref:`detector simulators<Virtual Detector Servers>` before testing the API with a real detector or when a real detector is not at hand.
 
 CMake: slsDetectorPackage as submodule in your project
----------------------------------------
+---------------------------------------------------------------
 
 If you are using CMake to build your integration and want to build everything
 in one go, we support adding slsDetectorPackage as a subfolder in your cmake project. 
@@ -91,7 +91,7 @@ manually when invoking g++. This can sometimes be handy for a quick try.
 
 .. code-block:: cpp
 
-    #include "Detector.h"
+    #include "sls/Detector.h"
     #include <iostream>
     int main(){
 

docs/src/dependencies.rst

@@ -34,6 +34,12 @@ Python bindings
  * pybind11 (packaged in libs/)
 
 
+-----------------------
+Moench executables
+-----------------------
+
+ * libtiff
+
 -----------------------
 Documentation
 -----------------------

docs/src/examples.rst

@@ -36,7 +36,7 @@ Running a config file [e1]
 
 .. code-block:: cpp
 
-    #include "Detector.h"
+    #include "sls/Detector.h"
     ...
     sls::Detector det;
     det.loadConfig("path/to/config/file.config");
@@ -105,7 +105,7 @@ as converting to floating point.
 
 .. code-block:: cpp
 
-    #include "Detector.h"
+    #include "sls/Detector.h"
     #include <chrono>
     ...
     std::chrono::microseconds t0{500};

docs/src/firmware.rst

@@ -1,8 +1,6 @@
 Firmware Upgrade
 =================
 
-
-
 Eiger
 -------------
 
@@ -12,61 +10,15 @@ Download
 
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- bit files
-    .. list-table:: 
-       :widths: 25 10 30 25 10
-       :header-rows: 1
-
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - v5.0.0-rcx
-         - 
-         - 08.09.2020
-         - `v27 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/v27/>`__
-         - 
-       * - v4.0.0 - v4.2.0
-         - 
-         - 30.07.2019
-         - `v24 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/v24/>`__
-         - 
-       * - v3.1.0 - v3.1.5
-         - 
-         - 17.08.2017
-         - `v20 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/v20/>`__
-         -
-
+- `bit files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 Upgrade
 ^^^^^^^^
 #. Tftp must be already installed on your pc to use the bcp script.
 
-#. Kill the on-board servers and copy new servers to the board. 
+#. Copy new servers to the board. See :ref:`how to upgrade detector servers<Detector Server Upgrade>` for more detals. A reboot should have started the new linked servers automatically. For Eiger, do not reboot yet as we need to program the firmware via bit files.
 
-    .. code-block:: bash
-
-        # Option 1: from detector console
-        # kill old server
-        ssh root@bebxxx
-        killall eigerDetectorServer
-
-        # copy new server
-        cd executables
-        scp user@pc:/path/eigerDetectorServerxxx .
-        chmod 777 eigerDetectorServerxxx
-        ln -sf eigerDetectorServerxxx eigerDetectorServer
-        sync
-
-        # Options 2: from client console for multiple modules
-        for i in bebxxx bebyyy;
-        do ssh root@$i killall eigerDetectorServer;
-        scp eigerDetectorServerxxx root@$i:~/executables/eigerDetectorServer;
-        ssh root@$i sync; done
-
-
-    * This is crucial when registers between firmwares change. Failure to do so will result in linux on boards to crash and boards can't be pinged anymore.
+    * This step is crucial when registers between firmwares change. Failure to do so will result in linux on boards to crash and boards can't be pinged anymore.
 
 #. Bring the board into programmable mode using either of the 2 ways. Both methods result in only the central LED blinking.
     
@@ -75,8 +27,13 @@ Upgrade
         Do a hard reset for each half module on back panel boards, between the LEDs, closer to each of the 1G ethernet connectors. Push until all LEDs start to blink.
     
     * Software:  
+
         .. code-block:: bash
 
+            # Option 1: if the old server is still running:
+            sls_detector_put execcommand "./boot_recovery"
+
+            # Option 2:
             ssh root@bebxxx
             cd executables
             ./boot_recovery
@@ -104,11 +61,24 @@ Upgrade
         #update front right fpga
         bcp download.bit bebxxx:/febr
 
-        #update kernel (only if required by the SLS Detector Group)
+        #update kernel (only if required by us)
         bcp download.bit bebxxx:/kernel
 
 #. Reboot the detector.
 
+    .. code-block:: bash
+
+        # In the first terminal where we saw "Succeess"
+        # reconfig febX is necessary only if you have flashed a new feb firmware
+        reconfig febl
+        reconfig febr
+        # will reboot controller
+        reconfig fw0
+
+.. note :: 
+
+    If the detector servers did not start up automatically after reboot, you need to add scripts to do that. See :ref:`Automatic start<Automatic start servers>` for more details.
+
 Jungfrau
 -------------
 
@@ -116,146 +86,53 @@ Download
 ^^^^^^^^^^^^^
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- pof files
-    .. list-table:: 
-       :widths: 25 10 30 25 10
-       :header-rows: 1
-
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - v5.0.0-rcx
-         - 2.0
-         - 21.07.2020
-         - `v2.1 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v2_1/jungfrau_v2_1.pof>`__
-         - 
-       * - v5.0.0-rcx
-         - 1.0
-         - 24.07.2020
-         - `v1.1 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v1_1/jungfrau_v1_1.pof>`__
-         - 
-       * - v4.0.1 - v4.2.0
-         - 1.0
-         - 06.12.2018
-         - `v0.7 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v0_7/jungfrau_v0_7.pof>`__
-         - 
-       * - v3.1.0 - v3.1.5
-         - 1.0
-         - 13.11.2017
-         - `v0.6 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v0_6/jungfrau_v0_6.pof>`__
-         -
+- `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
+Upgrade
+^^^^^^^^
 
-Upgrade (from v4.x.x)
-^^^^^^^^^^^^^^^^^^^^^^
-#. Tftp must be installed on pc.
+.. note :: 
 
-#. Update client package to the latest (5.0.0-rc1).
+    These instructions are for upgrades from v5.0.0. For earlier versions, contact us.
 
-#. Disable server respawning or kill old server
+
+Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
+
+Always ensure that the client and server software are of the same release.
+
+
+Program from console
     .. code-block:: bash
 
-        # Option 1: if respawning enabled
-        telnet bchipxxx
-        # edit /etc/inittab
-        # comment out line #ttyS0::respawn:/jungfrauDetectorServervxxx
-        reboot
-        # ensure servers did not start up after reboot
-        telnet bchipxxx
-        ps
-
-        #  Option 2: if respawning already disabled
-        telnet bchipxxx
-        killall jungfrauDetectorServerv*
-
-#. Copy new server and start in update mode
-    .. code-block:: bash
-
-        tftp pcxxx -r jungfrauDetectorServervxxx -g
-        chmod 777 jungfrauDetectorServervxxx
-        ./jungfrauDetectorServervxxx -u
-
-#. Program fpga from the client console
-    .. code-block:: bash
-
-        sls_detector_get free
-        # Crucial that the next command executes without any errors
-        sls_detector_put hostname bchipxxx
-        sls_detector_put programfpga xxx.pof
-
-#. After programming, kill 'update server' using Ctrl + C in server console.
-
-#. Enable server respawning if needed
-    .. code-block:: bash
-
-        telnet bchipxxx
-        # edit /etc/inittab
-        # uncomment out line #ttyS0::respawn:/jungfrauDetectorServervxxx
-        # ensure the line has the new server name
-        reboot
-        # ensure both servers are running using ps
-        jungfrauDetectorServervxxx
-        jungfrauDetectorServervxxx --stop-server 1953
-
-
-Upgrade (from v5.0.0-rcx)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. Program from console
-    .. code-block:: bash
-
-        # copies server from tftp folder of pc, programs fpga,
-        # removes old server from respawn, sets up new server to respawn
-        # and reboots
+        # copies server from tftp folder of pc, links new server to jungfrauDetectorServer, 
+        # removes old server from respawn, sets up new lnked server to respawn
+        # programs fpga,
+        # reboots
         sls_detector_put update jungfrauDetectorServervxxx pcxxx xx.pof
 
         # Or only program firmware
         sls_detector_put programfpga xxx.pof
 
 
-Gotthard
----------
+
+Gotthard I
+-----------
 
 Download 
 ^^^^^^^^^^^^^
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- pof files
-    .. list-table:: 
-       :widths: 15 15 15 15 5
-       :header-rows: 1
-
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - All versions
-         - 50um
-         - 08.02.2018
-         - `50um <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/gotthard_I/50um/gotthard_I_50um.pof>`__
-         - 
-       * - All versions
-         - 25um (master)
-         - 08.02.2018
-         - `25um (master) <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/gotthard_I/25um/master/gotthard_I_25um_master.pof>`__
-         - 
-       * - All versions
-         - 25um (slave)
-         - 09.02.2018
-         - `25um (slave) <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/gotthard_I/25um/slave/gotthard_I_25um_slave.pof>`__
-         - 
+- `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
+.. _firmware upgrade using blaster for blackfin:
 
 Upgrade
 ^^^^^^^^
 .. warning ::
     | Gotthard firmware cannot be upgraded remotely and requires the use of USB-Blaster.
-    | It is generally updated by the SLS Detector group.
+    | It is generally updated by us.
 
 #. Download `Altera Quartus software or Quartus programmer <https://fpgasoftware.intel.com/20.1/?edition=standard&platform=linux&product=qprogrammer#tabs-4>`__.
    
@@ -266,7 +143,7 @@ Upgrade
 
 #. Plug the end of your USB-Blaster with the adaptor provided to the connector 'AS config' on the Gotthard board.
 
-#. Click on 'Add file'. Select programming (pof) file provided by the SLS Detector group.
+#. Click on 'Add file'. Select programming (pof) file provided by us.
 
 #. Check "Program/Configure" and "Verify". Push the start button. Wait until the programming process is finished.
 
@@ -275,91 +152,69 @@ Upgrade
 #. Reboot the detector.
 
 
-Mythen3
--------
+Mythen III
+-----------
 
 .. note :: 
 
-  As it is still in developement, the rbf files must be picked up from the SLS Detector Group.
+  As it is still in development, the rbf files must be picked up from us.
 
 Download 
 ^^^^^^^^^^^^^
 
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- rbf files
-    .. list-table:: 
-       :widths: 25 10 30 25 10
-       :header-rows: 1
-
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - v5.0.0-rcx
-         - 
-         - 25.09.2020
-         - 
-         - development
+- `rbf files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
-Upgrade (from v5.0.0-rcx)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Upgrade
+^^^^^^^^
 
-#. Program from console
+Always ensure that the client and server software are of the same release.
+
+Program from console
     .. code-block:: bash
 
-        # copies server from tftp folder of pc, programs fpga,
-        # and reboots (new server not respawned currently)
+        # copies server from tftp folder of pc, links new server to mythen3DetectorServer, 
+        # programs fpga,
+        # reboots
         sls_detector_put update mythen3DetectorServervxxx pcxxx xxx.rbf
 
         # Or only program firmware
         sls_detector_put programfpga xxx.rbf
 
-
-
-Gotthard2
--------------
-
 .. note :: 
 
-  As it is still in developement, the rbf files must be picked up from the SLS Detector Group.
+    If the detector servers did not start up automatically after reboot, you need to add scripts to do that. See :ref:`Automatic start<Automatic start servers>` for more details.
+
+Gotthard II
+-------------
 
 Download 
 ^^^^^^^^^^^^^
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- rbf files
-    .. list-table:: 
-       :widths: 25 10 30 25 10
-       :header-rows: 1
+- `rbf files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - v5.0.0-rcx
-         - 
-         - 25.09.2020
-         - 
-         - development
+Upgrade
+^^^^^^^^
 
-Upgrade (from v5.0.0-rcx)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Always ensure that the client and server software are of the same release.
 
-#. Program from console
+Program from console
     .. code-block:: bash
 
-        # copies server from tftp folder of pc, programs fpga,
-        # and reboots (new server not respawned currently)
+        # copies server from tftp folder of pc, links new server to gotthard2DetectorServer, 
+        # programs fpga,
+        # reboots
         sls_detector_put update gotthard2DetectorServervxxx pcxxx xxx.rbf
 
         # Or only program firmware
         sls_detector_put programfpga xxx.rbf
 
+.. note :: 
 
+    If the detector servers did not start up automatically after reboot, you need to add scripts to do that. See :ref:`Automatic start<Automatic start servers>` for more details.
 
 Moench
 -------
@@ -368,36 +223,24 @@ Download
 ^^^^^^^^^^^^^
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- pof files
-    .. list-table:: 
-       :widths: 25 10 30 25 10
-       :header-rows: 1
+- `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - v5.0.0-rcx
-         - EPCQ128
-         - 05.10.2020
-         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/moench/EPCQ128/v1_0/moench_v1_0_201005.pof>`__
-         - 
-       * - v5.0.0-rcx
-         - EPCS128
-         - 05.10.2020
-         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/moench/EPCS128/v1_0/moench_v1_0_201005.pof>`__
-         - 
 
-Upgrade (from v5.0.0-rcx)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-#. Program from console
+Upgrade
+^^^^^^^^
+
+Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
+
+Always ensure that the client and server software are of the same release.
+
+Program from console
     .. code-block:: bash
 
-        # copies server from tftp folder of pc, programs fpga,
-        # removes old server from respawn, sets up new server to respawn
-        # and reboots
+        # copies server from tftp folder of pc, links new server to moenchDetectorServer, 
+        # removes old server from respawn, sets up new lnked server to respawn
+        # programs fpga,
+        # reboots
         sls_detector_put update moenchDetectorServervxxx pcxxx xx.pof
 
         # Or only program firmware
@@ -410,37 +253,107 @@ Download
 ^^^^^^^^^^^^^
 - detector server corresponding to package in slsDetectorPackage/serverBin
 
-- pof files
-    .. list-table:: 
-       :widths: 25 10 30 25 10
-       :header-rows: 1
+- `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
-       * - Software
-         - Hardware
-         - Firmware Date
-         - Firmware Link
-         - Comments
-       * - v5.0.0-rcx
-         - EPCQ128
-         - 05.10.2020
-         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/ctb/EPCQ128/v1_0/ctb_v1_0_201005.pof>`__
-         - 
-       * - v5.0.0-rcx
-         - EPCS128
-         - 05.10.2020
-         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/ctb/EPCS128/v1_0/ctb_v1_0_201005.pof>`__
-         - 
 
-Upgrade (from v5.0.0-rcx)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-#. Program from console
+Upgrade
+^^^^^^^^
+
+Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
+
+Always ensure that the client and server software are of the same release.
+
+Program from console
     .. code-block:: bash
 
-        # copies server from tftp folder of pc, programs fpga,
-        # removes old server from respawn, sets up new server to respawn
-        # and reboots
+        # copies server from tftp folder of pc, links new server to ctbDetectorServer, 
+        # removes old server from respawn, sets up new lnked server to respawn
+        # programs fpga,
+        # reboots
         sls_detector_put update ctbDetectorServervxxx pcxxx xx.pof
 
         # Or only program firmware
         sls_detector_put programfpga xxx.pof
+
+
+.. _blackfin firmware troubleshooting:
+
+Firmware Troubleshooting with blackfin
+----------------------------------------
+
+1. v4.x.x client after programming will most likely reboot the blackfin processor, regardless of error.
+
+2. v5.x.x-rcx client after programming will not reboot the blackfin processor, if error occurred.
+
+3. If a reboot occured with an incomplete firmware in flash, the blackfin will most likely not find the mtd3 drive. To see if this drive exists:
+
+  .. code-block:: bash
+    
+    # connect to the board
+    telnet bchipxxx
+
+    # view of mtd3 existing
+    root:/> more /proc/mtd
+    dev:    size   erasesize  name
+    mtd0: 00040000 00020000 "bootloader(nor)"
+    mtd1: 00100000 00020000 "linux kernel(nor)"
+    mtd2: 002c0000 00020000 "file system(nor)"
+    mtd3: 01000000 00010000 "bitfile(spi)"
+
+4. If one can see the mtd3 drive, one can already try to flash again using the **programfpga** command (without rebooting blackfin or detector). 
+
+5. If one can't list it, read the next section to try to get the blackfin to list it.
+
+How to get back mtd3 drive remotely (udpating kernel)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    You have 2 alternatives to update the kernel.
+
+    1. Commands via software (>= v6.0.0)
+
+        .. code-block:: bash
+
+            sls_detector_put updatekernel /home/...path-to-kernel-image
+
+
+    2. or command line 
+    
+        .. code-block:: bash
+            
+            # step 1: get the kernel image (uImage.lzma) from slsdetectorgroup
+            # and copy it to pc's tftp folder
+
+            # step 2: connect to the board
+            telnet bchipxxx
+
+            #step 3: go to directory for space
+            cd /var/tmp/
+
+            # step 3: copy kernel to board
+            tftp pcxxx -r uImage.lzma -g
+
+            # step 4: verify kernel copied properly
+            ls -lrt
+            
+            # step 5: erase flash
+            flash_eraseall /dev/mtd1
+            
+            # step 6: copy new image to kernel drive
+            cat uImage.lzma > /dev/mtd1
+            
+            # step 7:
+            sync
+            
+            # step 8:
+            reboot
+            
+            # step 9: verification
+            telnet bchipxxx
+            uname -a # verify kernel date
+            more /proc/mtd # verify mtd3 is listed
+            
+
+Last Resort using USB Blaster
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If none of these steps work, the last resort might be physically upgrading the firmware using a USB blaster, which also requires opening up the detector. Instructions for all the blackfin detectors are the same as the one for :ref:`gotthard firmware upgrade <firmware upgrade using blaster for blackfin>`.

docs/src/gendoc.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 /**
  * Utility program to generate input files for the command line
  * documentation. Uses the string returned from sls_detector_help cmd
@@ -10,8 +12,8 @@
 #include <vector>
 
 #include "CmdProxy.h"
-#include "Detector.h"
-#include "sls_detector_defs.h"
+#include "sls/Detector.h"
+#include "sls/sls_detector_defs.h"
 
 std::string replace_all(const std::string &src, const std::string &from,
                         const std::string &to) {
@@ -51,4 +53,11 @@ int main() {
         auto help = replace_all(tmp, "\n\t", "\n\t\t| ");
         fs << '\t' << cmd << usage << help << "\n";
     }
+
+    std::ofstream fs2("depreciated.csv");
+    fs2 << "Old, New\n";
+    auto cmds = proxy.GetDepreciatedCommands();
+    for (auto it : cmds) {
+        fs2 << it.first << ", " << it.second << '\n';
+    }
 }

docs/src/index.rst

@@ -66,6 +66,13 @@ Welcome to slsDetectorPackage's documentation!
     virtualserver
     serverdefaults
 
+.. toctree::
+    :caption: Receiver
+    :maxdepth: 2
+
+    receivers
+    slsreceiver
+
 .. toctree::
     :caption: Troubleshooting
 

docs/src/installation.rst

@@ -21,6 +21,8 @@
 Installation
 ==============================================
 
+.. _build from source using cmake:
+
 Build from source using CMake
 ---------------------------------
 
@@ -47,25 +49,39 @@ The easiest way to configure options is to use the ccmake utility.
 
 Build using cmk.sh script
 -------------------------
+These are mainly aimed at those not familiar with using ccmake and cmake.
+
 .. code-block:: bash
 
     The binaries are generated in slsDetectorPackage/build/bin directory.
 
-    # new build and make with 9 parallel threads
-    ./cmk.sh -cbj9
-
-    # build with python
-    ./cmk.sh -bpj9
-
-    # build with GUI
-    ./cmk.sh -bgj9
-
-    # build with hdf5
-    ./cmk.sh -hj9 -d [path of hdf5 dir]
+    Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-l Install directory] [-k <CMake command>] [-j <Number of threads>]
+    -[no option]: only make
+    -c: Clean
+    -b: Builds/Rebuilds CMake files normal mode
+    -p: Builds/Rebuilds Python API
+    -h: Builds/Rebuilds Cmake files with HDF5 package
+    -d: HDF5 Custom Directory
+    -k: CMake command
+    -l: Install directory
+    -t: Build/Rebuilds only text client
+    -r: Build/Rebuilds only receiver
+    -g: Build/Rebuilds only gui
+    -s: Simulator
+    -u: Chip Test Gui
+    -j: Number of threads to compile through
+    -e: Debug mode
+    -i: Builds tests
+    -m: Manuals
+    -n: Manuals without compiling doxygen (only rst)
+    -z: Moench zmq processor
     
     # get all options
     ./cmk.sh -?
 
+    # new build  and compile in parallel:
+    ./cmk.sh -bj5
+
 
 Install binaries using conda
 --------------------------------

docs/src/pyenums.rst

@@ -67,11 +67,23 @@ exposed to Python through pybind11.
 .. autoclass:: readoutMode
     :undoc-members:
 
-.. autoclass:: masterFlags
-    :undoc-members:
-
 .. autoclass:: burstMode
     :undoc-members:
 
 .. autoclass:: timingSourceType
     :undoc-members:
+
+.. autoclass:: M3_GainCaps
+    :undoc-members:    
+
+.. autoclass:: portPosition
+    :undoc-members:
+
+.. autoclass:: streamingInterface
+    :undoc-members:
+
+.. autoclass:: vetoAlgorithm
+    :undoc-members:
+
+.. autoclass:: gainMode
+    :undoc-members:

docs/src/pygettingstarted.rst

@@ -219,7 +219,7 @@ The enums can be found in slsdet.enums
     >>> [e for e in dir(slsdet.enums) if not e.startswith('_')]
     ['burstMode', 'clockIndex', 'dacIndex', 
     'detectorSettings', 'detectorType', 'dimension', 'externalSignalFlag', 
-    'fileFormat', 'frameDiscardPolicy', 'masterFlags', 
+    'fileFormat', 'frameDiscardPolicy', 
     'readoutMode', 'runStatus', 'speedLevel', 'timingMode', 
     'timingSourceType']
 

docs/src/receiver_api.rst

@@ -1,6 +1,6 @@
 Receiver
 ==============================================
 
-.. doxygenclass:: Receiver
+.. doxygenclass:: sls::Receiver
    :members:
 ..    :undoc-members:

docs/src/receivers.rst

@@ -0,0 +1,71 @@
+Receivers
+=================
+
+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.
+
+Detector UDP Header
+---------------------
+
+| The UDP data format for the packets consist of a common header for all detectors, followed by the data for that one packet.
+
+**The SLS Detector Header**
+
+.. table:: <-------------------------------- 8 bytes -------------------------------->
+    :align: center
+    :widths: 30,30,30,30
+
+    +--------------------------------------------------------------------+
+    |frameNumber                                                         |
+    +---------------------------------+----------------------------------+
+    |expLength                        |packetNumber                      |
+    +---------------------------------+----------------------------------+
+    |bunchId                                                             |
+    +--------------------------------------------------------------------+
+    |timestamp                                                           |
+    +----------------+----------------+----------------+-----------------+
+    |modId           |row             |column          |reserved         |
+    +----------------+----------------+----------------+--------+--------+
+    |debug                            |roundRNumber    |detType |version |
+    +---------------------------------+----------------+--------+--------+
+
+UDP configuration in Config file
+----------------------------------
+
+#. UDP source port is hardcoded in detector server, starting at 32410.
+#. **udp_dstport** : UDP destination port number. Port in receiver pc to listen to packets from the detector.
+#. **udp_dstip** : IP address of UDP destination interface. IP address of interface in receiver pc to listen to packets from detector. If **auto** is used (only when using slsReceiver/ slsMultiReceiver), the IP of **rx_hostname** is picked up.
+#. **udp_dstmac** : Mac address of UDP destination interface. MAC address of interface in receiver pc to list to packets from detector. Only required when using custom receiver, else slsReceiver/slsMultiReceiver picks it up from **udp_dstip**.
+#. **udp_srcip** : IP address of UDP source interface. IP address of detector UDP interface to send packets from. Do not use for Eiger 1Gb interface (uses its hardware IP). For others, must be in the same subnet as **udp_dstip**.
+#. **udp_srcmac** : MAC address of UDP source interface. MAC address of detector UDP interface to send packets from. Do not use for Eiger (uses hardware mac). For others, it is not necessary, but can help for switch and debugging to put unique values for each module.
+ 
+
+Custom 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**.
+
+| Also ensure that there are no **rx_** commands in the config file. These commands are for configuring the slsReceiver.
+
+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
+    hostname bchip052
+
+    # udp destination port (receiver)
+    udp_dstport 50004
+
+    # udp destination ip (receiver)
+    udp_dstip 10.0.1.100
+
+    # udp source ip (same subnet as udp_dstip)
+    udp_srcip 10.0.1.184
+
+    # udp destination mac
+    udp_dstmac 22:47:d5:48:ad:ef

docs/src/servers.rst

@@ -34,3 +34,63 @@ Detector Servers include:
       *  Client requests for detector status, stop acquisition, temperature, advanced read/write registers.
 
 When using a blocking acquire command (sls_detector_acquire or Detector::acquire), the control server is blocked until end of acquisition. However, stop server commands could be used in parallel.
+
+
+.. _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 
+   :
+      .. code-block:: bash
+      
+         ln -sf someDetectorServervx.x.x someDetectorServer
+
+
+
+#. Do the following depending on the detector type :
+
+   Eiger
+      .. code-block:: bash
+         
+         # create script in rc5.d on the board
+         vi /etc/rc5.d/S50board_com.sh
+
+         # enter the following (edit server name)
+         #! /bin/sh
+         /home/root/executables/eigerDetectorServer &> /dev/null &
+         exit 0
+
+   Jungfrau | Moench | CTB | Gotthard I
+      .. code-block:: bash
+
+         # Edit inittab on board
+         vi /etc/inittab
+
+         # enter the following line
+         ttyS0::respawn:/./xxxDetectorServer
+
+
+   Gotthard II | Mythen III
+      .. code-block:: bash
+         
+         # create script in init.d on board
+         vi /etc/init.d/S99detServer.sh
+
+         # enter the following (edit server name)
+         #! /bin/sh
+         cd /root >> /dev/null
+         /root/xxxDetectorServer >> /dev/null &
+
+
+#. Sync, reboot and verify
+   :
+      .. code-block:: bash
+      
+         sync
+         reboot
+
+         # verify
+         ps -ef | grep xxxDetectorServer

docs/src/serverupgrade.rst

@@ -1,114 +1,44 @@
+.. _Detector Server Upgrade:
 Detector Server Upgrade
 =======================
 
 
-
-Eiger
--------------
-
-
 **Location:** slsDetectorPackage/serverBin/ folder for every release.
 
 
-#. Kill old server and copy new server
-    .. code-block:: bash
-
-        # Option 1: from detector console
-        # kill old server
-        ssh root@bebxxx
-        killall eigerDetectorServer
-
-        # copy new server
-        cd executables
-        scp user@pc:/path/eigerDetectorServerxxx .
-        chmod 777 eigerDetectorServerxxx
-        ln -sf eigerDetectorServerxxx eigerDetectorServer
-        sync
-
-        # Options 2: from client console for multiple modules
-        for i in bebxxx bebyyy;
-        do ssh root@$i killall eigerDetectorServer;
-        scp eigerDetectorServerxxx root@$i:~/executables/eigerDetectorServer;
-        ssh root@$i sync; done
-
-
-#. Reboot the detector.
-
-
-Jungfrau
--------------
-
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
-
 #. Install tftp and copy detector server binary to tftp folder
-#. Program from console (only from 5.0.0-rcx)
+#. Program from console
+
+    .. note :: 
+
+        These instructions are for upgrades from v5.0.0. For earlier versions, contact us.
+
     .. code-block:: bash
 
-        # copies new server from pc tftp folder, respawns and reboots
-        sls_detector_put copydetectorserver jungfrauDetectorServerxxx pcxxx
+        # copies new server from pc tftp folder, creates a soft link to xxxDetectorServerxxx
+        # [Jungfrau][CTB][Moench] also edits initttab to respawn server on reboot
+        # Then, the detector controller will reboot (except Eiger)
+        sls_detector_put copydetectorserver xxxDetectorServerxxx pcxxx
+
+#. Copy the detector server specific config files or any others required to the detector:
+
+   .. code-block:: bash
+
+        sls_detector_put execcommand "tftp pcxxx -r configxxx -g"
 
 
-Gotthard
----------
+.. note :: 
 
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
+    For Mythen3, Gotthard2 and Eiger, you need to add scripts to automatically start detector server upon power on. See :ref:`Automatic start<Automatic start servers>` for more details.
 
-#. Install tftp and copy detector server binary to tftp folder
-#. Program from console (only from 5.0.0-rcx)
-    .. code-block:: bash
+ .. note :: 
 
-        # copies new server from pc tftp folder, respawns and reboots
-        sls_detector_put copydetectorserver gotthardDetectorServerxxx pcxxx
+    Eiger requires a manual reboot. Or killall the servers and restart the new linked one. If you are in the process of updating firmware, then don't reboot yet.
 
 
-
-Mythen3
--------
-
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
-
-#. Install tftp and copy detector server binary to tftp folder
-#. Program from console (only from 5.0.0-rcx)
-    .. code-block:: bash
-
-        # copies new server from pc tftp folder and reboots (does not respawn)
-        sls_detector_put copydetectorserver mythen3DetectorServerxxx pcxxx
-
-
-Gotthard2
-----------
-
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
-
-#. Install tftp and copy detector server binary to tftp folder
-#. Program from console (only from 5.0.0-rcx)
-    .. code-block:: bash
-
-        # copies new server from pc tftp folder and reboots (does not respawn)
-        sls_detector_put copydetectorserver gotthard2DetectorServerxxx pcxxx
-
-
-Moench
+Errors
 ------
 
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
+#. tftp write error: There is no space left. Please delete some old binaries and try again.
 
-#. Install tftp and copy detector server binary to tftp folder
-#. Program from console (only from 5.0.0-rcx)
-    .. code-block:: bash
-
-        # copies new server from pc tftp folder, respawns and reboots
-        sls_detector_put copydetectorserver moenchDetectorServerxxx pcxxx
-
-
-Ctb
----
-
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
-
-#. Install tftp and copy detector server binary to tftp folder
-#. Program from console (only from 5.0.0-rcx)
-    .. code-block:: bash
-
-        # copies new server from pc tftp folder, respawns and reboots
-        sls_detector_put copydetectorserver ctbDetectorServerxxx pcxxx
+#. text file busy: You are trying to copy the same server.

docs/src/slsreceiver.rst

@@ -0,0 +1,170 @@
+slsReceiver/ slsMultiReceiver
+================================
+
+| One has to start the slsReceiver before loading config file or using any receiver commands (prefix: **rx_** )
+
+For a Single Module
+    .. code-block:: bash  
+
+        # default port 1954
+        slsReceiver
+
+        # custom port 2012
+        slsReceiver -t2012
+
+
+For Multiple Modules
+    .. code-block:: bash  
+
+        # each receiver (for each module) requires a unique tcp port (if all on same machine)
+
+        # using slsReceiver in multiple consoles
+        slsReceiver
+        slsReceiver -t1955
+
+        # slsMultiReceiver [starting port] [number of receivers]
+        slsMultiReceiver 2012 2
+
+        # slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]
+        slsMultiReceiver 2012 2 1
+
+
+Client Commands 
+-----------------
+
+| One can remove **udp_dstmac** from the config file, as the slsReceiver fetches this from the **udp_ip**.
+
+| One can use "auto" for **udp_dstip** if one wants to use default ip of **rx_hostname**.
+
+| The first command to the receiver (**rx_** commands) should be **rx_hostname**. The following are the different ways to establish contact.
+
+    .. code-block:: bash  
+
+        # default receiver tcp port (1954)
+        rx_hostname xxx
+
+        # custom receiver port
+        rx_hostname xxx:1957
+
+        # custom receiver port
+        rx_tcpport 1954
+        rx_hostname xxx
+
+        # multi modules with custom ports
+        rx_hostname xxx:1955+xxx:1956+
+
+        # multi modules with custom ports on same rxr pc
+        0:rx_tcpport 1954
+        1:rx_tcpport 1955
+        2:rx_tcpport 1956
+        rx_hostname xxx
+
+        # multi modules with custom ports on different rxr pc
+        0:rx_tcpport 1954
+        0:rx_hostname xxx
+        1:rx_tcpport 1955
+        1:rx_hostname yyy
+
+
+| Example commands:
+
+    .. code-block:: bash 
+
+        # to get a list of receiver commands (these dont include file commands)
+        sls_detector_get list | grep rx_
+
+        # some file commands are:
+        fwrite
+        foverwrite
+        findex
+        fpath
+        fname
+        fmaster
+        fformat
+
+        # to get help on a single commands
+        sls_detector_get -h rx_framescaught
+
+
+File 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.
+
+* SLS Receiver Header consist of SLS Detector Header + 64 bytes of bitmask, altogether 112 bytes. The packetNumber in the sls detector header part, will be updated to number of packets caught by receiver for that frame. Furthermore, the bit mask will specify which packets have been received.
+
+**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 
+-------------
+
+Please refer to Receiver PC Tuning options and slsReceiver Tuning under `Troubleshooting <https://slsdetectorgroup.github.io/devdoc/troubleshooting.html>`_.
+
+
+Using Callbacks
+----------------
+
+One can get a callback in the receiver for each frame to:
+    * manipulate the data that will be written to file, or
+    * disable file writing in slsReceiver and take care of the data for each call back
+
+When handling callbacks, the control should be returned as soon as possible, to prevent packet loss from fifo being full.
+
+**Example**
+    * `main cpp file <https://github.com/slsdetectorgroup/api-examples/blob/master/e4-receiver_callbacks.cpp>`_ 
+    * `cmake file <https://github.com/slsdetectorgroup/api-examples/blob/master/CMakeLists.txt>`_. 
+    * how to install the slsDetectorPackage is provided :ref:`here <build from source using cmake>`.
+    * compile the example **e4-rxr** by:
+
+        .. code-block:: bash
+
+            cmake ../path/to/your/source -DCMAKE_PREFIX_PATH=/path/to/sls/install
+            make
+            

docs/src/troubleshooting.rst

@@ -1,6 +1,10 @@
 Troubleshooting
 =================
 
+If something is missing, don't hesitate to
+open an issue at our  `github repo issues
+<https://github.com/slsdetectorgroup/slsDetectorPackage/issues>`_. 
+
 Common
 ------
 
@@ -243,6 +247,19 @@ Possible causes could be the following:
     * For Jungfrau, refer to :ref:`Jungfrau Power Supply Troubleshooting<Jungfrau Troubleshooting Power Supply>`.
 
 
+Cannot ping module (Nios)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you executed "reboot" command on the board, you cannot ping it anymore unless you power cycle. To reboot the controller, please use the software command ("rebootcontroller"), which talks to the microcontroller.
+
+Gotthard2
+---------
+
+Cannot get data without a module attached
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You cannot get data without a module attached as a specific pin is floating. Attach module to get data.
+
 
 Gotthard
 ----------

docs/src/virtualserver.rst

@@ -60,6 +60,7 @@ Client
     sls_detector_put virtual 2 1912 
 
 Use the same in the config file.
+Detector API has a method 'isVirtualDetectorServer' to check if on-board detector server is virtual.
 
 
 Sample Config file

evalVersionVariables.sh

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 GITREPO1='git remote -v'
 GITREPO2=" | grep \"fetch\" | cut -d' ' -f1"
 BRANCH1='git branch -v'

examples/jungfrau.config

@@ -8,18 +8,15 @@ rx_hostname pcmoench01
 udp_dstport 50004
 
 # udp destination ip (receiver)
-#udp_dstip 172.24.8.84
-# or to get ip from rx_hostname
-udp_dstip auto 
+udp_dstip 10.0.1.100
 
 # udp source ip (same subnet as udp_dstip)
-udp_srcip 172.24.8.254
+udp_srcip 10.0.1.184
 
-
-# PCBv2.0 (using 2 interfaces)
+# PCBv2.0 (using 2 interfaces, top)
 udp_dstport2 50005
-udp_dstip2 auto 
-udp_srcip2 172.24.8.111
+udp_dstip2 10.0.2.100 
+udp_srcip2 10.0.2.184
 # enable two interfaces
 numinterfaces 2
 # select inner interface(effective only when numinterfaces is 1)

examples/jungfrau_custom_receiver.config

@@ -0,0 +1,39 @@
+# detector hostname
+hostname bchip052
+
+# do not use any rx_ or "file" (eg. fwrite, fpath) commands, which go to slsReceiver/slsMultiReceiver
+
+# udp destination port (receiver)
+udp_dstport 50004
+
+# udp destination ip (receiver)
+udp_dstip 10.0.1.100
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 10.0.1.184
+
+# udp destination mac
+udp_dstmac 22:47:d5:48:ad:ef
+
+
+# PCBv2.0 (using 2 interfaces, top)
+udp_dstport2 50005
+udp_dstip2 10.0.2.100 
+udp_srcip2 10.0.2.184
+udp_dstmac2 22:47:d5:48:ad:ff
+
+
+# enable two interfaces
+numinterfaces 2
+# select inner interface(effective only when numinterfaces is 1)
+#selinterface 1
+
+# power on chip
+powerchip 1
+
+# high voltage
+highvoltage 200
+
+# timing to trigger
+timing trigger
+

examples/moench03_T1.config

@@ -1,34 +1,35 @@
-initialchecks 0
+#initialchecks 0
 #############################################
 ### edit with hostname or IP address of your detector 
 ############################################
-hostname bchip181+
+#hostname bchip181+
+hostname bchip119.psi.ch
 
 #############################################
 ### edit with hostname or 1Gbs IP address of your server
 ############################################
-rx_hostname mpc2011
+rx_hostname mpc2011:1777
 
 #############################################
 ### edit with 10 Gbs IP of your server
 ############################################
-udp_dstip 10.1.1.102
+udp_dstip 10.1.2.102
 #############################################
 ### edit with any number in the subnet of your server (first 3 numbers as above)
 ############################################
-udp_srcip 10.1.1.19
-udp_dstport 32411
+udp_srcip 10.1.2.19
+udp_dstport 32000
 
 #############################################
 ### edit with 10 Gbs IP of your server
 ############################################
-rx_zmqip 10.1.1.102
-rx_zmqport 50003
+rx_zmqip 10.1.2.102
+rx_zmqport 77000
 #############################################
 ### edit with 1 Gbs IP of PC where you will run the GUI
 ############################################
-zmqip 129.129.202.136
-zmqport 50001
+zmqip  129.129.202.132
+zmqport 77001
 
 
 
@@ -37,13 +38,14 @@ rx_zmqstream 1
 
 
 
-frames 100000
+frames 1000
 period 0.0006
+exptime 0.00035
 
 #############################################
 ### edit with directory you want to write to
 ############################################
-fpath /mnt/moench_data/scratch/
+fpath /mnt/moench_data/scratch1/
 
 fwrite 0
 
@@ -60,3 +62,9 @@ highvoltage 90
 #adcreg 0x14 0x40
 
 
+
+frames 10
+period 0.1
+rx_jsonpara subframes 1
+rx_jsonpara frameMode raw
+rx_jsonpara detectorMode analog

genVersionHeader.sh

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #####! /bin/awk -f
 
 

integrationTests/CMakeLists.txt

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 # MESSAGE( STATUS "CMAKE_CURRENT_SOURCE_DIR: " ${CMAKE_CURRENT_SOURCE_DIR} )
 # MESSAGE( STATUS "PROJECT_SOURCE_DIR: " ${PROJECT_SOURCE_DIR} )
 

integrationTests/test-eigerIntegration.cpp

@@ -1,6 +1,8 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include "DetectorImpl.h"
 #include "catch.hpp"
-#include "string_utils.h"
+#include "sls/string_utils.h"
 #include "tests/globals.h"
 #include <iostream>
 

integrationTests/test-integrationDectector.cpp

@@ -1,14 +1,16 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 #include "catch.hpp"
 
-#include "ClientSocket.h"
 #include "DetectorImpl.h"
 #include "Module.h"
-#include "logger.h"
-#include "sls_detector_defs.h"
+#include "sls/ClientSocket.h"
+#include "sls/logger.h"
+#include "sls/sls_detector_defs.h"
 
-#include "Timer.h"
-#include "sls_detector_funcs.h"
+#include "sls/Timer.h"
+#include "sls/sls_detector_funcs.h"
 #include <iostream>
 #include <vector>
 #define VERBOSE
@@ -446,8 +448,8 @@ TEST_CASE("Chiptestboard Dbit offset, list, sampling, advinvert",
     CHECK(m.readRegister(0x7b) == 0x1003E);
 }
 
-TEST_CASE("Eiger or Jungfrau startingfnum",
-          "[.eigerintegration][.jungfrauintegration][startingfnum]") {
+TEST_CASE("Eiger or Jungfrau nextframenumber",
+          "[.eigerintegration][.jungfrauintegration][nextframenumber]") {
     SingleDetectorConfig c;
 
     // pick up multi detector from shm id 0
@@ -465,8 +467,8 @@ TEST_CASE("Eiger or Jungfrau startingfnum",
     // starting fnum
     uint64_t val = 8;
 
-    m.setStartingFrameNumber(val);
-    CHECK(m.getStartingFrameNumber() == val);
+    m.setNextFrameNumber(val);
+    CHECK(m.getNextFrameNumber() == val);
     CHECK(m.acquire() == slsDetectorDefs::OK);
     CHECK(m.getReceiverCurrentFrameIndex() == val);
 
@@ -474,21 +476,21 @@ TEST_CASE("Eiger or Jungfrau startingfnum",
     CHECK(m.acquire() == slsDetectorDefs::OK);
     CHECK(m.getReceiverCurrentFrameIndex() == val);
 
-    CHECK_THROWS_AS(m.setStartingFrameNumber(0), sls::RuntimeError);
+    CHECK_THROWS_AS(m.setNextFrameNumber(0), sls::RuntimeError);
 
     if (m.getDetectorTypeAsString() == "Eiger") {
         val = 281474976710655;
     } else if (m.getDetectorTypeAsString() == "Jungfrau") {
         val = 18446744073709551615;
     }
-    m.setStartingFrameNumber(val);
-    CHECK(m.getStartingFrameNumber() == val);
+    m.setNextFrameNumber(val);
+    CHECK(m.getNextFrameNumber() == val);
     CHECK(m.acquire() == slsDetectorDefs::OK);
     CHECK(m.getReceiverCurrentFrameIndex() == val);
-    CHECK(m.getStartingFrameNumber() == (val + 1));
+    CHECK(m.getNextFrameNumber() == (val + 1));
 }
 
-TEST_CASE("Eiger readnlines", "[.eigerintegration][readnlines]") {
+TEST_CASE("Eiger partialread", "[.eigerintegration][partialread]") {
     SingleDetectorConfig c;
 
     // pick up multi detector from shm id 0
@@ -501,16 +503,16 @@ TEST_CASE("Eiger readnlines", "[.eigerintegration][readnlines]") {
 
     m.setDynamicRange(16);
     m.enableTenGigabitEthernet(0);
-    m.setReadNLines(256);
-    CHECK(m.getReadNLines() == 256);
-    m.setReadNLines(1);
-    CHECK(m.getReadNLines() == 1);
+    m.setPartialReadout(256);
+    CHECK(m.getPartialReadout() == 256);
+    m.setPartialReadout(1);
+    CHECK(m.getPartialReadout() == 1);
 
     m.setDynamicRange(8);
-    m.setReadNLines(256);
-    CHECK(m.getReadNLines() == 256);
-    CHECK_THROWS_AS(m.setReadNLines(1), sls::RuntimeError);
-    CHECK(m.getReadNLines() == 256);
-    CHECK_THROWS_AS(m.setReadNLines(0), sls::RuntimeError);
-    m.setReadNLines(256);
+    m.setPartialReadout(256);
+    CHECK(m.getPartialReadout() == 256);
+    CHECK_THROWS_AS(m.setPartialReadout(1), sls::RuntimeError);
+    CHECK(m.getPartialReadout() == 256);
+    CHECK_THROWS_AS(m.setPartialReadout(0), sls::RuntimeError);
+    m.setPartialReadout(256);
 }

integrationTests/test-integrationMulti.cpp

@@ -1,6 +1,8 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include "DetectorImpl.h"
 #include "catch.hpp"
-#include "string_utils.h"
+#include "sls/string_utils.h"
 #include "tests/globals.h"
 #include <iostream>
 

integrationTests/test.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 // tests-main.cpp
 #define CATCH_CONFIG_MAIN
 #include "catch.hpp"

libzmq-pkg-config/FindZeroMQ.cmake

@@ -0,0 +1,27 @@
+#From: https://github.com/zeromq/cppzmq/
+set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON)
+find_package(PkgConfig)
+pkg_check_modules(PC_LIBZMQ QUIET libzmq)
+
+set(ZeroMQ_VERSION ${PC_LIBZMQ_VERSION})
+find_library(ZeroMQ_LIBRARY NAMES libzmq.so libzmq.dylib libzmq.dll
+             PATHS ${PC_LIBZMQ_LIBDIR} ${PC_LIBZMQ_LIBRARY_DIRS})
+find_library(ZeroMQ_STATIC_LIBRARY NAMES libzmq-static.a libzmq.a libzmq.dll.a
+             PATHS ${PC_LIBZMQ_LIBDIR} ${PC_LIBZMQ_LIBRARY_DIRS})
+
+if(ZeroMQ_LIBRARY OR ZeroMQ_STATIC_LIBRARY)
+    set(ZeroMQ_FOUND ON)
+endif()
+
+if (TARGET libzmq)
+    # avoid errors defining targets twice
+    return()
+endif()
+
+add_library(libzmq SHARED IMPORTED)
+set_property(TARGET libzmq PROPERTY INTERFACE_INCLUDE_DIRECTORIES ${PC_LIBZMQ_INCLUDE_DIRS})
+set_property(TARGET libzmq PROPERTY IMPORTED_LOCATION ${ZeroMQ_LIBRARY})
+
+add_library(libzmq-static STATIC IMPORTED ${PC_LIBZMQ_INCLUDE_DIRS})
+set_property(TARGET libzmq-static PROPERTY INTERFACE_INCLUDE_DIRECTORIES ${PC_LIBZMQ_INCLUDE_DIRS})
+set_property(TARGET libzmq-static PROPERTY IMPORTED_LOCATION ${ZeroMQ_STATIC_LIBRARY})

manual/Makefile

@@ -1,51 +0,0 @@
-DESTDIR?=docs
-
-
-#manual-api manual-calwiz manual-client manual-gui manual-main
-
-
-
-MAINDIRS= manual-main manual-api  manual-calwiz manual-client manual-gui
-#manual-calwiz manual-calwiz manual-gui manual-client manual-api
-CLEANDIRS=$(MAINDIRS:manual-%=clean-%)
-PDFDIRS=$(MAINDIRS:manual-%=pdf-%)
-HTMLDIRS=$(MAINDIRS:manual-%=html-%)
-ALLDIRS=$(MAINDIRS:manual-%=all-%)
-
-
-all: $(ALLDIRS)
-#	$(shell test -d $(DESTDIR)/pdf && rm -fr $(DESTDIR)/pdf)
-#	mv pdf $(DESTDIR)
-#	$(shell test -d $(DESTDIR)/html && rm -fr $(DESTDIR)/html)
-#	mv html $(DESTDIR)
-	
-pdf: $(PDFDIRS)
-#	$(shell test -d $(DESTDIR)/pdf && rm -fr $(DESTDIR)/pdf)
-#	mv pdf $(DESTDIR)
-
-html: $(HTMLDIRS)
-#	$(shell test -d $(DESTDIR)/html && rm -fr $(DESTDIR)/html)
-#	mv html $(DESTDIR)
-
-clean: $(CLEANDIRS)
-	rm -fr $(DESTDIR)/pdf
-	rm -fr $(DESTDIR)/html	
-
-all-%:
-	echo 
-	cd  $(@:all-%=manual-%) && make all
-
-pdf-%:
-	cd  $(@:pdf-%=manual-%) && make pdf
-
-html-%:
-	cd  $(@:html-%=manual-%) && make html
-
-clean-%: 
-	cd  $(@:clean-%=manual-%) && make clean	
-
-
-#<23><>$(@D)<29><>    The directory part of the file name of the target, with the trailing slash removed. If the value of <20><>$@<40><> is dir/foo.o then <20><>$(@D)<29><> is dir. This value is . if <20><>$@<40><> does not contain a slash.
-#<23><>$(@F)<29><>    The file-within-directory part of the file name of the target. If the value of <20><>$@<40><> is dir/foo.o then <20><>$(@F)<29><> is foo.o. <20><>$(@F)<29><> is equivalent to <20><>$(notdir $@)<29><>.
-
-

manual/index.html

@@ -1,65 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-
-<!--Converted with LaTeX2HTML 2002-2-1 (1.71)
-original version by:  Nikos Drakos, CBLU, University of Leeds
-* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
-* with significant contributions from:
-  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
-<HTML>
-<HEAD>
-<TITLE>SLS Detector Software Documentation</TITLE>
-<META NAME="description" CONTENT="SLS Detector Software Documentation">
-<META NAME="keywords" CONTENT="SLS Detectors">
-<META NAME="resource-type" CONTENT="document">
-<META NAME="distribution" CONTENT="global">
-
-<LINK REL="next" HREF="node1.html">
-</HEAD>
-
-<BODY >
-<P>
-
-<H1 ALIGN="CENTER">SLS Detector Software Documentation</H1>
-<DIV>
-</DIV>
-<BR><HR>
-<!--Table of Child-Links-->
-<A NAME="CHILD_LINKS"></A>
-
-<UL> 
-
-<LI><A HREF="slsDetectors-FAQ/index.html">SLS Detectors Frequently Asked Questions</A>  <BR>
-Documents with general remarks about the detectors and the software that all users should read.
-<A HREF="../pdf/slsDetectors-FAQ.pdf">*pdf*</A>    <BR>
- <BR>
-<LI><A HREF="slsDetectorInstall/index.html">Installation</A> <BR>
-Documentation for the installation of the SLS Detectors software library
-<A HREF="../pdf/slsDetectorInstall.pdf">*pdf*</A> <BR>
- <BR>
-<LI><A HREF="slsDetectorClientHowTo/index.html">Command Line Interface</A>  <BR>
-Reference documentation for the command line interface sls_detector_put, sls_detector_get, sls_detector_acquire, sls_detector_help 
-<A HREF="../pdf/slsDetectorClientHowTo.pdf">*pdf*</A>  <BR>
- <BR>
-<LI><A HREF="slsDetectorGuiHowTo/index.html">Graphical Users Interface</A>  <BR>
-Reference documentation for the GUI
-<A HREF="../pdf/slsDetectorGuiHowTo.pdf">*pdf*</A>  <BR>
- <BR>
-<LI><A HREF="calibrationWizardsHowTo/index.html">Calibration Wizards</A> 
-<UL> 
-<LI> Energy calibration <A HREF="../pdf/energyCalibrationHowTo.pdf">*pdf*</A> 
-<LI> Angular calibration <A HREF="../pdf/angularCalibrationHowTo.pdf">*pdf*</A>     
-</UL>
- <BR>
-
-<LI><A HREF="slsDetectorUsersDocs/index.html">Application Program Interface</A>  <BR>
-Doxygen documentation for using the slsDetectorUsers class
-<A HREF="../pdf/slsDetectorUsersDocs.pdf">*pdf*</A>  <BR>
-   <BR>        
-</UL>
-
-<BR><HR>
-<ADDRESS>
-Anna Bergamaschi
-</ADDRESS>
-</BODY>
-</HTML>

manual/manual-api/CMakeLists.txt

@@ -1,32 +0,0 @@
-set(SOURCES
-    mainReceiver.cpp
-)
-
-include_directories(
-    ../../slsSupportLib/include
-    ../../slsReceiverSoftware/include
-    ../../build/bin 
-    ../../slsdetectorSoftware/slsDetector 
-)
-
-add_executable(slsMultiReceiver
-    ${SOURCES}
-)
-
-target_link_libraries(slsMultiReceiver
-    slsReceiverShared
-    pthread
-    ${ZeroMQ_LIBRARIES}
-    rt
-)
-
-if (HDF5_FOUND)
-    target_link_libraries(slsMultiReceiver ${HDF5_LIBRARIES})
-endif ()
-
-
-set_target_properties(slsMultiReceiver PROPERTIES
-    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
-)
-
-install(TARGETS slsMultiReceiver DESTINATION bin)

manual/manual-api/Makefile

@@ -1,62 +0,0 @@
-PKGDIR		=	../..
-LIBDIR		=   $(PKGDIR)/bin
-INCLUDES	=   -I . -I$(PKGDIR)/slsSupportLib/include -I$(LIBDIR) -I$(PKGDIR)/slsDetectorSoftware/slsDetector  -I$(PKGDIR)/slsReceiversoftware/include
-SRC_DET		= 	mainClient.cpp 	
-SRC_REC		=   mainReceiver.cpp
-ZMQLIBDIR	= 	$(PKGDIR)/slsSupportLib/include
-LDFLAG_DET 	=	-I. -L$(LIBDIR) -Wl,-rpath=$(LIBDIR) -lSlsDetector -L/usr/lib64/ -pthread -lrt -L$(ZMQLIBDIR) -Wl,-rpath=$(ZMQLIBDIR) -lzmq
-LDFLAG_REC 	=	-I. -L$(LIBDIR) -Wl,-rpath=$(LIBDIR) -lSlsReceiver -L/usr/lib64/ -pthread -lrt -L$(ZMQLIBDIR) -Wl,-rpath=$(ZMQLIBDIR) -lzmq
-DESTDIR		?=	../docs
-
-HDF5 		?=	no
-HDF5_DIR 	?=	/opt/hdf5v1.10.0
-
-ifeq ($(HDF5),yes)
-	LDFLAG_REC += -L$(HDF5_DIR)/lib  -Wl,-rpath=$(HDF5_DIR)/lib -lhdf5 -lhdf5_cpp -lsz -lz -DHDF5C 
-endif
-
-all: docs detUser slsMultiReceiver 
-#all: docs
-
-docs: createdocs docspdf docshtml removedocs
-
-createdocs: slsDetectorUsers.doxy mainClient.cpp mainReceiver.cpp
-	doxygen slsDetectorUsers.doxy	
-
-docspdf: 
-	cd slsDetectorUsersDocs/latex && make 
-	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
-	$(shell test -d $(DESTDIR)/pdf || mkdir -p $(DESTDIR)/pdf)
-	mv slsDetectorUsersDocs/latex/refman.pdf $(DESTDIR)/pdf/slsDetectorUsersDocs.pdf
-
-docshtml: 
-	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
-	$(shell test -d $(DESTDIR)/html || mkdir -p $(DESTDIR)/html)
-	$(shell test -d $(DESTDIR)/html/slsDetectorUsersDocs && rm -r $(DESTDIR)/html/slsDetectorUsersDocs)
-	mv slsDetectorUsersDocs/html $(DESTDIR)/html/slsDetectorUsersDocs
-	
-removedocs:
-	rm -rf 	slsDetectorUsersDocs;
-	
-detUser:$(SRC_DET)
-	echo "creating client"
-	mkdir -p bin
-	g++ -o bin/detUser $(SRC_DET) $(INCLUDES) $(LDFLAG_DET) -lm -lstdc++
-
-slsMultiReceiver:$(SRC_REC)
-	echo "creating receiver"
-	echo $LDFLAG_REC
-	mkdir -p bin
-	g++ -o bin/slsMultiReceiver $(SRC_REC) $(INCLUDES) $(LDFLAG_REC) -lm -lstdc++
-	cp bin/slsMultiReceiver $(LIBDIR)
-	
-clean:
-	echo "cleaning for manual-api"
-	rm -rf bin/detUser bin/slsMultiReceiver bin/detReceiver slsDetectorUsersDocs
-	rm -rf slsDetectorUsersDocs
-	rm -rf $(DESTDIR)/html/slsDetectorUsersDocs
-	rm -rf $(DESTDIR)/pdf/slsDetectorUsersDocs.pdf
-	rm -rf $(LIBDIR)/slsMultiReceiver
-	
-
-

manual/manual-api/mainClient.cpp

@@ -1,106 +0,0 @@
-/**
-\file mainClient.cpp
-
-This file is an example of how to implement the slsDetectorUsers class 
-You can compile it linking it to the slsDetector library
-
-g++ mainClient.cpp -L lib -lSlsDetector -L/usr/lib64/ -L lib2 -lzmq  -pthread -lrt -lm -lstdc++
-
-where,
-
-lib is the location of libSlsDetector.so
-
-lib2 is the location of the libzmq.a.
-[ libzmq.a is required only when using data call backs and enabling data streaming from receiver to client.
-It is linked in manual/manual-api from slsReceiverSoftware/include ]
-
- */
-
-#include "slsDetectorUsers.h"
-#include "detectorData.h"
-#include <iostream>
-#include <cstdlib>
-
-/**
- * Data Call back function defined
- * @param pData pointer to data structure received from the call back
- * @param iframe frame number of data passed
- * @param isubframe sub frame number of data passed ( only valid for EIGER in 32 bit mode)
- * @param pArg pointer to object
- * \returns integer that is currently ignored
- */
-int dataCallback(detectorData *pData, int iframe, int isubframe, void *pArg)
-{
-	std::cout  	<< " DataCallback:"
-				<< "\n nx           : " << pData->npoints
-				<< "\n ny           : " << pData->npy
-				<< "\n Frame number : " << iframe << std::endl;
-}
-
-
-/**
- * Example of a main program using the slsDetectorUsers class
- *
- * - Arguments are optional
- * 		- argv[1] : Configuration File
- * 		- argv[2] : Measurement Setup File
- * 		- argv[3] : Detector Id (default is zero)
- */
-int main(int argc,  char **argv) {
-	/** - if specified, set ID from argv[3] */
-	int id=0;
-	if (argc>=4)
-		id=atoi(argv[3]);
-
-
-	/** - slsDetectorUsers Object is instantiated with appropriate ID */
-	int ret = 1;
-	slsDetectorUsers *pDetector = new slsDetectorUsers (ret, id);
-	if (ret == 1) {
-		std::cout << "Error: Could not instantiate slsDetectorUsers" << std::endl;
-		return EXIT_FAILURE;
-	}
-
-
-	/** - if specified, load configuration file (necessary at least the first time it is called to properly configure advanced settings in the shared memory) */
-	if (argc>=2){
-		pDetector->readConfigurationFile(argv[1]);
-		std::cout << "Detector configured" << std::endl;
-	}
-
-	/** - set detector in shared memory online (in case no config file was used) */
-	pDetector->setOnline(1);
-
-	/** - set receiver in shared memory online (in case no config file was used) */
-	pDetector->setReceiverOnline(1);
-
-	/** - registering data callback */
-	pDetector->registerDataCallback(&dataCallback, NULL);
-
-
-	/** - ensuring detector status is idle before starting acquisition. exiting if not idle */
-	int status = pDetector->getDetectorStatus();
-	if (status  !=  0){
-		std::cout << "Detector not ready: " << slsDetectorUsers::runStatusType(status) << std::endl;
-		return 1;
-	}
-
-	/** - if provided, load detector settings */
-	if (argc>=3){
-		pDetector->retrieveDetectorSetup(argv[2]);
-		std::cout << "Detector measurement set-up done" << std::endl;
-	}
-
-
-	/** - start measurement */
-	pDetector->startMeasurement();
-	std::cout << "measurement finished" << std::endl;
-
-	/** - returning when acquisition is finished or data are avilable */
-
-	/** - delete slsDetectorUsers object */
-	delete pDetector;
-
-	return 0;
-}
-

manual/manual-api/mainReceiver.cpp

@@ -1,306 +0,0 @@
-/**
- \file mainReceiver.cpp
-
-This file is an example of how to implement the slsReceiverUsers class
-You can compile it linking it to the slsReceiver library
-
-g++ mainReceiver.cpp -L lib -lSlsReceiver -L/usr/lib64/ -L lib2 -lzmq  -pthread -lrt -lm -lstdc++
-
-where,
-
-lib is the location of lSlsReceiver.so
-
-lib2 is the location of the libzmq.a.
-[ libzmq.a is required only when using data call backs and enabling data streaming from receiver to client.
-It is linked in manual/manual-api from slsReceiverSoftware/include ]
-
- */
-
-#include "sls_detector_defs.h"
-#include "slsReceiverUsers.h"
-
-#include <csignal>	//SIGINT
-#include <cstdlib>		//system
-#include <cstring>
-#include <iostream>
-//#include "utilities.h"
-//#include "logger.h"
-#include <cerrno>
-#include <string>
-#include <sys/types.h>	//wait
-#include <sys/wait.h>	//wait
-#include <syscall.h>	//tid
-#include <unistd.h> 	//usleep
-using namespace std;
-
-
-/** Define Colors to print data call back in different colors for different recievers */
-#define PRINT_IN_COLOR(c,f, ...) 	printf ("\033[%dm" f RESET, 30 + c+1, ##__VA_ARGS__)
-
-
-/** Variable is true to continue running, set to false upon interrupt */
-bool keeprunning;
-
-/**
- * Control+C Interrupt Handler
- * Sets the variable keeprunning to false, to let all the processes know to exit properly
- */
-void sigInterruptHandler(int p){
-	keeprunning = false;
-}
-
-/**
- * prints usage of this example program
- */
-void printHelp() {
-	cprintf(RESET, "Usage:\n"
-			"./slsMultiReceiver(detReceiver) [start_tcp_port] [num_receivers] [1 for call back, 0 for none]\n\n");
-	exit(EXIT_FAILURE);
-}
-
-/**
- * Start Acquisition Call back
- * slsReceiver writes data if file write enabled.
- * Users get data to write using call back if registerCallBackRawDataReady is registered.
- * @param filepath file path
- * @param filename file name
- * @param fileindex file index
- * @param datasize data size in bytes
- * @param p pointer to object
- * \returns ignored
- */
-int StartAcq(char* filepath, char* filename, uint64_t fileindex, uint32_t datasize, void*p){
-	cprintf(BLUE, "#### StartAcq:  filepath:%s  filename:%s fileindex:%llu  datasize:%u ####\n",
-			filepath, filename, (long long unsigned int)fileindex, datasize);
-
-	cprintf(BLUE, "--StartAcq: returning 0\n");
-	return 0;
-}
-
-/**
- * Acquisition Finished Call back
- * @param frames Number of frames caught
- * @param p pointer to object
- */
-void AcquisitionFinished(uint64_t frames, void*p){
-	cprintf(BLUE, "#### AcquisitionFinished: frames:%llu ####\n",(long long unsigned int)frames);
-}
-
-
-/**
- * Get Receiver Data Call back
- * Prints in different colors(for each receiver process) the different headers for each image call back.
- * @param metadata sls_receiver_header metadata
- * @param datapointer pointer to data
- * @param datasize data size in bytes.
- * @param p pointer to object
- */
-void GetData(char* metadata, char* datapointer, uint32_t datasize, void* p){
-	slsDetectorDefs::sls_receiver_header* header = (slsDetectorDefs::sls_receiver_header*)metadata;
-	slsDetectorDefs::sls_detector_header detectorHeader = header->detHeader;
-
-	PRINT_IN_COLOR (detectorHeader.modId?detectorHeader.modId:detectorHeader.row,
-			"#### %d GetData: ####\n"
-			"frameNumber: %lu\t\texpLength: %u\t\tpacketNumber: %u\t\tbunchId: %lu"
-			"\t\ttimestamp: %lu\t\tmodId: %u\t\t"
-			"row: %u\t\tcolumn: %u\t\treserved: %u\t\tdebug: %u"
-			"\t\troundRNumber: %u\t\tdetType: %u\t\tversion: %u"
-			//"\t\tpacketsMask:%s"
-			"\t\tfirstbytedata: 0x%x\t\tdatsize: %u\n\n",
-			detectorHeader.row, (long unsigned int)detectorHeader.frameNumber,
-			detectorHeader.expLength, detectorHeader.packetNumber, (long unsigned int)detectorHeader.bunchId,
-			(long unsigned int)detectorHeader.timestamp, detectorHeader.modId,
-			detectorHeader.row, detectorHeader.column, detectorHeader.reserved,
-			detectorHeader.debug, detectorHeader.roundRNumber,
-			detectorHeader.detType, detectorHeader.version,
-			//header->packetsMask.to_string().c_str(),
-            ((uint8_t)(*((uint8_t*)(datapointer)))), datasize);
-}
-
-
-
-/**
- * Get Receiver Data Call back (modified)
- * Prints in different colors(for each receiver process) the different headers for each image call back.
- * @param metadata sls_receiver_header metadata
- * @param datapointer pointer to data
- * @param datasize data size in bytes.
- * @param revDatasize new data size in bytes after the callback.
- * This will be the size written/streamed. (only smaller value is allowed).
- * @param p pointer to object
- */
-void GetData(char* metadata, char* datapointer, uint32_t &revDatasize, void* p){
-	slsDetectorDefs::sls_receiver_header* header = (slsDetectorDefs::sls_receiver_header*)metadata;
-	slsDetectorDefs::sls_detector_header detectorHeader = header->detHeader;
-
-	PRINT_IN_COLOR (detectorHeader.modId?detectorHeader.modId:detectorHeader.row,
-			"#### %d GetData: ####\n"
-			"frameNumber: %llu\t\texpLength: %u\t\tpacketNumber: %u\t\tbunchId: %llu"
-			"\t\ttimestamp: %llu\t\tmodId: %u\t\t"
-			"row: %u\t\tcolumn: %u\t\treserved: %u\t\tdebug: %u"
-			"\t\troundRNumber: %u\t\tdetType: %u\t\tversion: %u"
-			//"\t\tpacketsMask:%s"
-			"\t\tfirstbytedata: 0x%x\t\tdatsize: %u\n\n",
-			detectorHeader.row, (long long unsigned int)detectorHeader.frameNumber,
-			detectorHeader.expLength, detectorHeader.packetNumber, (long long unsigned int)detectorHeader.bunchId,
-			(long long unsigned int)detectorHeader.timestamp, detectorHeader.modId,
-			detectorHeader.row, detectorHeader.column, detectorHeader.reserved,
-			detectorHeader.debug, detectorHeader.roundRNumber,
-			detectorHeader.detType, detectorHeader.version,
-			//header->packetsMask.to_string().c_str(),
-			((uint8_t)(*((uint8_t*)(datapointer)))), revDatasize);
-
-	// if data is modified, eg ROI and size is reduced
-	revDatasize = 26000;
-}
-
-
-
-
-/**
- * Example of main program using the slsReceiverUsers class
- *
- * - Defines in file for:
- *  	- Default Number of receivers is 1
- *  	- Default Start TCP port is 1954
- */
-int main(int argc, char *argv[]) {
-
-	/**	- set default values */
-	int numReceivers = 1;
-	int startTCPPort = 1954;
-	int withCallback = 0;
-	keeprunning = true;
-
-	/**	- get number of receivers and start tcp port from command line arguments */
-	if ( (argc != 4) || (!sscanf(argv[1],"%d", &startTCPPort)) || (!sscanf(argv[2],"%d", &numReceivers)) || (!sscanf(argv[3],"%d", &withCallback)) )
-		printHelp();
-	cprintf(BLUE,"Parent Process Created [ Tid: %ld ]\n", (long)syscall(SYS_gettid));
-	cprintf(RESET, "Number of Receivers: %d\n", numReceivers);
-	cprintf(RESET, "Start TCP Port: %d\n", startTCPPort);
-	cprintf(RESET, "Callback Enable: %d\n", withCallback);
-
-
-
-	/** - Catch signal SIGINT to close files and call destructors properly */
-	struct sigaction sa;
-	sa.sa_flags=0;							// no flags
-	sa.sa_handler=sigInterruptHandler;		// handler function
-	sigemptyset(&sa.sa_mask);				// dont block additional signals during invocation of handler
-	if (sigaction(SIGINT, &sa, nullptr) == -1) {
-		cprintf(RED, "Could not set handler function for SIGINT\n");
-	}
-
-	/** - Ignore SIG_PIPE, prevents global signal handler, handle locally,
-	   instead of a server crashing due to client crash when writing, it just gives error */
-	struct sigaction asa;
-	asa.sa_flags=0;							// no flags
-	asa.sa_handler=SIG_IGN;					// handler function
-	sigemptyset(&asa.sa_mask);				// dont block additional signals during invocation of handler
-	if (sigaction(SIGPIPE, &asa, nullptr) == -1) {
-		cprintf(RED, "Could not set handler function for SIGPIPE\n");
-	}
-
-
-	/** - loop over number of receivers */
-	for (int i = 0; i < numReceivers; ++i) {
-
-		/**	- fork process to create child process */
-		pid_t pid = fork();
-
-		/**	- if fork failed, raise SIGINT and properly destroy all child processes */
-		if (pid < 0) {
-			cprintf(RED,"fork() failed. Killing all the receiver objects\n");
-			raise(SIGINT);
-		}
-
-			/**	- if child process */
-		else if (pid == 0) {
-			cprintf(BLUE,"Child process %d [ Tid: %ld ]\n", i, (long)syscall(SYS_gettid));
-
-			char temp[10];
-			sprintf(temp,"%d",startTCPPort + i);
-			char* args[] = {(char*)"ignored", (char*)"--rx_tcpport", temp};
-			int ret = slsDetectorDefs::OK;
-			/**	-  create slsReceiverUsers object with appropriate arguments */
-			slsReceiverUsers *receiver = new slsReceiverUsers(3, args, ret);
-			if(ret==slsDetectorDefs::FAIL){
-				delete receiver;
-				exit(EXIT_FAILURE);
-			}
-
-
-			/**	- register callbacks. remember to set file write enable to 0 (using the client)
-		  if we should not write files and you will write data using the callbacks */
-			if (withCallback) {
-
-				/** - Call back for start acquisition */
-				cprintf(BLUE, "Registering 	StartAcq()\n");
-				receiver->registerCallBackStartAcquisition(StartAcq, nullptr);
-
-				/** - Call back for acquisition finished */
-				cprintf(BLUE, "Registering 	AcquisitionFinished()\n");
-				receiver->registerCallBackAcquisitionFinished(AcquisitionFinished, nullptr);
-
-				/* 	- Call back for raw data */
-				cprintf(BLUE, "Registering     GetData() \n");
-				if (withCallback == 1) receiver->registerCallBackRawDataReady(GetData,nullptr);
-				else if (withCallback == 2) receiver->registerCallBackRawDataModifyReady(GetData,nullptr);
-			}
-
-
-
-			/**	- start tcp server thread */
-			if (receiver->start() == slsDetectorDefs::FAIL){
-				delete receiver;
-				cprintf(BLUE,"Exiting Child Process [ Tid: %ld ]\n", (long)syscall(SYS_gettid));
-				exit(EXIT_FAILURE);
-			}
-
-			/**	- as long as keeprunning is true (changes with Ctrl+C) */
-			while(keeprunning)
-				pause();
-			/**	- interrupt caught, delete slsReceiverUsers object and exit */
-			delete receiver;
-			cprintf(BLUE,"Exiting Child Process [ Tid: %ld ]\n", (long)syscall(SYS_gettid));
-			exit(EXIT_SUCCESS);
-			break;
-		}
-	}
-
-	/** - Parent process ignores SIGINT (exits only when all child process exits) */
-	sa.sa_flags=0;							// no flags
-	sa.sa_handler=SIG_IGN;					// handler function
-	sigemptyset(&sa.sa_mask);				// dont block additional signals during invocation of handler
-	if (sigaction(SIGINT, &sa, nullptr) == -1) {
-		cprintf(RED, "Could not set handler function for SIGINT\n");
-	}
-
-
-	/** - Print Ready and Instructions how to exit */
-	cout << "Ready ... " << endl;
-	cprintf(RESET, "\n[ Press \'Ctrl+c\' to exit ]\n");
-
-	/** - Parent process waits for all child processes to exit */
-	for(;;) {
-		pid_t childPid = waitpid (-1, nullptr, 0);
-
-		// no child closed
-		if (childPid == -1) {
-			if (errno == ECHILD) {
-				cprintf(GREEN,"All Child Processes have been closed\n");
-				break;
-			} else {
-				cprintf(RED, "Unexpected error from waitpid(): (%s)\n",strerror(errno));
-				break;
-			}
-		}
-
-		//child closed
-		cprintf(BLUE,"Exiting Child Process [ Tid: %ld ]\n", (long int) childPid);
-	}
-
-	cout << "Goodbye!" << endl;
-	return 0;
-}
-

manual/manual-api/slsDetectorUsers.doxy

@@ -1,91 +0,0 @@
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
-# documentation are documented, even if no documentation was available. 
-# Private class members and static file members will be hidden unless 
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-
-EXTRACT_ALL            = YES
-
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
-# will be included in the documentation.
-
-EXTRACT_PRIVATE        = NO
-
-
-
-# If the EXTRACT_STATIC tag is set to YES all static members of a file 
-# will be included in the documentation.
-
-EXTRACT_STATIC         = YES
-
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
-# defined locally in source files will be included in the documentation.
-# If set to NO only classes defined in header files are included.
-
-EXTRACT_LOCAL_CLASSES  = YES
-
-# This flag is only useful for Objective-C code. When set to YES local
-# methods, which are defined in the implementation section but not in
-# the interface are included in the documentation.
-# If set to NO (the default) only methods in the interface are included.
-
-EXTRACT_LOCAL_METHODS  = YES
-
-# If this flag is set to YES, the members of anonymous namespaces will be
-# extracted and appear in the documentation as a namespace called
-# 'anonymous_namespace{file}', where file will be replaced with the base
-# name of the file that contains the anonymous namespace. By default
-# anonymous namespace are hidden.
-
-EXTRACT_ANON_NSPACES   = NO
-
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
-# undocumented members of documented classes, files or namespaces.
-# If set to NO (the default) these members will be included in the
-# various overviews, but no documentation section is generated.
-# This option has no effect if EXTRACT_ALL is enabled.
-
-HIDE_UNDOC_MEMBERS     = NO
-
-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy.
-# If set to NO (the default) these classes will be included in the various
-# overviews. This option has no effect if EXTRACT_ALL is enabled.
-
-HIDE_UNDOC_CLASSES     = NO
-
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
-# friend (class|struct|union) declarations.
-# If set to NO (the default) these declarations will be included in the
-# documentation.
-
-HIDE_FRIEND_COMPOUNDS  = NO
-
-INTERNAL_DOCS = NO
-
-SHOW_INCLUDE_FILES = YES
-
-SHOW_FILES = YES
-
-SHOW_NAMESPACES = NO
-
-COMPACT_LATEX = YES
-
-PAPER_TYPE = a4
-
-PDF_HYPERLINKS = YES
-
-USE_PDFLATEX = YES
-
-LATEX_HIDE_INDICES = YES
-
-SOURCE_BROWSER	= YES
-
-PREDEFINED           = __cplusplus
- 
-INPUT            = 		../../slsDetectorSoftware/slsDetector/slsDetectorUsers.h		\
-					 	../../slDetectorSoftware/slsDetectorAnalysis/detectorData.h 	\
-					 	../../slsReceiverSoftware/include/slsReceiverUsers.h 			\
-					 	mainClient.cpp 													\
-					 	mainReceiver.cpp
-
-OUTPUT_DIRECTORY = slsDetectorUsersDocs

manual/manual-calwiz/Makefile

@@ -1,56 +0,0 @@
-DESTDIR?=../docs
-
-
-#manual-api manual-calwiz manual-client manual-gui manual-main
-
-TEX=latex
-
-MAINTEXS= angularCalibrationHowTo.tex energyCalibrationHowTo.tex 
-
-TEXS=ancCal.tex enCal.tex installation.tex 
-
-DVIS = $(MAINTEXS:.tex=.dvi)
-PSS = $(MAINTEXS:.tex=.ps)
-PDFS = $(MAINTEXS:.tex=.pdf)
-HTMLS = $(MAINTEXS:%.tex=%)
-
-
-all: pdf html
-	echo $(PWD)
-	echo $(PDFS)
-	echo $(HTMLS)
-
-
-pdf: $(PDFS)
-	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
-	$(shell test -d $(DESTDIR)/pdf || mkdir -p $(DESTDIR)/pdf)
-	mv $(PDFS) $(DESTDIR)/pdf	
-
-html: $(HTMLS)
-
-$(HTMLS): $(TEXS) $(MAINTEXS)
-	$(shell test -d $(DESTDIR) || mkdir -p $(DESTDIR))
-	$(shell test -d $(DESTDIR)/html || mkdir -p $(DESTDIR)/html)                     
-	$(shell test -d $(DESTDIR)/html/$@ && rm -r $(DESTDIR)/html/$@)
-	latex $@.tex
-	latex2html -split 4 $@.tex
-	mv $@ $(DESTDIR)/html
-
-%.dvi : %.tex $(TEXS)
-	latex $<
-	latex $<
-
-%.ps : %.dvi
-	dvips -o $@  $< 
-
-
-%.pdf : %.ps
-	ps2pdf  $<  $@
-
-
-clean:
-	rm -rf *.aux *.log *.toc *.out $(DVIS) $(PSS) $(PDFS) $(HTMLS)
-	rm -rf $(DESTDIR)/html/angularCalibrationHowTo
-	rm -rf $(DESTDIR)/html/energyCalibrationHowTo
-	rm -rf $(DESTDIR)/pdf/angularCalibrationHowTo.pdf
-	rm -rf $(DESTDIR)/pdf/energyCalibrationHowTo.pdf

manual/manual-calwiz/ancCal.tex

@@ -1,171 +0,0 @@
-
-In order to convert from strip number to 2$\theta$-angle, an accurate angular calibration of the detector must be performed (for details see the paper Bergamaschi, A. et al. (2010). J. Synchrotron Rad. 17, 653-668). \\
-
-For this purpose, a series of patterns of a powder standard with symmetric peaks (e.g. silicon) must acquired while shifting the detector by an angular step of the order of about 2\% of the module size. During the measurement, a strong intensity peak (e.g. Si(111)) should pass through the field of view of every module such that it can be used as a reference angular position to perform the calibration of the modules position.\\
-
-In a first step, the   peak is fitted with a Gaussian in order to determine its position $C_{peak}$ in channel number for each of the acquired patterns.\\
-In a second step, for each module $i$, the encoder position  $\Theta_e$  is fitted as a function of the peak position  $C_{peak}$  according to:
-\begin{equation}\label{eq:angcal}
-\Theta_e=\Theta_o^i-\arctan\Big(\frac{p \cdot (C_{peak}-C_{center}^i)}{R^i}\Big),
-\end{equation} 
-where the parameters $\Theta_o^i$ is the angular offset with respect to the diffractometer zero position, $C_{center}^{i}$ is the central channel  and $R^i$ is the distance of the module $i$ from the diffractometer center while $p=50~\mu m$ is the strip pitch of the detector. \\
-Finally, the global offset of the detector system is precisely determined by refining a silicon pattern at a well-defined energy (i.e., knowing the position of the peak).
-
-The same function of equation~\ref{eq:angcal}, with the parameters obtained from the calibration, is used in order to convert from channel number to 2$\theta$-angle.
-
-The parallax at the borders of the modules due to the thickness of the silicon sensor is a function of the X-ray energy (higher energy X-rays are absorbed deeper inside the sensor) and is of the order of 0.2~mdeg at 12~keV and 0.5~mdeg at 30~keV. \\
-The differences in pixel size due to the different portion of solid angle covered by the strips on the border of the modules and  the higher efficiency due to the longer path of the X-rays in the sensor are removed by the flat field correction. This also normalizes additional differences in pixel size between channels which are also present because of mismatches in the strip sensor fabrication and in fluctuations of the channels threshold level.
- 
-Patterns acquired at different detector positions are generally merged together  in order to fill the gaps between the modules and correct possibly bad functioning channels. In this procedure the data from different positions which are closer than 4~mdeg (the average pixel size) are averaged and the new position is set to the mean of the positions of the original points.
-
-
-The position and width of the peaks results from a fit over several detector channels. Geometrical distortions might disturb this determination mainly because of errors in the angular calibration, fluctuations in the encoder position, variations between channels and parallax effects.\\
-The resolution in locating the peak center and determining its width and integrated intensity has been estimated by acquiring several patterns of a LaB$_6$ sample in a 300~$\mu$m capillary with the detector shifted in 5~mdeg steps between 30.4 and 36.5 degrees. The 16~peaks acquired have been fitted with a Gaussian function plus background and the fluctuations on the fitted parameters have been calculated. The resulting average resolutions are  0.63$\pm$0.06~mdeg for the peak center and 0.22$\pm$0.05~mdeg for the peak Full-Width at Half-Maximum (FWHM) for an average peak FWHM of 27.0$\pm$2.5~mdeg. \\
-These results show that  the angular calibration allows a resolution in determining the peaks position and width which is appropriate for structural determination.
-
-\section{Data acquisition}
-
-The angular calibration consists in acquiring a set of diffraction patterns of a well known powder standard (e.g. Silicon) at different encoder positions.  In order to facilitate the procedure, the sample should not emit fluorescent light and should present relatively symmetric peaks. \\
-During the measurement, a strong intensity peak (e.g. Si(111)) should pass through the field of view of every module such that it can be used as a reference angular position to perform the calibration of the modules position. In general the highest peak will be used for the calibration, but this is not necessary in case there would be e.g. geometrical limitations for shifting the detector. \\ \textbf{Do not forget to properly position the beam stopper if the detector is scanned in front of the direct beam.}\\
-The detector should be shifted of an angular step of the order of about 2\% of the module size, such that about 50 patterns can contribute to the fitting of the 3 parameters necessary for the angular calibration.\\
- 
-All the angular calibration procedure should be acquired using a trimmed detector with the threshold set at half of the X-ray energy (Assuming no fluorescent element in the standard). A flat field should also be acquired in order to precisely correct the data, while the X-ray intensity should be kept lower than about 100~kHz per strip in order to avoid the need for rate corrections.
-
-A rough angular conversion file starting from a previous calibration or from the geometric characteristics of the mechanics is an advantage. The angular conversion file should contain a line for each module of the detector with its module number $i$, center  $C_{center}^{i}$ and error, conversion radius $p/R^i$ and error, offset $\Theta_o^i$ and error:
-\begin{verbatim}
-module 0 center 639.5 +- 0 conversion 6.56E-05 +- 0 offset 0 +- 0
-\end{verbatim}
-Also the \textit{global offset} value of the beamline should be approximately known i.e. the angular position of channel 0 of module 0 when the motor is set at 0. \\
-All the documentation assumes that the detector is oriented in the same direction as the encoder position i.e. large channel number at higher angles (both per module and absolute). If this is not the case, the \textit{angular direction} should be set to -1. 
-
-\subsection{Software}
-
-For the acquisition ot the data you need to install the slsDetector software package (please refere to separate documentation). The use of the GUI is optional and all operations can be performed also using the text client.\\
-
-Please make sure that you have edited the \\
-\textit{slsDetectorSoftware/usersFunctions/angleFunction.h} \\
-in order to match the angular conversion for your geometry and \\
-\textit{slsDetectorSoftware/usersFunctions/usersFunctions.cpp} \\
-in order to be able to move the detector and read out its position by using the slsDetector software.
-
-In the following the command to acquire a dataset for the angular calibration with an exposure time of 1~s, and position shift 
-\begin{verbatim}
-#setup angular calibration log mode
-> sls_detector_put angcallog 1 
-#set exposure time to 1s
-> sls_detector_put exptime 1. 
-#setup threshold scan
-> sls_detector_put scan0script position 
-#setup the precision for the scan variable in the file name
-> sls_detector_put scan0prec 2 
-#set scan range between 20deg and -60deg, step of -0.1deg
-# (at 12.4 keV the Si(111) peak is at approx 19deg
-> sls_detector_put scan0range 20 -60 -0.1 
-#acquire the data
-> sls_detector_acquire
-#unset angular calibration log mode
-> sls_detector_put angcallog 0
-\end{verbatim}
-
-With the GUI you can obtain the same results by clicking on the \textit{Angular calibration} log button in the advanced tab (see figure~\ref{fig:guiangcallog}) and setting up the motor position scan in the Actions tab (see figure~\ref{fig:guiposscan}). The exposure time should also be set in the measurement tab.
-
-
-
-Additional to the data files, the acquisition will produce a .angcal file containing an header and, for each step of the acquisition, the exect value of the motor position and the file name. \\
-In case you forgot to enable the angcallog flag in the software, you can produce the file with the syntax as follows, assuming that you know the exact values of your encoder for each frame:
-\begin{verbatim}
-type Mythen
-maxmod 32
-nmod 32
-angconv /scratch/angcal20120422/ang.off
-globaloff 5.088
-fineoff 0.0
-angdir 1
-ffdir /scratch/angcal20120422/
-flatfield flatfield_E12keV_T6keV_0.raw
-badchannels /scratch/cal/bad.chans
-19.99998 angcal_S20.00_0
-19.90001 angcal_S19.90_0
-19.79999 angcal_S19.80_0
-19.70002 angcal_S19.70_0
-......
-\end{verbatim}
-
-
-
-\begin{figure}
-\caption{Acquisition GUI window to enable the angular calibration log.} \label{fig:guiangcallog}
-\includegraphics[width=\textwidth]{enable_angcal.eps}
-\end{figure} 
-
-\begin{figure}
-\caption{Acquisition GUI window to setup the motor position scan.} \label{fig:guiposscan}
-\includegraphics[width=\textwidth]{position_scan.eps}
-\end{figure} 
-\newpage
-
-\section{Data analysis}
-
-The data analysis consists in fitting with a gaussian the selected peak of the powder pattern for each position in order to determine its position is channel number as a function of the encoder position. \\
-In a second step, for each module, the channel vs. encoder curve is fitted in order to extrapolate the three parameters necessary for the angular conversion and the result is written to file
-
-\subsection{Software}
-
-The software used for the angular calibration data analysis is based on root (see http://root.cern.ch).\\
-This can be downloaded as binary or installed from sources. The version of the software should not play an important role, but up to now everything has been implemented and tested using version 5.20.
-
-To start the data analysis simply launch:
-\begin{verbatim}
-> ./angularCalibrationWizard 
-\end{verbatim}
-
-\begin{figure}
-\caption{Overview of the nagular calibration dataset.} \label{fig:setangcal}
-\includegraphics[width=\textwidth]{setupAngcal.eps}
-\end{figure} 
-
-To setup the angular calibration dataset, the .angcal file should be selected (or digited) and the load button should be pressed to confirm. The parameters of the angular calibration are then read to the file and the data loaded for a quick overview (see figure~\ref{fig:setangcal}).\\
-The software assumes that the data files (.raw) and the .encal file are in the same directory.\\
-A 2D color plot will show a rebinned overview of the dataset. The peak to be fitted should be visible as a high intensity diagonal line passing through all the channels.
-
-
-\begin{figure}
-\caption{Preview of the fitting of the Si(111) peak for one of the detector positions.} \label{fig:peakfit}
-\includegraphics[width=\textwidth]{peakFit.eps}
-\end{figure} 
-
-For a more detailed view of the data, one can select an angular calibration step from the combo box, select the plot mode (raw data or processed data as a function of channel number, processed angular converted data, flat field data, or again an overview of the whole dataset). \\
-By (right) clicking close to the axis you are able to zoom in/out, set the scale to logarithmic etc.\\
-
-If the bad channel list, angular conversion file or flat field file are changed compared to the acquisition, they can be reloaded by editing the correspondent text entries and pressing enter.
-
-In particular, the angular converted data should be checked in order to view the position of the selected peak. In this case, the plot will be zoomed to the angular region slected in the minimum and maximum angle entries. By pressing fit, the fit of the peak in the selected angular range will be shown (see figure~\ref{fig:peakfit}).  It is useful to check that it works properly in several positions such that then the sequential fitting on all steps can give good results.
-
-To automatically fit all positions simply press \textit{Proceed to Modules Calibration} and wait until all steps are fitted. This can take sometime, depending on the number of steps.
-
-
-\begin{figure}
-\caption{Window for fitting the angular calibration parameters of a module.} \label{fig:anglefit}
-\includegraphics[width=\textwidth]{angleFit.eps}
-\end{figure} 
-
-
-
-
-
-In the module calibration window (see figure~\ref{fig:anglefit}), you will be able to fit the channel number to encoder position curve to estimate the three angular calibration parameters for each module.\\
-The entries show the angular calibration parameters used for approximate angular conversion in the previous step of the calibration. These can be edited and will be used as start parameters for the fit.
-By clicking on the check box next to the parameters, the selected parameter will be set and fixed during the fit. Often the center is used as a fix parameter.\\
-It is possible to navigate between modules by using the Previous and Next module buttons. To refit the current module (e.g. after changing one of the parameters) simply re-click on the module number.
-
-After fitting all modules you can click on the \textit{Write Angular Calibration} button, select the file name to write to and save the calibration angulat calibration data. Please note that the offset of module 0 will always be 0 and the other values will be rescaled to its value. Therefore the global offset of the steup will always need to be specified for a proper angular conversion unless the home of the encoder will not be redifined.
-
-\section{Setup calibration files}
-
-To use the generated angular calibration files, using the text client:
-\begin{verbatim}
-sls_detector_put angconv /scratch/ang_new.off 
-\end{verbatim}
-while for the GUI the file name should be specified in the configuration file (works also for the text client).
-\end{document}
-

manual/manual-calwiz/angularCalibrationHowTo.tex

@@ -1,17 +0,0 @@
-\documentclass{article}
-\usepackage{amssymb}
-\usepackage[dvips]{graphicx}
-\usepackage{verbatim}
-\begin{document}
-
-\title{Angular calibration wizard manual}
-\author{Anna Bergamaschi}
-\date{\today}
-\maketitle
-
-
-\section{Introduction}
-\input{ancCal.tex}
-
-\end{document}
-

manual/manual-calwiz/calibrationWizardsHowTo.tex

@@ -1,24 +0,0 @@
-\documentclass{report}
-\usepackage{amssymb}
-\usepackage[dvips]{graphicx}
-\usepackage{verbatim}
-\begin{document}
-
-\title{Calibration wizards manual}
-\author{Anna Bergamaschi}
-\date{\today}
-\maketitle
-\chapter{Installation}
-\input{installation.tex}
-
-\chapter{Energy calibration}
-%\section{Introduction}
-\input{enCal.tex}
-
-
-\chapter{Angular calibration}
-%\section{Introduction}
-\input{ancCal.tex}
-
-\end{document}
-