updated for 9.0.0

ToString.html

@@ -106,7 +106,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

_sources/dependencies.rst.txt

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

_sources/index.rst.txt

@@ -12,7 +12,7 @@ Welcome to slsDetectorPackage's documentation!
     For further documentation, visit the official page: https://www.psi.ch/en/detectors/documentation
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 3
     :caption: Installation:
 
     installation
@@ -88,7 +88,6 @@ Welcome to slsDetectorPackage's documentation!
 
     fileformat
     slsreceiverheaderformat
-    ctbframeformat
     masterfileattributes
     binaryfileformat
     hdf5fileformat

_sources/installation.rst.txt

@@ -1,18 +1,23 @@
+
+
+.. _Installation:
+
+
+Installation
+===============
+
+One can either install pre-built binaries using conda or build from source.
+
 .. warning ::
     
     Before building from source make sure that you have the 
     :doc:`dependencies <../dependencies>` installed. If installing using conda, conda will 
     manage the dependencies. Avoid also installing packages with pip. 
    
 
-.. _Installation:
-
-
-Installation
-===============
 
 Install binaries using conda
--------------------------------
+----------------------------------
 
 Conda is not only useful to manage python environments but can also
 be used as a user space package manager. Dates in the tag (for eg. 2020.07.23.dev0) 
@@ -55,7 +60,7 @@ We have three different packages available:
 
 
 Build from source
--------------------
+----------------------
 
 1. Download Source Code from github
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -75,8 +80,10 @@ Build from source
 2. Build from Source
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+One can either build using cmake or use the in-built cmk.sh script.
+
 Build using CMake
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: bash
 
@@ -103,7 +110,7 @@ Instead of the cmake command, one can use ccmake to get a list of options to con
     ccmake ..
  
     # choose the options
-    # first press [c] - configure (maybe multiple times till you see [g])
+    # first press [c] - configure (until you see [g])
     # then press [g] - generate
 
 
@@ -123,7 +130,7 @@ Example cmake options               Comment
 
 
 Build using in-built cmk.sh script
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
 .. code-block:: bash
@@ -173,7 +180,7 @@ Build using in-built cmk.sh script
 
 
 Build on old distributions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If your linux distribution doesn't come with a C++11 compiler (gcc>4.8) then 
 it's possible to install a newer gcc using conda and build the slsDetectorPackage
@@ -198,7 +205,7 @@ using this compiler
 
 
 Build slsDetectorGui (Qt5)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 1. Using pre-built binary on conda
 
@@ -259,7 +266,7 @@ Build slsDetectorGui (Qt5)
 
 
 Build this documentation
-^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The documentation for the slsDetectorPackage is build using a combination 
 of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies
@@ -282,7 +289,7 @@ is to use conda
 
 
 Pybind and Zeromq
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. _pybind for different slsDetectorPackage versions:
 
@@ -292,7 +299,7 @@ Pybind and Zeromq
 |   pybind11 is built
 |   * by default from tar file in repo (libs/pybind/v2.1x.0.tar.gz) 
 |   * or use advanced option SLS_FETCH_PYBIND11_FROM_GITHUB [`link <https://github.com/pybind/pybind11>`__].
-|      * v9.0.0+: pybind11 (v2.13.0)
+|      * v9.0.0+: pybind11 (v2.13.6)
 |      * v8.x.x : pybind11 (v2.11.0)
 |
 | v7.x.x:

_sources/pygettingstarted.rst.txt

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

binaryfileformat.html

@@ -106,7 +106,6 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Binary File Format</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#master-file">Master File</a></li>

commandline.html

@@ -112,7 +112,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

consuming.html

@@ -112,7 +112,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

container_utils.html

@@ -106,7 +106,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

dependencies.html

@@ -115,7 +115,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>
@@ -175,8 +174,8 @@ <h2>Core<a class="headerlink" href="#core" title="Permalink to this heading">
 <h2>Python bindings<a class="headerlink" href="#python-bindings" title="Permalink to this heading"></a></h2>
 <blockquote>
 <div><ul class="simple">
-<li><p>Python &gt; 3.6</p></li>
-<li><p>pybind11 2.13.0 (packaged in libs)</p></li>
+<li><p>Python &gt;= 3.8</p></li>
+<li><p>pybind11 2.13.6 (packaged in libs)</p></li>
 </ul>
 </div></blockquote>
 <div class="admonition note">

detector.html

@@ -106,7 +106,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

examples.html

@@ -113,7 +113,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

fileformat.html

@@ -111,7 +111,6 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

firmware.html

@@ -148,7 +148,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

genindex.html

@@ -103,7 +103,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>

hdf5fileformat.html

@@ -106,7 +106,6 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">HDF5 File Format</a><ul>

index.html

@@ -105,7 +105,6 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
 <li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>
@@ -153,9 +152,38 @@ <h1>Welcome to slsDetectorPackage’s documentation!<a class="headerlink" href="
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Installation:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
-<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#install-binaries-using-conda">Install binaries using conda</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#build-from-source">Build from source</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#download-source-code-from-github">1. Download Source Code from github</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#build-from-source-using-cmake">2. Build from Source</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#build-using-cmake">Build using CMake</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#build-using-in-built-cmk-sh-script">Build using in-built cmk.sh script</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#build-on-old-distributions">Build on old distributions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#build-slsdetectorgui-qt5">Build slsDetectorGui (Qt5)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#build-this-documentation">Build this documentation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="installation.html#pybind-and-zeromq">Pybind and Zeromq</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#core">Core</a></li>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#python-bindings">Python bindings</a></li>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#zeromq">ZeroMQ</a></li>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#gui">GUI</a></li>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#moench-executables">Moench executables</a></li>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#documentation">Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="dependencies.html#packaged-in-libs">Packaged in libs/</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="consuming.html#cmake-slsdetectorpackage-as-submodule-in-your-project">CMake: slsDetectorPackage as submodule in your project</a></li>
+<li class="toctree-l2"><a class="reference internal" href="consuming.html#cmake-find-package-slsdetectorpackage">CMake: find_package(slsDetectorPackage)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="consuming.html#cmake-find-package-and-conda">CMake: find_package and conda</a></li>
+<li class="toctree-l2"><a class="reference internal" href="consuming.html#no-tools-minimal-approach">No tools minimal approach</a></li>
+</ul>
+</li>
 </ul>
 </div>
 <div class="toctree-wrapper compound">
@@ -358,12 +386,6 @@ <h1>Welcome to slsDetectorPackage’s documentation!<a class="headerlink" href="
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ctbframeformat.html">Chip Test Board Frame Format</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="ctbframeformat.html#contents-of-a-frame">Contents of a frame</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ctbframeformat.html#digital-data">Digital data</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ctbframeformat.html#parameters-of-readout-modes">Parameters of readout modes</a></li>
-</ul>
-</li>
 <li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#eiger">Eiger</a></li>
 <li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#jungfrau">Jungfrau</a></li>