cleaned up gh-pages moved stuff from devdoc

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