removed Makefile for moench and integrated the build in CMake

Patsetbit and vref

.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

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)
 
@@ -33,8 +38,11 @@ if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
 endif()
 
 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)
@@ -48,7 +56,19 @@ 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)
+#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/" 
@@ -59,9 +79,7 @@ set(ClangFormat_EXCLUDE_PATTERNS    "build/"
                                     ${CMAKE_BINARY_DIR})
 find_package(ClangFormat)
 
-#Enable LTO if available
-check_ipo_supported(RESULT SLS_LTO_AVAILABLE)
-message(STATUS "SLS_LTO_AVAILABLE:" ${SLS_LTO_AVAILABLE})
+
 
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
@@ -72,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)
@@ -79,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
@@ -90,7 +118,20 @@ 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
                                 )
 
 
@@ -99,30 +140,22 @@ 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)
@@ -157,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()
     
+  # 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()
@@ -166,14 +229,12 @@ 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)
     add_subdirectory(slsReceiverSoftware) 
@@ -213,16 +274,12 @@ if(SLS_BUILD_DOCS)
     add_subdirectory(docs)
 endif(SLS_BUILD_DOCS)
 
-
 if(SLS_USE_MOENCH)
     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 on the latest release of 5.0.0 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).
+##### 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. 
@@ -45,7 +49,7 @@ These are mainly aimed at those not familiar with using ccmake and cmake.
 ```
     The binaries are generated in slsDetectorPackage/build/bin directory.
 
-    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>]
+    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
@@ -66,6 +70,7 @@ These are mainly aimed at those not familiar with using ccmake and cmake.
     -n: Manuals without compiling doxygen (only rst)
     -z: Moench zmq processor
 
+    
     # get all options
     ./cmk.sh -?
 
@@ -90,3 +95,8 @@ To install binaries using CMake
     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,83 +1,116 @@
-SLS Detector Package 5.1.0 released on xx.xx.2020 (Minor Release)
-===================================================================
+SLS Detector Package Minor Release 6.1.0 released on 25.11.2021
+===============================================================
 
-This document describes the differences between 5.1.0 and 5.x.x releases.   
+This document describes the differences between v6.1.0 and v6.0.0.   
 
 
 
     CONTENTS
     --------
-    1.  Topics Concerning
-    2.  New Features
+    1.  New or Changed Features
     2.  Resolved Issues
-    3.  Known Issues
-    4.  Firmware Requirements
+    3.  Firmware Requirements
+    4.  Kernel Requirements
     5.  Download, Documentation & Support
 
 
 
-1. Topics Concerning
-====================
 
-    - potentital memory leak in receiver
-    - scanParameters in Python
-    - cmk.sh refactored
-    - m3 settings and threshold
+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
+- fixed patsetbit and patsetmask for moench
+- changed default vref of adc9257 to 2V for moench (from 1.33V)
 
 
-2. New Features
-===============
 
-    Client
-    ------
-
-    1. Aded settings and threshold features for Mythen3.
-    2. Internal modification of acquire for Mythen3.
-    3. Added getMaster functio for M3
-
-
-    Mythen3 server
-    -----------------
-
-    1. Setting timing to auto, sets timing to trigger for slaves
-    
-
-3. Resolved Issues
+2. Resolved Issues
 ==================
 
 
-    Receiver
-    --------
-
-    1.  Current code only calls Implementation::setDetectorType from constructor, 
-	    but potential memory leak if called out of constructor context. Fixed.
-
-    Client
-    ------
-
-    1.  Fixed missing scanParameters class in Python 
-
-    2.  cmk.sh refactored to have better option handling
-
-
-
-
-
-4. Firmware Requirements
+3. Firmware Requirements
 ========================
         
-    No updates from 5.0.0
+    Eiger
+    =====  
+    Compatible version : 08.10.2021 (v29)
+    
+    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) 
+
+    Mythen3
+    =======
+    Compatible version : 10.09.2021 (v1.1)
+
+    Gotthard2
+    =========
+    Compatible version : 27.05.2021 (v0.1)
+
+    Moench
+    ======
+    Compatible version : 05.10.2020 (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
 
 
 
-5. Known Issues
-===============
+4. Kernel Requirements
+======================
 
-    No updates from 5.0.0
+    Blackfin 
+    ========
+    Latest version: Fri Oct 29 00:00:00 2021
+    
+    Older ones will work, but might have issues with programming firmware via
+    the package.
+
+    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
 
 
 
-6. Download, Documentation & Support
+5. Download, Documentation & Support
 ====================================
 
     Download

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,4 +1,6 @@
 #!/bin/bash
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 CMAKE="cmake3"
 BUILDDIR="build"
 INSTALLDIR=""

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

@@ -3,6 +3,7 @@ python:
     - 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,6 +1,8 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
-mkdir $PREFIX/lib
-mkdir $PREFIX/bin
+mkdir -p $PREFIX/lib
+mkdir -p $PREFIX/bin
 mkdir -p $PREFIX/include/sls
 # mkdir $PREFIX/include/slsDetectorPackage
 

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/moench04ZmqProcess $PREFIX/bin/.
+cp build/install/bin/moenchZmqProcess $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)
@@ -59,7 +61,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 +86,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
 
 

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>

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>

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,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #pragma once
 
 #include <string>

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>
 

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>

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>

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>
 
 

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>

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>

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

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)
 

docs/src/dependencies.rst

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

docs/src/firmware.rst

@@ -1,8 +1,6 @@
 Firmware Upgrade
 =================
 
-
-
 Eiger
 -------------
 
@@ -18,30 +16,9 @@ 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.
     
@@ -50,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
@@ -79,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
 -------------
 
@@ -94,73 +89,26 @@ Download
 - `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
