detectors/slsDetectorPackage
24
1
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-02-08 10:18:40 +01:00
Code Issues Actions Packages Releases Activity

Dev/doc cmake (#1290)

Browse Source 
* more detail documentation in installation

* more detail documentation in installation

* added links to api examples
This commit is contained in:
maliakal_d
2025-09-09 17:25:53 +02:00
committed by GitHub
parent c39bd98f2d
commit be3749f493
1 changed files with 27 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/src/installation.rst
View File

@@ -123,22 +123,45 @@ One can either build using cmake or use the in-built cmk.sh script.
3.2.1. Build using CMake 3.2.1. Build using CMake
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash .. code-block:: bash
# outside slsDetecorPackage folder # outside slsDetecorPackage folder
mkdir build && cd build mkdir build && cd build
# configure & generate Makefiles using cmake # configure & generate Makefiles using cmake by listing all your options
# by listing all your options (alternately use ccmake described below) # (alternately use ccmake described below)
# cmake3 for some systems # cmake3 instead of cmake for some systems
cmake ../slsDetectorPackage -DCMAKE_INSTALL_PREFIX=/your/install/path
# eg. enable gui option (without conda)
cmake ../slsDetectorPacakge -DSLS_USE_GUI=ON
# eg. enable python from virtual env, hdf5 and simulator options
cmake ../slsDetectorPackage -DSLS_USE_PYTHON=ON -DPython_FIND_VIRTUALENV=ONLY -DSLS_USE_HDF5=ON -DSLS_USE_SIMULATOR=ON
# compiled to the build/bin directory # compiled to the build/bin directory
make -j12 #or whatever number of cores you are using to build make -j12 #or whatever number of cores you are using to build
To install in a clean custom directory and to use the slsDetectorPackage
libraries and headers in your project, specify the install directory
(eg. /your/install/path).
.. code-block:: bash
# outside slsDetecorPackage folder
mkdir build && cd build
# configure & generate Makefiles
cmake ../slsDetectorPackage -DCMAKE_INSTALL_PREFIX=/your/install/path
# compile
make -j12
# install headers and libs in /your/install/path directory # install headers and libs in /your/install/path directory
make install make install
.. note ::
Please refer to `api examples <https://github.com/slsdetectorgroup/api-examples>`__
on how to compile your project using the installed headers and libs.
Instead of the cmake command, one can use ccmake to get a list of options to configure and generate Makefiles at ease. Instead of the cmake command, one can use ccmake to get a list of options to configure and generate Makefiles at ease.