mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-01-21 06:34:32 +01:00
cleaned up gh-pages moved stuff from devdoc
This commit is contained in:
320
9.0.0/quick_start_guide.html
Normal file
320
9.0.0/quick_start_guide.html
Normal file
@@ -0,0 +1,320 @@
|
||||
|
||||
|
||||
<!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>Quick Start Guide — slsDetectorPackage 9.0.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="ContainerUtils" href="container_utils.html" />
|
||||
<link rel="prev" title="Command line interface" href="commandline.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.0.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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></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 class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line interface</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quick Start Guide</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#detector">Detector</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#receiver">Receiver</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#client">Client</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#sample-config-file">Sample Config file</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#gui">Gui</a></li>
|
||||
</ul>
|
||||
</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="receivers.html">Receivers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="slsreceiver.html">slsReceiver/ slsMultiReceiver</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.0.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">Quick Start Guide</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/quick_start_guide.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="quick-start-guide">
|
||||
<h1>Quick Start Guide<a class="headerlink" href="#quick-start-guide" title="Link to this heading"></a></h1>
|
||||
<section id="detector">
|
||||
<h2>Detector<a class="headerlink" href="#detector" title="Link to this heading"></a></h2>
|
||||
<p>Start up detector (with cooling if required). Ensure both control server and stop server is running on-board.</p>
|
||||
<p>Or use a detector simulator to test. Click <a class="reference internal" href="virtualserver.html#virtual-detector-servers"><span class="std std-ref">here</span></a> for further instructions.</p>
|
||||
</section>
|
||||
<section id="receiver">
|
||||
<h2>Receiver<a class="headerlink" href="#receiver" title="Link to this heading"></a></h2>
|
||||
<div class="line-block">
|
||||
<div class="line">One has to start the slsReceiver before loading config file or using any receiver commands (prefix: <strong>rx_</strong> )</div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt>For a Single Module</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># default port 1954</span>
|
||||
slsReceiver
|
||||
|
||||
<span class="c1"># custom port 2012</span>
|
||||
slsReceiver<span class="w"> </span>-t2012
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
<dt>For Multiple Modules</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]</span>
|
||||
slsMultiReceiver<span class="w"> </span><span class="m">2012</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">0</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="client">
|
||||
<h2>Client<a class="headerlink" href="#client" title="Link to this heading"></a></h2>
|
||||
<p>Refer <a class="reference internal" href="#sample-config-file"><span class="std std-ref">Sample Config file</span></a> to create config file.</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># load config file</span>
|
||||
sls_detector_put<span class="w"> </span>config<span class="w"> </span>/path/sample.config
|
||||
|
||||
<span class="c1"># set number of frames</span>
|
||||
sls_detector_put<span class="w"> </span>frames<span class="w"> </span><span class="m">5</span>
|
||||
|
||||
<span class="c1"># acquire</span>
|
||||
sls_detector_acquire
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="sample-config-file">
|
||||
<span id="id1"></span><h3>Sample Config file<a class="headerlink" href="#sample-config-file" title="Link to this heading"></a></h3>
|
||||
<p>There are sample config files for each detector in slsDetectorPackage/examples folder.</p>
|
||||
<dl>
|
||||
<dt>For a Single Module</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># connects to module</span>
|
||||
hostname<span class="w"> </span>bchipxxx
|
||||
|
||||
<span class="c1"># connects to receiver at default port</span>
|
||||
rx_hostname<span class="w"> </span>mpc1922
|
||||
<span class="c1"># or to connect to specific port</span>
|
||||
<span class="c1"># rx_hostname mpc1922:2012</span>
|
||||
|
||||
<span class="c1"># sets destination udp ports (not needed, default is 50001)</span>
|
||||
udp_dstport<span class="w"> </span><span class="m">50012</span>
|
||||
|
||||
<span class="c1"># 1g data out</span>
|
||||
<span class="c1"># source udp ips must be same subnet at destintaion udp ips</span>
|
||||
<span class="c1"># udp_srcip 192.168.1.112</span>
|
||||
<span class="c1"># destination udp ip picked up from rx_hostname (if auto)</span>
|
||||
<span class="c1"># udp_dstip auto</span>
|
||||
|
||||
<span class="c1"># 10g data out</span>
|
||||
udp_srcip<span class="w"> </span><span class="m">10</span>.30.20.200
|
||||
udp_dstip<span class="w"> </span><span class="m">10</span>.30.20.6
|
||||
|
||||
<span class="c1"># set file path</span>
|
||||
fpath<span class="w"> </span>/tmp
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
<dt>For a Single Module with custom Receiver (not slsReceiver)</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># connects to module</span>
|
||||
hostname<span class="w"> </span>bchipxxx
|
||||
|
||||
<span class="c1"># sets destination udp ports (not needed, default is 50001)</span>
|
||||
udp_dstport<span class="w"> </span><span class="m">50012</span>
|
||||
|
||||
<span class="c1"># source udp ips must be same subnet at destintaion udp ips</span>
|
||||
udp_srcip<span class="w"> </span><span class="m">192</span>.168.1.112
|
||||
|
||||
<span class="c1"># destination udp ip</span>
|
||||
udp_dstip<span class="w"> </span><span class="m">192</span>.168.1.100
|
||||
|
||||
<span class="c1"># source udp mac</span>
|
||||
udp_srcmac<span class="w"> </span>aa:bb:cc:dd:ee:ff
|
||||
|
||||
<span class="c1"># destination udp mac</span>
|
||||
udp_dstmac<span class="w"> </span>3c:ab:98:bf:50:60
|
||||
|
||||
<span class="c1"># set file path</span>
|
||||
fpath<span class="w"> </span>/tmp
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
<dt>For Multiple Modules</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># connects to mulitple modules</span>
|
||||
hostname<span class="w"> </span>bchipxxx+bchipyyy+
|
||||
|
||||
<span class="c1"># tcp port increases for each module (multi detector command)</span>
|
||||
rx_tcpport<span class="w"> </span><span class="m">2012</span>
|
||||
|
||||
<span class="c1"># connects to receivers at ports 2012 and 2014</span>
|
||||
rx_hostname<span class="w"> </span>mpc1922
|
||||
|
||||
<span class="c1"># increasing udp ports (multi detector command)</span>
|
||||
udp_dstport<span class="w"> </span><span class="m">50012</span>
|
||||
|
||||
<span class="c1"># source udp ips must be same subnet at destintaion udp ips</span>
|
||||
<span class="m">0</span>:udp_srcip<span class="w"> </span><span class="m">192</span>.168.1.112
|
||||
<span class="m">1</span>:udp_srcip<span class="w"> </span><span class="m">192</span>.168.1.114
|
||||
|
||||
<span class="c1"># destination udp ip picked up from rx_hostname (if auto)</span>
|
||||
udp_dstip<span class="w"> </span>auto
|
||||
|
||||
<span class="c1"># set file path</span>
|
||||
fpath<span class="w"> </span>/tmp
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</section>
|
||||
<section id="gui">
|
||||
<h2>Gui<a class="headerlink" href="#gui" title="Link to this heading"></a></h2>
|
||||
<p>Compile with SLS_USE_GUI=ON in cmake or -g option in cmk.sh script. One can also just use the conda binary. Refer <a class="reference internal" href="installation.html#installation"><span class="std std-ref">installation instructions</span></a>.</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>slsDetectorGui
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<div class="line-block">
|
||||
<div class="line">The streaming high water mark (commmand: rx_zmqhwm) and the receiving high water mark (command: zmqhwm) is by default the lib zmq’s default (currently 1000).</div>
|
||||
<div class="line">At Gui startup, these values are set to 2. Hence, for very fast detectors, many frames will be dropped to be able to view the latest in the gui.</div>
|
||||
<div class="line">One can still change this setting in the gui in the Plot tab (ZMQ Streaming), from the command line or API.</div>
|
||||
<div class="line">Both hwm’s can be set to a -1 to use the lib’s default.</div>
|
||||
<div class="line">Since the dummy end of acquisition packet streamed from receiver might also be lost, receiver restreams until gui acknowledges.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="commandline.html" class="btn btn-neutral float-left" title="Command line interface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="container_utils.html" class="btn btn-neutral float-right" title="ContainerUtils" 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>
|
||||
Reference in New Issue
Block a user