-Upgrade (from v4.x.x)
-^^^^^^^^^^^^^^^^^^^^^^
+Upgrade
+^^^^^^^^
+
+.. note :: 
+
+    These instructions are for upgrades from v5.0.0. For earlier versions, contact us.
+
 
 Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
 
-#. Tftp must be installed on pc.
+Always ensure that the client and server software are of the same release.
 
-#. Update client package to the latest (5.x.x).
 
-#. Disable server respawning or kill old server
+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)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
-
-
-#. 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
@@ -168,8 +116,8 @@ Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you
 
 
 
-Gotthard
----------
+Gotthard I
+-----------
 
 Download 
 ^^^^^^^^^^^^^
@@ -184,7 +132,7 @@ 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>`__.
    
@@ -195,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.
 
@@ -204,64 +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 (in developement)
+- `rbf files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
-Upgrade (from v5.0.0)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+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 (in development)
+- `rbf files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
+Upgrade
+^^^^^^^^
 
-Upgrade (from v5.0.0)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+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
 -------
@@ -273,17 +226,21 @@ Download
 - `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
-Upgrade (from v5.0.0)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Upgrade
+^^^^^^^^
 
 Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
 
-#. 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,
-        # 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
@@ -299,17 +256,21 @@ Download
 - `pof files <https://github.com/slsdetectorgroup/slsDetectorFirmware>`__
 
 
-Upgrade (from v5.0.0)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Upgrade
+^^^^^^^^
 
 Check :ref:`firmware troubleshooting <blackfin firmware troubleshooting>` if you run into issues while programming firmware.
 
-#. 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,
-        # 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
@@ -344,25 +305,52 @@ Firmware Troubleshooting with blackfin
 
 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
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-This might take a few reruns (maybe even 10) until the mtd drive is accessed by the blackfin upon linux startup.
+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
 
-    # step 1: connect to the board
+            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 2: check if mtd3 drive listed
-    more /proc/mtd
+            #step 3: go to directory for space
+            cd /var/tmp/
 
-    # step 3: tell fpga not to touch flash and reboot
-    echo 9 > /sys/class/gpio/export; 
-    echo out > /sys/class/gpio/gpio9/direction; 
-    echo 0 > /sys/class/gpio/gpio9/value;
+            # 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 4: repeat steps 1 - 3 until you see the mtd3 drive
+            # step 9: verification
+            telnet bchipxxx
+            uname -a # verify kernel date
+            more /proc/mtd # verify mtd3 is listed
             
 
 Last Resort using USB Blaster

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

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/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:
 
-Gotthard
----------
-
-**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 gotthardDetectorServerxxx pcxxx
+        sls_detector_put execcommand "tftp pcxxx -r configxxx -g"
 
 
+.. note :: 
 
-Mythen3
--------
+    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.
 
-**Location:** slsDetectorPackage/serverBin/ folder for every release.
+ .. note :: 
 
-#. 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
+    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.
 
 
-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/troubleshooting.rst

