mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-01-20 23:18:52 +01:00
265 lines
12 KiB
HTML
265 lines
12 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Dependencies — slsDetectorPackage 9.2.0 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/extra.css?v=2be88464" />
|
|
|
|
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="Consuming slsDetectorPackage" href="consuming.html" />
|
|
<link rel="prev" title="Installation" href="installation.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
slsDetectorPackage 9.2.0
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Installation:</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Dependencies</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#core">Core</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#python-bindings">Python bindings</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#zeromq">ZeroMQ</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#gui">GUI</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#moench-executables">Moench executables</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#packaged-in-libs">Packaged in libs/</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">C++ API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="detector.html">Detector</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="result.html">Result</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="receiver_api.html">Receiver</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="pygettingstarted.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pydetector.html">Detector</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pyenums.html">Enums</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pyexamples.html">Examples</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Command line</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line interface</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Developer</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="container_utils.html">ContainerUtils</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="type_traits.html">TypeTraits</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ToString.html">ToString</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Firmware</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="firmware.html">Firmware Upgrade</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Detector Server</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="servers.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="serverupgrade.html">Upgrade</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="virtualserver.html">Simulators</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="serverdefaults.html">Default Values</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Detector UDP Header</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="udpheader.html">Format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="udpconfig.html">Config file</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="udpdetspec.html">Detector Specific Fields</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Receiver</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="slsreceiver.html">In-built Receiver</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="receivers.html">Custom Receiver</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Receiver Files</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="fileformat.html">File format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="slsreceiverheaderformat.html">SLS Receiver Header Format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="masterfileattributes.html">Master File Attributes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Receiver ZMQ Stream</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="zmqjsonheaderformat.html">ZMQ: Json Header Format</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Troubleshooting</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">slsDetectorPackage 9.2.0</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">Dependencies</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/dependencies.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="dependencies">
|
|
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading"></a></h1>
|
|
<p>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.</p>
|
|
<section id="core">
|
|
<h2>Core<a class="headerlink" href="#core" title="Link to this heading"></a></h2>
|
|
<p>To use the basic building blocks, meaning sls_detector_get/put and
|
|
the shared libraries these are needed:</p>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>Linux, preferably recent kernel (currently no cross platform support)</p></li>
|
|
<li><p>CMake >= 3.14</p></li>
|
|
<li><p>C++11 compatible compiler. (We test with gcc and clang)</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
</section>
|
|
<section id="python-bindings">
|
|
<h2>Python bindings<a class="headerlink" href="#python-bindings" title="Link to this heading"></a></h2>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>Python >= 3.8</p></li>
|
|
<li><p>pybind11 2.13.6 (packaged in libs)</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Refer <a class="reference internal" href="installation.html#pybind-for-different-slsdetectorpackage-versions"><span class="std std-ref">pybind11 notes.</span></a></p>
|
|
</div>
|
|
</section>
|
|
<section id="zeromq">
|
|
<h2>ZeroMQ<a class="headerlink" href="#zeromq" title="Link to this heading"></a></h2>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>Zeromq 4.3.4 (packaged in libs)</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Refer <a class="reference internal" href="installation.html#zeromq-for-different-slsdetectorpackage-versions"><span class="std std-ref">zeromq notes.</span></a></p>
|
|
</div>
|
|
</section>
|
|
<section id="gui">
|
|
<h2>GUI<a class="headerlink" href="#gui" title="Link to this heading"></a></h2>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>Qt 5.9</p></li>
|
|
<li><p>Qwt 6.1.5 (packaged in libs)</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
</section>
|
|
<section id="moench-executables">
|
|
<h2>Moench executables<a class="headerlink" href="#moench-executables" title="Link to this heading"></a></h2>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>libtiff</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
</section>
|
|
<section id="documentation">
|
|
<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h2>
|
|
<p>The documentation that you are reading now is built with</p>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>Doxygen (to extract C++ classes etc.)</p></li>
|
|
<li><p>Breathe (Sphinx plugin to handle doxygen xml)</p></li>
|
|
<li><p>Sphinx with sphinx_rtd_theme</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
</section>
|
|
<section id="packaged-in-libs">
|
|
<h2>Packaged in libs/<a class="headerlink" href="#packaged-in-libs" title="Link to this heading"></a></h2>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p>catch2 (unit testing)</p></li>
|
|
<li><p>rapidjson (streaming from receiver)</p></li>
|
|
<li><p>pybind11 (python bindings)</p></li>
|
|
<li><p>qwt (gui plotting)</p></li>
|
|
<li><p>libzmq (streaming to/from receiver)</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="consuming.html" class="btn btn-neutral float-right" title="Consuming slsDetectorPackage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020, PSD Detector Group.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |