diff --git a/CMakeLists.txt b/CMakeLists.txt index c533aa5067..a7ca0a2987 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -309,14 +309,15 @@ if (SLS_USE_PYTHON) FetchContent_Declare( pybind11 GIT_REPOSITORY https://github.com/pybind/pybind11 - GIT_TAG v2.11.0 + GIT_TAG v2.13.0 ) else() + # https://github.com/pybind/pybind11/releases FetchContent_Declare( pybind11 - URL ${CMAKE_SOURCE_DIR}/libs/pybind11/v2.11.0.tar.gz - URL_HASH MD5=90c4946e87c64d8d8fc0ae4edf35d780 + URL ${CMAKE_SOURCE_DIR}/libs/pybind11/v2.13.0.tar.gz + URL_HASH MD5=10cb1efba3aca997389d08bceb0ea767 ) endif() FetchContent_MakeAvailable(pybind11) diff --git a/README.md b/README.md index abee0e7739..630ebd588f 100755 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ Before building from source make sure that you have the [software wiki](https://slsdetectorgroup.github.io/devdoc/dependencies.html) installed. If installing using conda, conda will manage the dependencies. Avoid also installing packages with pip. ## Documentaion -Detailed documentation can be found in the [software wiki](https://slsdetectorgroup.github.io/devdoc/index.html) and on the [official site](https://www.psi.ch/en/detectors/software). +Detailed documentation including installation can be found in the [software wiki](https://slsdetectorgroup.github.io/devdoc/index.html). + +Different releases can be found on the [official site](https://www.psi.ch/en/lxn/software-releases). + +Firmware compatiblity can be found in [firmware page](https://github.com/slsdetectorgroup/slsDetectorFirmware) ## Installation @@ -42,33 +46,20 @@ conda search slsdet conda search slsdetgui ``` -### 2. Build from source +## 2. Build from source -##### 2.1 Download Source Code from github +### 2.1 Download Source Code from github ``` git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch 7.0.0 ``` -**Pybind for Python**
-* **v7.0.0+**: -pybind11 packaged into 'libs/pybind'. No longer a submodule. No need for "recursive" or "submodule update". - -* **Older versions**: - pybind11 is a submodule. Must be cloned using "recursive" and updated when switching between versions using the following commands. - -``` -# clone using recursive to get pybind11 submodule -git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git +> **Note:** For v6.x.x of slsDetectorPackage and older, refer [pybind11 notes on cloning](#Pybind-and-Zeromq). -# update submodule when switching between releases -cd slsDetectorPackage -git submodule update --init -``` -##### 2.2 Build from source +### 2.2 Build from source -###### Build using CMake +### Build using CMake ``` # outside slsDetecorPackage folder @@ -94,26 +85,28 @@ Instead of the cmake command, one can use ccmake to get a list of options to con ccmake .. # choose the options -# first press [c] - configure +# first press [c] - configure (unil you see [g]) # then press [g] - generate ``` |Example cmake options|Comment| |---|---| | -DSLS_USE_PYTHON=ON | Python | -| -DPython_FIND_VIRTUALENV=ONLY | Python from only the conda environment | -| -DZeroMQ_HINT=/usr/lib64 | Use system zmq instead | +| -DPython_FIND_VIRTUALENV=ONLY | Python from only the conda env | | -DSLS_USE_GUI=ON | GUI | +| -DSLS_USE_HDF5=ON | HDF5 | +| -DSLS_USE_SIMULATOR=ON | Simulator | +> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for cmake option to hint library location](#Pybind-and-Zeromq). -###### Build using in-built cmk.sh script +### Build using in-built cmk.sh script ``` The binaries are generated in slsDetectorPackage/build/bin directory. -Usage: ./cmk.sh [-b] [-c] [-d ] [e] [g] [-h] [i] [-j ] -[-k ] [-l ] [m] [n] [-p] [-q ] -[r] [s] [t] [u] [z] +Usage: $0 [-b] [-c] [-d ] [-e] [-g] [-h] [-i] +[-j ] [-k ] [-l ] +[-m] [-n] [-p] [-r] [-s] [-t] [-u] [-z] -[no option]: only make -b: Builds/Rebuilds CMake files normal mode -c: Clean @@ -128,14 +121,13 @@ Usage: ./cmk.sh [-b] [-c] [-d ] [e] [g] [-h] [i] [-j ] [e] [g] [-h] [i] [-j **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for cmk script option to hint library location](#Pybind-and-Zeromq). + +### Build on old distributions If your linux distribution doesn't come with a C++11 compiler (gcc>4.8) then it's possible to install a newer gcc using conda and build the slsDetectorPackage @@ -166,7 +161,10 @@ cmake ../slsDetectorPackage -DCMAKE_PREFIX_PATH=$CONDA_PREFIX make -j12 ``` -###### Build slsDetectorGui (Qt5) +> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for dependencies for conda](#Pybind-and-Zeromq). + + +### Build slsDetectorGui (Qt5) 1. Using pre-built binary on conda ``` @@ -180,7 +178,14 @@ yum install qt5-qtbase-devel.x86_64 yum install qt5-qtsvg-devel.x86_64 ``` -3. Using conda +3. Using system installation on RHEL8 +``` +yum install qt5-qtbase-devel.x86_64 +yum install qt5-qtsvg-devel.x86_64 +yum install expat-devel.x86_64 +``` + +4. Using conda ``` #Add channels for dependencies and our library conda config --add channels conda-forge @@ -208,13 +213,15 @@ cd slsDetectorPackage ./cmk.sh -cbgj9 ``` -###### Build documentation from package +> **Note:** For v7.x.x of slsDetectorPackage and older, refer [zeromq notes for dependencies for conda](#Pybind-and-Zeromq). + +### Build documentation from package The documentation for the slsDetectorPackage is build using a combination of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies is to use conda ``` -conda create -n myenv python sphinx_rtd_theme breathe +conda create -n myenv python=3.12 sphinx sphinx_rtd_theme breathe doxygen numpy ``` ``` @@ -228,6 +235,47 @@ make rst # rst only, saves time in case the API did not change ``` + +## Pybind and Zeromq + +### Pybind11 for Python +**v8.0.0+**: +pybind11 is built +* by default from tar file in repo (libs/pybind/v2.1x.0.tar.gz) +* or use advanced option SLS_FETCH_PYBIND11_FROM_GITHUB [link]. + * v9.0.0+: pybind11 (v2.13.0) + * v8.x.x : pybind11 (v2.11.0) + +**v7.x.x**: +pybind11 packaged into ‘libs/pybind’. No longer a submodule. No need for “recursive” or “submodule update”. + +**Older versions**: +pybind11 is a submodule. Must be cloned using “recursive” and updated when switching between versions using the following commands. + +``` +# Note: Only for v6.x.x versions and older + +# clone using recursive to get pybind11 submodule +git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git + +# update submodule when switching between releases +cd slsDetectorPackage +git submodule update --init +``` + +### Zeromq +**v8.0.0+**: +zeromq (v4.3.4) is built +* by default from tar file in repo (libs/libzmq/libzmq-4.3.4.tar.gz) +* or use advanced option SLS_FETCH_ZMQ_FROM_GITHUB [link]. + +**v7.x.x and older**: +zeromq-devel must be installed and one can hint its location using +* cmake option:’-DZeroMQ_HINT=/usr/lib64’ or +* option ‘-q’ in cmk.sh script: : ./cmk.sh -cbj5 -q /usr/lib64 +* ‘zeromq’ dependency added when installing using conda + + ## Support dhanya.thattil@psi.ch - erik.frojdh@psi.ch + erik.frojdh@psi.ch \ No newline at end of file diff --git a/conda-recipe/meta.yaml b/conda-recipe/meta.yaml index 854fac56b9..ca770779d4 100755 --- a/conda-recipe/meta.yaml +++ b/conda-recipe/meta.yaml @@ -79,12 +79,13 @@ outputs: - {{compiler('cxx')}} - {{ pin_subpackage('slsdetlib', exact=True) }} - setuptools - - pybind11=2.11 + - pybind11=2.13 host: - python - {{ pin_subpackage('slsdetlib', exact=True) }} - - pybind11=2.11 + - setuptools + - pybind11=2.13 run: diff --git a/docs/src/dependencies.rst b/docs/src/dependencies.rst index 846fc0ff1f..34c3340fb2 100644 --- a/docs/src/dependencies.rst +++ b/docs/src/dependencies.rst @@ -21,7 +21,7 @@ Python bindings ----------------------- * Python > 3.6 - * pybind11 2.11.0 (packaged in libs) + * pybind11 2.13.0 (packaged in libs) .. note :: diff --git a/docs/src/installation.rst b/docs/src/installation.rst index 30c7376fde..c45143bd8b 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -103,7 +103,7 @@ Instead of the cmake command, one can use ccmake to get a list of options to con ccmake .. # choose the options - # first press [c] - configure (maybe multiple times till you see [g]) + # first press [c] - configure (until you see [g]) # then press [g] - generate @@ -287,11 +287,13 @@ Pybind and Zeromq .. _pybind for different slsDetectorPackage versions: -| **Pybind for Python** -| v8.0.0+: -| pybind11 (v2.11.0) is built -| * by default from tar file in repo (libs/pybind/v2.11.0.tar.gz) +| **Pybind11 for Python** +| v8.0.0+: +| pybind11 is built +| * by default from tar file in repo (libs/pybind/v2.1x.0.tar.gz) | * or use advanced option SLS_FETCH_PYBIND11_FROM_GITHUB [`link `__]. +| * v9.0.0+: pybind11 (v2.13.0) +| * v8.x.x : pybind11 (v2.11.0) | | v7.x.x: | pybind11 packaged into 'libs/pybind'. No longer a submodule. No need for "recursive" or "submodule update". diff --git a/libs/pybind11/v2.11.0.tar.gz b/libs/pybind11/v2.11.0.tar.gz deleted file mode 100644 index ef7cf6f55d..0000000000 Binary files a/libs/pybind11/v2.11.0.tar.gz and /dev/null differ diff --git a/libs/pybind11/v2.13.0.tar.gz b/libs/pybind11/v2.13.0.tar.gz new file mode 100644 index 0000000000..7aa9960dcd Binary files /dev/null and b/libs/pybind11/v2.13.0.tar.gz differ diff --git a/slsSupportLib/include/sls/versionAPI.h b/slsSupportLib/include/sls/versionAPI.h index 4d1b02caac..dde27f97de 100644 --- a/slsSupportLib/include/sls/versionAPI.h +++ b/slsSupportLib/include/sls/versionAPI.h @@ -1,8 +1,6 @@ // SPDX-License-Identifier: LGPL-3.0-or-other // Copyright (C) 2021 Contributors to the SLS Detector Package /** API versions */ -#define APIRECEIVER "developer 0x241014" -#define APILIB "developer 0x241021" #define APICTB "developer 0x241107" #define APIGOTTHARD "developer 0x241107" #define APIGOTTHARD2 "developer 0x241107" @@ -10,4 +8,6 @@ #define APIXILINXCTB "developer 0x241107" #define APIEIGER "developer 0x241107" #define APIJUNGFRAU "developer 0x241120" -#define APIMYTHEN3 "developer 0x241121" +#define APIMYTHEN3 "developer 0x241121" +#define APILIB "developer 0x241122" +#define APIRECEIVER "developer 0x241122"