sdhcal / streamout

Standalone SDHCAL raw data processor

SDHCAL v0.1.0

Standalone SDHCAL raw data processor

Available interfaces

Description	Type	Build
Reading the rawdata from binary file .dat	Input
Write to ROOT file	Output
Write to LCIO file	Output

Documentation

🌍 Online

📖 PDF

How to compile

CMake options

BUILD_ROOT_INTERFACE : Allow to write ROOT files.
BUILD_LCIO_INTERFACE : Allow to write LCIO files (not implemented).
BUILD_RAWDATA_INTERFACE : Allow to read RAWDATA from .dat files.
BUILD_TESTS : Build the tests.
BUILD_APPS : Build the apps.
BUILD_DOCS : Build the documentation.

Use cmake (tested with version 3.15.3 ... 3.24)

1. git clone https://github.com/SDHCAL/streamout.git
2. cmake -DBUILD_ROOT_INTERFACE=ON -DBUILD_LCIO_INTERFACE=ON -DBUILD_RAWDATA_INTERFACE=ON -B ./build -S ./streamout -DCMAKE_INSTALL_PREFIX=./install
3. cmake --build ./build --parallel 10
4. cmake --install build
5. ctest -VV

How to use the software

⚠️ It still under testing so they are in tests folder

1. You can export STREAMOUT_OUTPUT_PATH=mypath to select where the apps will write the output file.
2. Run ./install/bin/tests/RawdataROOT.test --help to list the parameters.
3. For example ./install/bin/tests/RawdataROOT.test -f ./SMM_210616_040234_732873.dat -s 20 -e 10. Will read the 10 first event skipping the first 20 bits of the header and write ROOT file SMM_210616_040234_732873.root.
4. You can cross-check the output using ../install/bin/tests/ROOTchecker.test -f SMM_210616_040234_732873.root.

streamout's Issues

some function member are misleading and should not be used by the customer

Looking on the function member they are a by tricky... As far as I understand most of the classes are just selector of a bunch of bits..

It would be nice maybe to have name closer to the std like
begin end size at etc

Will be shorter and easier to understand.
Some classes are used by the user but should maybe be used only internaly... Maybe we could inherit DifPtr and slow control stuf to the sdhcalbuffer and return only this guys

Supress DIFUnpacker

Hi,
DIFUnpacker just add a level of indirection for nothing for what i can see... It should be cleaner to supress it and put the members directly in the class that use it

Issue when compiling version as of July 12, 2022

Usual setup on ubuntu :
source /data/software/binaries/root/6.22.06/bin/thisroot.sh
mkdir build; cd build
cmake ..
make

Output of make in following file :
out.txt

create a repository with data

I would be nice to have a dedicated package with some data for the test.. Some files that could become our golden test data

I think I would be better do have a dedicated repository for this as the files would be quite big ~1M I imagine and would be useless out of the test

Add comment about the member functions

If i remember we have the data layout. Maybe we could add this as code in some file to better understand what the code is parsing ... Maybe explain the difference between BCID GTC etc as it's always confusing. It would be nice to add this at least in some code and even better in doxygen format

Add a Hook for git

Would be nice to have a hook for github to block if we don't run formatters
Or at least run the target even if it does nothing if the program are not present in the computer (they should they are nice !!!)

For this i would have to modify the .cmake and put all the formatters on by default (Don't worry i understand me :) )

Problem compilation with ROOT installed on ubuntu

After setting up ROOT (source .../bin/thisroot.sh )
compilation fails with
data/software/dev/streamout/libs/interface/ROOT/include/Hit.h:7:10: fatal error: TObject.h: Aucun fichier ou dossier de ce type
7 | #include <TObject.h>
| ^~~~~~~~~~~
ROOT version is 6.22.06

LCIO not linked properly

I need to setup some parameters in cmake...

PROBLEM SC TRAILER NOT FOUND

Hi,

There is some PROBLEM SC TRAILER NOT FOUND error in the test file. I don't know if it's a software problem or hardware problem

Any idea?