Dev/900/docs (#1057)

* minimum python is 3.8, so >=

* removed ctb frame documentation. should be in internal wiki

* minor doc change

docs/CMakeLists.txt

@@ -64,7 +64,6 @@ set(SPHINX_SOURCE_FILES
   src/binaryfileformat.rst
   src/hdf5fileformat.rst
   src/zmqjsonheaderformat.rst
-  src/ctbframeformat.rst
 )
 
 foreach(filename ${SPHINX_SOURCE_FILES})

docs/src/ctbframeformat.rst

@@ -1,81 +0,0 @@
-Chip Test Board Frame Format
-================================
-
-Contents of a frame
---------------------
-
-Each frame consists of 3 types of data in the following order:
-
-    .. code-block:: text
-
-        # only data from enabled modes are included
-        [ Analog Data ] 
-        [ Digital Data ]
-        [ Transceiver Data ]
-
-
-Each Data type is further divided into:
-
-    .. code-block:: text
-
-        [ Sample 0 for all enabled Channels ] 
-        [ Sample 1 for all enabled Channels ] 
-        ... 
-        [ Sample N for all enabled Channels ]
-
-
-Digital data
--------------------
-
-The chip test board sends out all digital data. 
-
-Only the receiver can filter them using the command `rx_dbitlist <commandline.html#term-rx_dbitlist-all-or-i0-i1-i2-...>`_. 
-
-    .. code-block:: text
-
-        # filtered and reordered digital data from receiver
-        # Any signal that is not a byte is filled with 0's to make up a byte
-
-        [all samples of list signal 0] 
-        [all samples of list signal 1] 
-        ... 
-        [all samples of list signal N]
-
-
-
-
-Parameters of readout modes
----------------------------------
-
-.. list-table:: 
-   :widths: 25 40 20 30
-   :header-rows: 1
-
-   * - Readout mode
-     - Enable Channels
-     - Number of samples
-     - Number of bytes
-   * - Analog
-     - 1G:  `adcenable <commandline.htmlterm-adcenable-bitmask>`_ 
-            
-       10G: `adcenable10g <commandline.htmlterm-adcenable10g-bitmask>`_  
-     - `asamples <commandline.html#term-asamples-n_samples>`_
-     - 2 bytes per channel,
-           
-       max 32 channels
-   * - Digital
-     - `rx_dbitlist <commandline.html#term-rx_dbitlist-all-or-i0-i1-i2-...>`_  
-              
-       [filtered only by receiver, module sends out all digital data]
-     - `dsamples <commandline.html#term-dsamples-n_value>`_
-     - 1 bit per signal,  
-          
-       max 64 signals
-   * - Transceiver
-     - `transceiverenable <commandline.html#term-transceiverenable-bitmask>`_
-     - `tsamples <commandline.html#term-tsamples-n_value>`_
-     - 8 bytes per channel,  
-         
-       max 4 channels
-
-

docs/src/dependencies.rst

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

docs/src/index.rst

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

docs/src/installation.rst

@@ -1,9 +1,4 @@
-.. warning ::
+
-    
-    Before building from source make sure that you have the 
-    :doc:`dependencies <../dependencies>` installed. If installing using conda, conda will 
-    manage the dependencies. Avoid also installing packages with pip. 
-   
 
 .. _Installation:
 
@@ -11,8 +6,18 @@
 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. 
+   
+
+
 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
 
@@ -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: