Jungfrau

README

b'### Note\n\nPlease do not update to any xxxx.xx.xx.dev0 tags. They are not releases, but tags for internal usage.\nUse only releases with tags such as x.x.x or x.x.x-rcx.\n\n### Documentation\n##### 5.0.0 - Latest Release\nDetailed documentation on the latest release can be found in the software wiki and on the official site.\n\n##### Older Releases\nDocumentation is found in the package.\n\n### Binaries\nBinaries for the slsDetectorPackage are available through conda. \n\n#Add conda channels\nconda config --add channels conda-forge\nconda config --add channels slsdetectorgroup\nconda config --set channel_priority strict\n\nconda install slsdetlib #only shared lib and command line\nconda install slsdet #python bindings (includes slsdetlib)\nconda install slsdetgui #gui (includes qt4)\n\n#Install specific version\nconda install slsdet=2020.03.02.dev0 #developer version from 3 March 2020\n\n\n\n### Source code\nOne can also obtain the source code from this repository and compile.\n\ngit clone https://github.com/slsdetectorgroup/slsDetectorPackage.git\n\n\n#### Dependencies \n\nRefer this page for dependencies.\n\n\n#### Compilation \n\nCompiling can be done in two ways. Either with the convenience script\ncmk.sh or directly with cmake for more control.\n\n1. Compile using script cmk.sh
\n\nThese are mainly aimed at those not familiar with using ccmake and cmake. \n\n The binaries are generated in slsDetectorPackage/build/bin directory.\n\n Usage: ./cmk.sh [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-l Install directory] [-k <CMake command>] [-j <Number of threads>]\n -[no option]: only make\n -c: Clean\n -b: Builds/Rebuilds CMake files normal mode\n -p: Builds/Rebuilds Python API\n -h: Builds/Rebuilds Cmake files with HDF5 package\n -d: HDF5 Custom Directory\n -k: CMake command\n -l: Install directory\n -t: Build/Rebuilds only text client\n -r: Build/Rebuilds only receiver\n -g: Build/Rebuilds only gui\n -s: Simulator\n -u: Chip Test Gui\n -j: Number of threads to compile through\n -e: Debug mode\n -i: Builds tests\n -m: Manuals\n -n: Manuals without compiling doxygen (only rst)\n -z: Moench zmq processor\n\n \n # get all options\n ./cmk.sh -?\n\n # new build and compile in parallel:\n ./cmk.sh -bj5\n\n \n2. Compile without script
\nUse cmake to create out-of-source builds, by creating a build folder parallel to source directory. This would create a debug build with address sanitizers.\n\n $ mkdir build\n $ cd build\n $ cmake ../slsDetectorPackage -DCMAKE_BUILD_TYPE=Debug -DSLS_USE_SANITIZER=ON\n $ make -j12 #or whatever number of threads wanted\n\n\nTo install binaries using CMake\n\n git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git\n mkdir build && cd build\n cmake ../slsDetectorPackage -DCMAKE_INSTALL_PREFIX=/your/install/path\n make -j12 #or whatever number of cores you are using to build\n make install\n\n\n\n### Support\n dhanya.thattil@psi.ch\n erik.frojdh@psi.ch'