GotthardDetector

README

b'### Documentation\nDetailed documentation can be found on the official site.\n\n### Binaries\nDocumentation to obtain the binaries via the conda package is available here.\n\n### Source code\nOne can also obtain the source code from this repository and compile while realizing the setup dependencies as required.\n\ngit clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch 3.1.0\n\n\n#### Setup dependencies \n Gui Client
\nRequirements: Qt 4.8 and Qwt 6.0\n\n export QTDIR=/usr/local/Trolltech/\n export QWTDIR=/usr/local/qwt-6.0.1/\n\nIf either of them does not exist, the GUI client will not be built.\n\n Calibration wizards
\nRequirements: ROOT\n\n export ROOTSYS=/usr/local/root-5.34\n\n\n#### Compilation \n\nCompiling can be done in two ways.\n\n1. Compile using script cmk.sh
\n\nAfter compiling, the libraries and executables will be found in slsDetectorPackage/build/bin directory
\n\nUsage: [-c] [-b] [-h] [-d HDF5 directory] [-j]
\n * -[no option]: only make
\n * -c: Clean
\n * -b: Builds/Rebuilds CMake files normal mode
\n * -h: Builds/Rebuilds Cmake files with HDF5 package
\n * -d: HDF5 Custom Directory
\n * -t: Build/Rebuilds only text client
\n * -r: Build/Rebuilds only receiver
\n * -g: Build/Rebuilds only gui
\n * -j: Number of threads to compile through
\n \nFor only make:\n./cmk.sh\n\nFor make clean;make:\n./cmk.sh -c\n\nFor using hdf5 without custom dir /blabla:\n./cmk.sh -h -d /blabla\n\nFor rebuilding cmake without hdf5 \n./cmk.sh -b\n\nFor using multiple cores to compile faster:\n./cmk.sh -j9
\n\n\nFor rebuilding only certain sections
\n./cmk.sh -tg #only text client and gui
\n./cmk.sh -r #only receiver
\n\n\n2. Compile without script
\nUse cmake to create out-of-source builds, by creating a build folder parallel to source directory.\n\n $ cd ..\n $ mkdir slsDetectorPackage-build\n $ cd slsDetectorPackage-build\n $ cmake ../slsDetectorPackage -DCMAKE_BUILD_TYPE=Debug -DUSE_HDF5=OFF \n $ make\n\n\nUse the following as an example to compile statically and using specific hdf5 folder\n\n $ HDF5_ROOT=/opt/hdf5v1.10.0 cmake ../slsDetectorPackage -DCMAKE_BUILD_TYPE=Debug -DUSE_HDF5=ON\n \nAfter compiling, the libraries and executables will be found at bin directory\n\n $ ls bin/\n gui_client libSlsDetector.a libSlsDetector.so libSlsReceiver.a libSlsReceiver.so\n sls_detector_acquire sls_detector_get slsDetectorGui sls_detector_help sls_detector_put slsReceiver\n\n'