@@ -247,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
 ----------

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/moench03_T1.config

@@ -1,7 +1,8 @@
-initialchecks 0
+#initialchecks 0
 #############################################
 ### edit with hostname or IP address of your detector 
 ############################################
+#hostname bchip181+
 hostname bchip181+
 
 #############################################
@@ -27,7 +28,7 @@ rx_zmqport 50003
 #############################################
 ### edit with 1 Gbs IP of PC where you will run the GUI
 ############################################
-zmqip 129.129.202.136
+zmqip 129.129.202.98
 zmqport 50001
 
 
@@ -39,11 +40,12 @@ rx_zmqstream 1
 
 frames 100000
 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
 

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,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include "DetectorImpl.h"
 #include "catch.hpp"
 #include "sls/string_utils.h"

integrationTests/test-integrationDectector.cpp

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 
 #include "catch.hpp"
 
@@ -488,7 +490,7 @@ TEST_CASE("Eiger or Jungfrau nextframenumber",
     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,3 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
 #include "DetectorImpl.h"
 #include "catch.hpp"
 #include "sls/string_utils.h"

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})

python/CMakeLists.txt

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 pybind11_add_module(_slsdet 
     src/main.cpp 
@@ -6,6 +8,7 @@ pybind11_add_module(_slsdet
     src/network.cpp
     src/pattern.cpp
     src/scan.cpp
+    src/current.cpp
 )
 
 target_link_libraries(_slsdet PUBLIC 

python/README.md

@@ -1,63 +0,0 @@
-# sls_detector: Python interface to slsDetectorPackage
-Python interface to the Sls Detector Software. 
-
-### Documentation ###
-Sphinx built documentation is available here:
-[https://slsdetectorgroup.github.io/sls_detector/](https://slsdetectorgroup.github.io/sls_detector/)
-
-
-### Install using conda ###
-
-Binaries are available using conda. This installs both the detector software and the Python
-interface.
-
-```bash
-#Add conda channels
-conda config --add channels conda-forge
-conda config --add channels slsdetectorgroup
-
-#Install latest version
-conda install sls_detector
-
-#Install specific version
-conda install sls_detector=3.0.1
-
-#Scientific Linux 6 version (GLIBC2.12)
-conda install sls_detector=SL6_3.0.1
-```
-
-### Building using conda-build ###
-
-Needs [sls_detector_software](https://github.com/slsdetectorgroup/sls_detector_software) installed.
-
-```bash
-#Clone source code
-git clone https://github.com/slsdetectorgroup/sls_detector.git
-
-#Checkout the branch needed
-git checkout 3.0.1
-
-#Build and install the local version
-conda-build sls_detector
-conda install --use-local sls_detector
-
-
-```
-### Developer build ###
-
-IF you if you are developing and are making constant changes to the code it's a bit cumbersome 
-to build with conda and install. Then an easier way is to build the C/C++ parts in the package 
-directory and temporary add this to the path
-
-```bash
-#in path/to/sls_detector  
-python setup.py build_ext --inplace
-```
-Then in your Python script
-```python
-
-import sys
-sys.path.append('/path/to/sls_detector')
-from sls_detector import Detector
-```
-

python/examples/exposure_time.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 """
 Example showing how to set and get exposure times
 """

python/examples/manipulate_pattern.py

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

python/examples/non-blocking-acquire-process.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 import time
 from multiprocessing import Process
 from slsdet import Detector, runStatus

python/examples/non-blocking-acquire.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 import time
 from slsdet import Detector, runStatus
 

python/examples/reading_dacs.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from slsdet import Detector, Eiger, dacIndex
 
 

python/examples/reading_temperature.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from slsdet import Detector, Eiger, dacIndex
 
 

python/examples/threshold_scan.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from slsdet import Eiger
 
 d = Eiger()

python/examples/use_currentsource.py

@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+from slsdet import Detector, currentSrcParameters
+
+s = currentSrcParameters()
+s.enable = 1
+s.fix= 1
+s.normal = 1
+s.select = 10
+
+
+d = Detector()
+d.currentsource = s

python/examples/use_enum.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 # Most settings are represented as enums that can be 
 # explicitly imported
 

python/examples/using_scan.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 
 from slsdet import Mythen3, scanParameters, dacIndex
 
@@ -15,5 +17,7 @@ sp.dacSettleTime_ns = int(1e9)
 d = Mythen3()
 d.setScan(sp)
 
+#or d.scan = sp
+
 
 

python/scripts/basic.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 import os
 import sys
 import numpy as np

python/scripts/compare_with_commandline.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 import subprocess
 import locale
 out = subprocess.run(['g', 'list'], stdout = subprocess.PIPE, encoding=locale.getpreferredencoding())

python/scripts/compile_servers.py

@@ -0,0 +1,82 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+import subprocess
+import os
+import sys
+from pathlib import Path
+import shutil as sh
+from argparse import ArgumentParser
+
+class color:
+    HEADER = "\033[95m"
+    BLUE = "\033[94m"
+    CYAN = "\033[96m"
+    GREEN = "\033[92m"
+    YELLOW = "\033[93m"
+    RED = "\033[91m"
+    ENDC = "\033[0m"
+    BOLD = "\033[1m"
+    UNDERLINE = "\033[4m"
+    MAGENTA = "\033[35m"
+
+    @staticmethod
+    def red(s):
+        return f"{color.RED}{s}{color.ENDC}"
+
+    @staticmethod
+    def green(s):
+        return f"{color.GREEN}{s}{color.ENDC}"
+
+def add_to_path():
+    paths = [
+        "/opt/uClinux/bfin-uclinux/bin",
+        "/opt/nios2-gcc/bin",
+        "/opt/eldk-5.1/powerpc-4xx-softfloat/sysroots/i686-eldk-linux/usr/bin/ppc405-linux",
+    ]
+    os.environ["PATH"] += os.pathsep + os.pathsep.join(paths)
+
+
+def rc_to_string(rc):
+    if rc == 0:
+        return color.green("OK")
+    else:
+        return color.red("FAIL")
+
+
+
+parser = ArgumentParser()
+parser.add_argument('-t', '--tag', help = 'Tag added to server file name', default='developer')
+parser.add_argument('-g', '--git', help='Add new servers to the git repo', action="store_true")
+args = parser.parse_args()
+
+
+servers = [
+#     "eigerDetectorServer",
+#     "jungfrauDetectorServer",
+      "mythen3DetectorServer",
+#     "gotthard2DetectorServer",
+#     "gotthardDetectorServer",
+#     "ctbDetectorServer",
+#     "moenchDetectorServer",
+]
+
+
+server_root = Path("../../slsDetectorServers/").resolve()
+
+add_to_path()
+for server in servers:
+    bin_name = f"{server}_{args.tag}"
+    path = server_root / server
+    print(f"{bin_name} - ", end="")
+    os.chdir(path)
+    try: 
+        sh.rmtree(path/'bin')
+    except FileNotFoundError:
+        pass
+    p = subprocess.run(["make"], stdout=subprocess.DEVNULL)
+    print(rc_to_string(p.returncode))
+    if p.returncode == 0:
+        sh.move(f"bin/{server}", f"bin/{bin_name}")
+        if args.git:
+            print("Adding to git")
+            subprocess.run(['git', 'add', 'bin', '-f'])

python/scripts/generate_enums.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 """
 Code generator for enum bindings in the Python extension. 
 Reads the sls_detector_defs.h and enums_in.cpp then outputs 
@@ -11,14 +13,30 @@ import subprocess
 
 from parse import remove_comments
 
+allow_bitwise_op = ["M3_GainCaps"]
+allow_bitwise_op = ["streamingInterface"]
+
+op_key = {"operator|": "|", 
+          "operator&" : "&"}
+
 def single_line_enum(line):
     sub = line[line.find('{')+1:line.find('}')]
     return sub.strip().split(',')
 
 def extract_enums(lines):
+
+    # deal with enum class streamingInterface : int32_t
+    # and normal enum burstMode {
+
     line_iter = iter(lines)
     enums = {}
     for line in line_iter:
+        #Hack away class enum defs
+        if "class" in line:
+            line = line.replace("class", "")
+            line = line.replace(line[line.find(':'):line.find('{')], "")
+            line = line.replace("  ", " ")
+
         m = re.search("(?<=enum )\w+(?= {)", line)
         if m:
             enum_name = m.group()
@@ -44,25 +62,79 @@ def extract_enums(lines):
                         pass
             fields = [f.strip() for f in fields]
             enums[enum_name] = fields
+
+
+    #Loop again to find operators
+    for key in enums:
+        for line in lines:
+            if key in line and "operator" in line:
+                pos = line.find("operator")
+                op_type = line[pos:pos+9]
+                enums[key].append(op_type)
     return enums
 
+
 def generate_enum_string(enums):
     data = []
     for key, value in enums.items():
-        data.append(f'py::enum_<slsDetectorDefs::{key}>(Defs, "{key}")\n')
+        if key in allow_bitwise_op:
+            tag=", py::arithmetic()"
+        else:
+            tag=""
+        data.append(f'py::enum_<slsDetectorDefs::{key}>(Defs, "{key}"{tag})\n')
+        operators = []
         for v in value:
+            if "operator" not in v:
                 data.append(f'\t.value("{v}", slsDetectorDefs::{key}::{v})\n')
-        data.append('.export_values();\n\n')
+            else:
+                operators.append(v)
+        data.append('\t.export_values()')
+
+        #Here add the operators 
+        for op in operators:
+            data.append(f"\n\t.def(py::self {op_key[op]} slsDetectorDefs::{key}())")
+
+        data.append(';\n\n')
     return ''.join(data)
 
+
+def remove_ifdefs(lines):
+    """Keeps C++ version of the code"""
+    out = []
+    it = iter(lines)
+    skip = False
+    for line in it:
+        
+        if "#ifdef __cplusplus" in line:
+            line = next(it)
+
+        if "#else" in line:
+            skip = True
+
+        if "#endif" in line:
+            skip = False
+
+        if not skip and "#endif" not in line:    
+            out.append(line)
+    return out
+    
+
 with open('../../slsSupportLib/include/sls/sls_detector_defs.h') as f:
     data = f.read()
 
 data = remove_comments(data)
 data = data.splitlines()
+data = remove_ifdefs(data)
 enums = extract_enums(data)
+
+
 s = generate_enum_string(enums)
 
+# print(s)
+# for i, line in enumerate(data):
+#     print(i, line)
+
+
 with open('../src/enums_in.cpp') as f:
     data = f.read()
 

python/scripts/generate_functions.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 """
 This file is used to auto generate Python bindings for the 
 sls::Detector class. The tool needs the libclang bindings

python/scripts/list_tested_cmd.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 """
 Utility to find and list which command line functions have tests and
 where the tests are located

python/scripts/parse.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 import re
 import subprocess
 from subprocess import PIPE

python/scripts/test_virtual.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 import pytest
 import subprocess
 import os
@@ -101,15 +103,11 @@ def test_module_size(virtual_jf_detectors):
 
 def test_settings(virtual_jf_detectors):
     d = ExperimentalDetector()
-    assert d.settings == detectorSettings.DYNAMICGAIN
+    assert d.settings == detectorSettings.GAIN0
 
     gain_list = [
-        detectorSettings.FIXGAIN1,
-        detectorSettings.FIXGAIN2,
-        detectorSettings.FORCESWITCHG1,
-        detectorSettings.FORCESWITCHG2,
-        detectorSettings.DYNAMICHG0,
-        detectorSettings.DYNAMICGAIN,
+        detectorSettings.GAIN0,
+        detectorSettings.HIGHGAIN0,
     ]
 
     # Set all viable gain for Jungfrau to make sure nothing is crashing
@@ -117,15 +115,14 @@ def test_settings(virtual_jf_detectors):
         d.settings = gain
         assert d.settings == gain
 
-    d.setSettings(detectorSettings.FORCESWITCHG1, [1])
+    d.setSettings(detectorSettings.GAIN0, [1])
     assert d.settings == [
-        detectorSettings.DYNAMICGAIN,
-        detectorSettings.FORCESWITCHG1,
-        detectorSettings.DYNAMICGAIN,
+        detectorSettings.GAIN0,
+        detectorSettings.HIGHGAIN0,
     ]
 
-    d.settings = detectorSettings.DYNAMICGAIN
-    assert d.settings == detectorSettings.DYNAMICGAIN
+    d.settings = detectorSettings.GAIN0
+    assert d.settings == detectorSettings.GAIN0
 
 def test_frames(virtual_jf_detectors):
     d = ExperimentalDetector()
@@ -161,4 +158,34 @@ def test_period(virtual_jf_detectors):
     d.period  = t
     assert d.period == 10e-6
 
+def test_gainmode(virtual_jf_detectors):
+    d = ExperimentalDetector()
+    assert d.gainMode == gainMode.NORMAL_GAIN_MODE
+
+    gain_list = [
+        gainMode.DYNAMIC,
+        gainMode.FORCE_SWITCH_G1,
+        gainMode.FORCE_SWITCH_G2,
+        gainMode.FIX_G1,
+        gainMode.FIX_G2,
+        gainMode.FIX_G0
+    ]
+
+    # Set all viable gain for Jungfrau to make sure nothing is crashing
+    for gain in gain_list:
+        d.gainMode = gain
+        assert d.gainMode == gain
+
+    d.setGainMode(gainMode.FORCE_SWITCH_G1, [1])
+    assert d.gainMode == [
+        gainMode.DYNAMIC,
+        gainMode.FORCE_SWITCH_G1,
+        gainMode.FORCE_SWITCH_G2,
+        gainMode.FIX_G1,
+        gainMode.FIX_G2,
+        gainMode.FIX_G0
+    ]
+
+    d.gainMode = gainMode.FORCE_SWITCH_G1
+    assert d.gainMode == gainMode.FORCE_SWITCH_G1
     

python/setup.py

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 """
 Setup file for slsdet
 Build upon the pybind11 example found here: https://github.com/pybind/python_example
 """
-from setuptools import setup, Extension, find_packages
-from setuptools.command.build_ext import build_ext
-import sys
-import setuptools
+
 import os
+import sys
+sys.path.append('../libs/pybind11')
+from setuptools import setup, find_packages
+from pybind11.setup_helpers import Pybind11Extension, build_ext
 
 __version__ = os.environ.get('GIT_DESCRIBE_TAG', 'developer')
 
@@ -19,109 +22,30 @@ def get_conda_path():
     return os.environ['CONDA_PREFIX']
 
 
-# class get_pybind_include(object):
-#     """Helper class to determine the pybind11 include path
-#     The purpose of this class is to postpone importing pybind11
-#     until it is actually installed, so that the ``get_include()``
-#     method can be invoked. """
-
-#     def __init__(self, user=False):
-#         self.user = user
-
-#     def __str__(self):
-#         import pybind11
-#         return pybind11.get_include(self.user)
-
-
+#TODO migrate to CMake build? 
 ext_modules = [
-    Extension(
+    Pybind11Extension(
         '_slsdet',
         ['src/main.cpp',
+        'src/current.cpp',
         'src/enums.cpp',
         'src/detector.cpp',
-        'src/network.cpp'],
+        'src/network.cpp',
+        'src/pattern.cpp',
+        'src/scan.cpp',],
         include_dirs=[
-            # Path to pybind11 headers
-            # get_pybind_include(),
-            # get_pybind_include(user=True),
             os.path.join('../libs/pybind11/include'),
             os.path.join(get_conda_path(), 'include'),
 
         ],
-        libraries=['SlsDetector', 'SlsReceiver', 'zmq'],
+        libraries=['SlsDetector', 'SlsSupport', 'SlsReceiver', 'zmq'],
         library_dirs=[
             os.path.join(get_conda_path(), 'lib'),
-            os.path.join(get_conda_path(), 'bin'),
         ],
-
         language='c++'
     ),
 ]
 
-
-# As of Python 3.6, CCompiler has a `has_flag` method.
-# cf http://bugs.python.org/issue26689
-def has_flag(compiler, flagname):
-    """Return a boolean indicating whether a flag name is supported on
-    the specified compiler.
-    """
-    import tempfile
-    with tempfile.NamedTemporaryFile('w', suffix='.cpp') as f:
-        f.write('int main (int argc, char **argv) { return 0; }')
-        try:
-            compiler.compile([f.name], extra_postargs=[flagname])
-        except setuptools.distutils.errors.CompileError:
-            return False
-    return True
-
-
-def cpp_flag(compiler):
-    """Return the -std=c++[11/14] compiler flag.
-    The c++14 is prefered over c++11 (when it is available).
-    """
-    if has_flag(compiler, '-std=c++14'):
-        return '-std=c++14'
-    elif has_flag(compiler, '-std=c++11'):
-        return '-std=c++11'
-    else:
-        raise RuntimeError('Unsupported compiler -- at least C++11 support '
-                           'is needed!')
-
-
-class BuildExt(build_ext):
-    """A custom build extension for adding compiler-specific options."""
-    c_opts = {
-        'msvc': ['/EHsc'],
-        'unix': [],
-    }
-
-    if sys.platform == 'darwin':
-        c_opts['unix'] += ['-stdlib=libc++', '-mmacosx-version-min=10.7']
-
-    def build_extensions(self):
-        ct = self.compiler.compiler_type
-        opts = self.c_opts.get(ct, [])
-        if ct == 'unix':
-            opts.append('-DVERSION_INFO="%s"' % self.distribution.get_version())
-            opts.append(cpp_flag(self.compiler))
-            if has_flag(self.compiler, '-fvisibility=hidden'):
-                opts.append('-fvisibility=hidden')
-        elif ct == 'msvc':
-            opts.append('/DVERSION_INFO=\\"%s\\"' % self.distribution.get_version())
-        for ext in self.extensions:
-            ext.extra_compile_args = opts
-
-        print('**************************************************')
-        print(ct)
-        print(opts)
-        print('**************************************************')
-        build_ext.build_extensions(self)
-        
-
-
-def get_shared_lib():
-    return [f for f in os.listdir('.') if '_slsdet' in f]
-
 setup(
     name='slsdet',
     version=__version__,
@@ -132,6 +56,6 @@ setup(
     long_description='',
     packages=find_packages(exclude=['contrib', 'docs', 'tests']),
     ext_modules=ext_modules,
-    cmdclass={'build_ext': BuildExt},
+    cmdclass={"build_ext": build_ext},
     zip_safe=False,
 )

python/slsdet/__init__.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 # from .detector import Detector, DetectorError, free_shared_memory
 from .eiger import Eiger
 from .ctb import Ctb
@@ -21,3 +23,4 @@ from .enums import *
 IpAddr = _slsdet.IpAddr
 MacAddr = _slsdet.MacAddr
 scanParameters = _slsdet.scanParameters
+currentSrcParameters = _slsdet.currentSrcParameters

python/slsdet/adcs.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from functools import partial
 class Adc:
     def __init__(self, name, enum, detector):

python/slsdet/ctb.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from .detector import Detector
 from .utils import element_if_equal
 from .dacs import DetectorDacs

python/slsdet/dacs.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from .detector_property import DetectorProperty
 from functools import partial
 import numpy as np

python/slsdet/decorators.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """

python/slsdet/detector_property.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from collections.abc import Iterable
 import numpy as np
 

python/slsdet/eiger.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """

python/slsdet/enums.py

@@ -1,17 +1,22 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+"""
+Automatically improt all enums from slsDetectorDefs and give an
+alias with their name in the enum module. All names from the enum
+module is later imported into slsdet
+
+Example: detectorType = _slsdet.slsDetectorDefs.detectorType
+Usage can later be:
+
+from slsdet import detectorType
+if dt === detectorType.EIGER:
+    #do something
+
+"""
+
 
 import _slsdet
-runStatus = _slsdet.slsDetectorDefs.runStatus
-speedLevel = _slsdet.slsDetectorDefs.speedLevel
-detectorType = _slsdet.slsDetectorDefs.detectorType
-frameDiscardPolicy = _slsdet.slsDetectorDefs.frameDiscardPolicy
-fileFormat = _slsdet.slsDetectorDefs.fileFormat
-dimension = _slsdet.slsDetectorDefs.dimension
-externalSignalFlag = _slsdet.slsDetectorDefs.externalSignalFlag
-timingMode = _slsdet.slsDetectorDefs.timingMode
-dacIndex = _slsdet.slsDetectorDefs.dacIndex
-detectorSettings = _slsdet.slsDetectorDefs.detectorSettings
-clockIndex = _slsdet.slsDetectorDefs.clockIndex
-readoutMode = _slsdet.slsDetectorDefs.readoutMode
-masterFlags = _slsdet.slsDetectorDefs.masterFlags
-burstMode = _slsdet.slsDetectorDefs.burstMode
-timingSourceType = _slsdet.slsDetectorDefs.timingSourceType
+for name, cls in _slsdet.slsDetectorDefs.__dict__.items():
+    if isinstance(cls, type):
+        exec(f'{name} = {cls.__module__}.{cls.__qualname__}')
+

python/slsdet/errors.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """

python/slsdet/gotthard.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """

python/slsdet/gotthard2.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """

python/slsdet/jungfrau.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """

python/slsdet/lookup.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
 from .detector import Detector
 
 def view(name, det = Detector):