From 3c0f0ab49f10085591493af0adb427cfff2af3b9 Mon Sep 17 00:00:00 2001 From: Andrej Babic Date: Wed, 22 Jul 2020 11:06:28 +0200 Subject: [PATCH] Update README.md about the sf-buffer --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5ada895..86f3bcd 100644 --- a/README.md +++ b/README.md @@ -167,6 +167,16 @@ pulses, while FILE_MOD == 1000 means that each file inside the data_folder will contain 1000 pulses. The total number of data_files in each data_folder will therefore be **FILE\_MOD / FOLDER\_MOD = 100**. +### Analyzing the buffer +In **sf-utils** there is a Python module that allows you to read directly the +buffer in order to debug it or to verify the consistency between the HDF5 file +and the received data. + +- VerifyH5DataConsistency.py checks the consistency between the H5 file and +buffer. +- BinaryBufferReader.py reads the buffer and prints metadata. The class inside +can also be used in external scripts. + ## Data request ranges Data request ranges are composed of: