Dev/doc/add ctb to doc (#1455)

* added numpy for patterngenerator

* treat warnings as errors

* fix warnings during docu build

* added power and ctb to documentation
This commit is contained in:
2026-08-03 09:13:52 +02:00
committed by mazzol_a
parent 732599bc10
commit c2b4007de3
11 changed files with 67 additions and 18 deletions
+3
View File
@@ -67,12 +67,14 @@ This runs all tests marked with the tag ``[.detectorintegration]`` for all detec
If you want to run them for a specific virtual detector or a specific test use the following command:
.. code-block:: console
cd build
python bin/test_simulators.py --servers jungfrau --test "[dacs]"
You can exclude specific tests by adding the option ``~[<disable_test_name>]``. Again, we assume that this marker is added to the tests that you want to exclude.
.. code-block:: console
cd build
python bin/test_simulators.py --servers eiger jungfrau moench --test "[detectorintegration]~[disable_check_data_file]"
@@ -98,6 +100,7 @@ If a test requires a detector mark them with the pytest marker ``@pytest.mark.de
To run only tests requiring virtual detectors use the following command:
.. code-block:: console
#in build
python -m pytest -m detectorintegration ../python/tests/
+9 -3
View File
@@ -49,9 +49,15 @@ GUI
* Qt 5.9
* Qwt 6.1.5 (packaged in libs)
-----------------------
Moench executables
-----------------------
.. note::
Qwt is bundled in libs. One does not need to pre-install it on the system.
-----------------------------------------------------
Dependencies to build Moench and Jungfrau executables
-----------------------------------------------------
To build the Moench and Jungfrau executables for preprocessing and calibration the following dependencies are needed:
* libtiff
+4 -1
View File
@@ -45,13 +45,16 @@ int main() {
for (const auto &cmd : commands) {
std::ostringstream os;
std::cout << cmd << '\n';
caller.call(cmd, {}, -1, slsDetectorDefs::HELP_ACTION, os);
auto tmp = os.str().erase(0, cmd.size());
auto usage = tmp.substr(0, tmp.find_first_of('\n'));
tmp.erase(0, usage.size());
auto help = replace_all(tmp, "\n\t", "\n\t\t| ");
if (help.back() != '\n') {
help.push_back('\n');
}
fs << '\t' << cmd << usage << help << "\n";
}
+2
View File
@@ -48,7 +48,9 @@ slsDetectorPackage
pygettingstarted
pydetector
pyctb
pyenums
pypower
pyexamples
pyPatternGenerator
pattern
+15
View File
@@ -0,0 +1,15 @@
Ctb
=====================================================
.. py:currentmodule:: slsdet
.. autoclass:: Ctb
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
+12
View File
@@ -0,0 +1,12 @@
Power Supply
===============
Helper class to control power supplies on the Chip Test Board (CTB, Xilinx CTB).
.. py:currentmodule:: slsdet
.. autoclass:: Power
:members:
:undoc-members:
:show-inheritance:
:inherited-members: