Update Documentation for developer

This commit is contained in:
github-actions committed 2026-10-06 18:13:08 +00:00
1 parent e40a15a291
commit 1636bea757
6 files changed
+91 -5

No files matched your search

Binary file not shown.
Binary file not shown.
+46
View File
@@ -240,6 +240,52 @@ Example cmake options Comment
For v7.x.x of slsDetectorPackage and older, refer :ref:`zeromq notes for cmk script option to hint library location. <zeromq for different slsDetectorPackage versions>`
3.2.3. Build RPM packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
CPack builds separate RPMs for the command line tools (``cli``), receiver
executables (``receiver``), Moench processing tools (``zmq``), and GUI (``gui``).
Install ``rpm-build`` and the dependencies for the selected features, and build
on the target distribution or a matching container.
For example, to package the command line tools, receiver and GUI:
.. code-block:: bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=/usr -DSLS_USE_GUI=ON \
-DSLS_INSTALL_VERSIONED_BINARIES=ON
cmake --build build -j4
cpack --config build/CPackConfig.cmake -G RPM \
-D 'CPACK_COMPONENTS_ALL=cli;receiver;gui' -B build
Select only components enabled in the build. Add ``-DSLS_USE_MOENCH=ON`` and
the ``zmq`` component to package the Moench tools.
``SLS_INSTALL_VERSIONED_BINARIES=ON`` includes the project version in the RPM
package names, for example ``slsdetectorpackage-10.1.0-cli`` and
``slsdetectorpackage-10.1.0-gui``. Installed executables also receive a version
suffix, such as ``sls_detector_get-10.1.0`` and ``slsDetectorGui-10.1.0``. This
allows RPMs for different project versions to be installed side by side.
RPM revisions of the same project version retain the same package names and
can be upgraded normally.
RPM filenames include the version once, for example
``slsdetectorpackage-cli-10.1.0-1.fc44.x86_64.rpm``. The package's internal name
remains ``slsdetectorpackage-10.1.0-cli`` and its RPM version remains ``10.1.0``.
The option also applies to Jungfrau processing tools and virtual detector
servers installed with ``cmake --install``. These are outside the current RPM
component selection. Executables in the build directory keep their original
names. With the option set to ``OFF`` (the default), installed executables and
RPM package names omit the project version.
The RPM components contain executables; Python bindings, libraries and headers
are not included. A full ``cmake --install`` still installs libraries and
headers at their usual paths, so use separate prefixes for full installations
of different versions.
3.3. Build on old distributions using conda
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+1
View File
@@ -169,6 +169,7 @@ For further detector specific documentation, visit <a class="reference external"
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-from-source-using-cmake">3.2. Build from Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-using-cmake">3.2.1. Build using CMake</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-using-in-built-cmk-sh-script">3.2.2. Build using in-built cmk.sh script</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-rpm-packages">3.2.3. Build RPM packages</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-on-old-distributions-using-conda">3.3. Build on old distributions using conda</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-slsdetectorgui-qt5">3.4. Build slsDetectorGui (Qt5)</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-this-documentation">3.5. Build this documentation</a></li>
+43 -4
View File
@@ -54,6 +54,7 @@
<li class="toctree-l3"><a class="reference internal" href="#build-from-source-using-cmake">3.2. Build from Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build-using-cmake">3.2.1. Build using CMake</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build-using-in-built-cmk-sh-script">3.2.2. Build using in-built cmk.sh script</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build-rpm-packages">3.2.3. Build RPM packages</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build-on-old-distributions-using-conda">3.3. Build on old distributions using conda</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build-slsdetectorgui-qt5">3.4. Build slsDetectorGui (Qt5)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#build-this-documentation">3.5. Build this documentation</a></li>
@@ -180,12 +181,13 @@
<li><p><a class="reference internal" href="#build-from-source-using-cmake" id="id10">3.2. Build from Source</a></p></li>
<li><p><a class="reference internal" href="#build-using-cmake" id="id11">3.2.1. Build using CMake</a></p></li>
<li><p><a class="reference internal" href="#build-using-in-built-cmk-sh-script" id="id12">3.2.2. Build using in-built cmk.sh script</a></p></li>
<li><p><a class="reference internal" href="#build-on-old-distributions-using-conda" id="id13">3.3. Build on old distributions using conda</a></p></li>
<li><p><a class="reference internal" href="#build-slsdetectorgui-qt5" id="id14">3.4. Build slsDetectorGui (Qt5)</a></p></li>
<li><p><a class="reference internal" href="#build-this-documentation" id="id15">3.5. Build this documentation</a></p></li>
<li><p><a class="reference internal" href="#build-rpm-packages" id="id13">3.2.3. Build RPM packages</a></p></li>
<li><p><a class="reference internal" href="#build-on-old-distributions-using-conda" id="id14">3.3. Build on old distributions using conda</a></p></li>
<li><p><a class="reference internal" href="#build-slsdetectorgui-qt5" id="id15">3.4. Build slsDetectorGui (Qt5)</a></p></li>
<li><p><a class="reference internal" href="#build-this-documentation" id="id16">3.5. Build this documentation</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#pybind-and-zeromq" id="id16">4. Pybind and Zeromq</a></p></li>
<li><p><a class="reference internal" href="#pybind-and-zeromq" id="id17">4. Pybind and Zeromq</a></p></li>
</ul>
</nav>
<section id="overview">
@@ -404,6 +406,43 @@ Usage:<span class="w"> </span><span class="nv">$0</span><span class="w"> </span>
<p>For v7.x.x of slsDetectorPackage and older, refer <a class="reference internal" href="#zeromq-for-different-slsdetectorpackage-versions"><span class="std std-ref">zeromq notes for cmk script option to hint library location.</span></a></p>
</div>
</section>
<section id="build-rpm-packages">
<h3><a class="toc-backref" href="#contents" role="doc-backlink">3.2.3. Build RPM packages</a><a class="headerlink" href="#build-rpm-packages" title="Link to this heading"></a></h3>
<p>CPack builds separate RPMs for the command line tools (<code class="docutils literal notranslate"><span class="pre">cli</span></code>), receiver
executables (<code class="docutils literal notranslate"><span class="pre">receiver</span></code>), Moench processing tools (<code class="docutils literal notranslate"><span class="pre">zmq</span></code>), and GUI (<code class="docutils literal notranslate"><span class="pre">gui</span></code>).
Install <code class="docutils literal notranslate"><span class="pre">rpm-build</span></code> and the dependencies for the selected features, and build
on the target distribution or a matching container.</p>
<p>For example, to package the command line tools, receiver and GUI:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>-S<span class="w"> </span>.<span class="w"> </span>-B<span class="w"> </span>build<span class="w"> </span>-DCMAKE_BUILD_TYPE<span class="o">=</span>Release<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DCMAKE_INSTALL_PREFIX<span class="o">=</span>/usr<span class="w"> </span>-DSLS_USE_GUI<span class="o">=</span>ON<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DSLS_INSTALL_VERSIONED_BINARIES<span class="o">=</span>ON
cmake<span class="w"> </span>--build<span class="w"> </span>build<span class="w"> </span>-j4
cpack<span class="w"> </span>--config<span class="w"> </span>build/CPackConfig.cmake<span class="w"> </span>-G<span class="w"> </span>RPM<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-D<span class="w"> </span><span class="s1">'CPACK_COMPONENTS_ALL=cli;receiver;gui'</span><span class="w"> </span>-B<span class="w"> </span>build
</pre></div>
</div>
<p>Select only components enabled in the build. Add <code class="docutils literal notranslate"><span class="pre">-DSLS_USE_MOENCH=ON</span></code> and
the <code class="docutils literal notranslate"><span class="pre">zmq</span></code> component to package the Moench tools.</p>
<p><code class="docutils literal notranslate"><span class="pre">SLS_INSTALL_VERSIONED_BINARIES=ON</span></code> includes the project version in the RPM
package names, for example <code class="docutils literal notranslate"><span class="pre">slsdetectorpackage-10.1.0-cli</span></code> and
<code class="docutils literal notranslate"><span class="pre">slsdetectorpackage-10.1.0-gui</span></code>. Installed executables also receive a version
suffix, such as <code class="docutils literal notranslate"><span class="pre">sls_detector_get-10.1.0</span></code> and <code class="docutils literal notranslate"><span class="pre">slsDetectorGui-10.1.0</span></code>. This
allows RPMs for different project versions to be installed side by side.
RPM revisions of the same project version retain the same package names and
can be upgraded normally.</p>
<p>RPM filenames include the version once, for example
<code class="docutils literal notranslate"><span class="pre">slsdetectorpackage-cli-10.1.0-1.fc44.x86_64.rpm</span></code>. The package’s internal name
remains <code class="docutils literal notranslate"><span class="pre">slsdetectorpackage-10.1.0-cli</span></code> and its RPM version remains <code class="docutils literal notranslate"><span class="pre">10.1.0</span></code>.</p>
<p>The option also applies to Jungfrau processing tools and virtual detector
servers installed with <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">--install</span></code>. These are outside the current RPM
component selection. Executables in the build directory keep their original
names. With the option set to <code class="docutils literal notranslate"><span class="pre">OFF</span></code> (the default), installed executables and
RPM package names omit the project version.</p>
<p>The RPM components contain executables; Python bindings, libraries and headers
are not included. A full <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">--install</span></code> still installs libraries and
headers at their usual paths, so use separate prefixes for full installations
of different versions.</p>
</section>
<section id="build-on-old-distributions-using-conda">
<h3><a class="toc-backref" href="#contents" role="doc-backlink">3.3. Build on old distributions using conda</a><a class="headerlink" href="#build-on-old-distributions-using-conda" title="Link to this heading"></a></h3>
<p>If your linux distribution doesn’t come with a C++17 compiler (gcc&gt;8) then
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[24,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[24,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[23,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[20,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[21,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detector-index"]],"Detector status is waiting even in auto timLine truncated
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.2.3. Build RPM packages":[[16,"build-rpm-packages"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[24,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[24,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[23,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[20,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[21,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detectLine truncated