Api (#48)

* WIP * WIP * WIP * cleaned up multi * WIP * WIP * WIP * WIP * WIP * WIP * WIP * WIP * split up python module * WIP * WIP * WIP * WIP * WIP * ok * fixed bugs from rebase * WIP * fixed broken test * WIP * fixed python * WIP * sphinx help * including new commands * docs * WIP * WIP * more tests * added missing public header * WIP
2025-06-21 09:08:00 +02:00 · 2019-08-07 11:21:07 +02:00
parent 98ddf154b2
commit 4ceee97c03
58 changed files with 2317 additions and 571 deletions
--- a/docs/src/dependencies.rst
+++ b/docs/src/dependencies.rst
@ -0,0 +1,53 @@
+Dependencies
+=========================
+
+While we value few dependencies some libraries are required in 
+order to not have to reinvent the wheel. Due to the state of package
+management in C++ we decided to bundle some of them with our source
+code. These are found in the libs/ directory. 
+
+-----------------------
+Core
+-----------------------
+To use the basic building blocks, meaning sls_detector_get/put and 
+the shared libraries these are needed: 
+
+ * Linux, preferably recent kernel (currently no cross platform support)
+ * CMake > 3.9 
+ * C++11 compatible compiler. (We test with gcc and clang)
+ * ZeroMQ version 4
+
+-----------------------
+GUI
+-----------------------
+
+The GUI is currently using Qt4 but watch out for an upgrade to 5. 
+
+ * Qt 4.8
+ * Qwt 6
+
+-----------------------
+Python bindings
+-----------------------
+
+ * Python > 3.6
+ * pybind11 (packaged in libs/)
+
+
+-----------------------
+Documentation
+-----------------------
+
+The documentation that you are reading now is built with 
+
+ * Doxygen (to extract C++ classes etc.)
+ * Breathe (Sphinx plugin to handle doxygen xml)
+ * Sphinx 
+
+-----------------------
+Packaged in libs/
+-----------------------
+
+ * catch2 (unit testing)
+ * rapidjson (streaming from receiver)
+ * pybind11 (python bindings)