diff --git a/docs/SOFTWARE.md b/docs/SOFTWARE.md index b70d38ea..3f783c2d 100644 --- a/docs/SOFTWARE.md +++ b/docs/SOFTWARE.md @@ -1,13 +1,12 @@ # Software requirements ## Operating system -Recommended operating system is Red Hat Enterprise Linux (RHEL) / Rocky Linux versions 8. -For this operating system we provide RPMs with pre-built binaries to simplify deployment. +Recommended operating system is Red Hat Enterprise Linux (RHEL) / Rocky Linux versions 8 or 9. +For this operating systems we provide RPMs with pre-built binaries to simplify deployment. +On experimental basis we also build repositories for Ubuntu 22.04 and 24.04. -We do also operate one of the systems with Rocky 9 without issues. Running Jungfraujoch on Red Hat Enterprise Linux 7 is currently not tested and not recommended, but likely possible with providing some packages from external repositories. -There are some limited tests with recent Ubuntu and Fedora distributions, though these are not systematic. -Other linux platforms should work, but no tests were done so far. + ## Software dependencies Required: @@ -15,13 +14,16 @@ Required: * CMake version 3.21 or newer + GNU make tool * zlib compression library * EIGEN library (only on a compilation system) +* HDF5 library version 1.10 or newer - see [github.com/HDFGroup/hdf5](https://github.com/HDFGroup/hdf5) +* TIFF library - see [gitlab.com/libtiff/libtiff](https://gitlab.com/libtiff/libtiff) +* JPEG library (preferably jpeg-turbo) - see [github.com/libjpeg-turbo/libjpeg-turbo](https://github.com/libjpeg-turbo/libjpeg-turbo) Optional: * CUDA compiler version 11 or newer - required for MX fast feedback indexer * FFTW library - for indexing if GPU/CUDA is absent * NUMA library - to pin threads to nodes/CPUs * Node.js - to make frontend -* Qt version 6.8 (for jfjoch_viewer) +* Qt version 6 (for jfjoch_viewer) Automatically downloaded by CMake and statically linked: * SLS Detector Package - see [github.com/slsdetectorgroup/slsDetectorPackage](https://github.com/slsdetectorgroup/slsDetectorPackage) @@ -29,9 +31,6 @@ Automatically downloaded by CMake and statically linked: * Pistache webserver - see [github.com/pistacheio/pistache](https://github.com/pistacheio/pistache) * Fast feedback indexer (Hans-Christian Stadler, PSI) - see [github.com/paulscherrerinstitute/fast-feedback-indexer](https://github.com/paulscherrerinstitute/fast-feedback-indexer) * Catch2 testing library - see [github.com/catchorg/Catch2](https://github.com/catchorg/Catch2) -* HDF5 library - see [github.com/HDFGroup/hdf5](https://github.com/HDFGroup/hdf5) -* TIFF library - see [gitlab.com/libtiff/libtiff](https://gitlab.com/libtiff/libtiff) -* JPEG library (preferably jpeg-turbo) - see [github.com/libjpeg-turbo/libjpeg-turbo](https://github.com/libjpeg-turbo/libjpeg-turbo) * Ceres Solver library for least square optimization - see [http://ceres-solver.org/] Please follow the link provided above to check for LICENSE file. Building code with dependencies above requires access from the build system to github.com.