Skip to content

Commit

Permalink
small documentaiton info for moenchzmq conda package
Browse files Browse the repository at this point in the history
  • Loading branch information
thattil committed Dec 5, 2024
1 parent 8e78067 commit ee2e297
Show file tree
Hide file tree
Showing 39 changed files with 45 additions and 41 deletions.
2 changes: 1 addition & 1 deletion ToString.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 2 additions & 0 deletions _sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ We have three different packages available:
conda search slsdet
# gui
conda search slsdetgui
# moench
conda search moenchzmq
Expand Down
2 changes: 1 addition & 1 deletion binaryfileformat.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion commandline.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion consuming.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion container_utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion dependencies.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
10 changes: 5 additions & 5 deletions detector.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -153,7 +153,7 @@ <h1>Detector<a class="headerlink" href="#detector" title="Permalink to this head
<p>Most, if not all, functions are called in parallel
and the return value is a thin std::vector wrapper
containing results from all modules. (<a class="reference internal" href="result.html#result-class"><span class="std std-ref">Result class</span></a>)</p>
<p>Here are some <a class="reference internal" href="examples.html#cplusplus-api-examples"><span class="std std-ref">examples</span></a> on how to use the API.</p>
<p>Here are some <a class="reference internal" href="#cplusplus-api-examples"><span class="std std-ref">examples</span></a> on how to use the API.</p>
<span class="target" id="cplusplus-api-examples"></span><dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N3sls8DetectorE">
<span id="_CPPv3N3sls8DetectorE"></span><span id="_CPPv2N3sls8DetectorE"></span><span id="sls::Detector"></span><span class="target" id="classsls_1_1Detector"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Detector</span></span></span><a class="headerlink" href="#_CPPv4N3sls8DetectorE" title="Permalink to this definition"></a><br /></dt>
Expand Down Expand Up @@ -2090,7 +2090,7 @@ <h1>Detector<a class="headerlink" href="#detector" title="Permalink to this head
<dd><p><p>[Jungfrau] Advanced</p>
<p>Only for chipv1.0. Options: 0 - 15. Default: 0.</p>

The #images = #frames x #triggers x (#storagecells + 1) </p>
The images = #frames x #triggers x (storagecells + 1) </p>
</dd></dl>

<dl class="cpp function">
Expand Down Expand Up @@ -2163,8 +2163,8 @@ <h1>Detector<a class="headerlink" href="#detector" title="Permalink to this head
<dt class="sig sig-object cpp" id="_CPPv4N3sls8Detector15setPedestalModeEKN4defs18pedestalParametersE9Positions">
<span id="_CPPv3N3sls8Detector15setPedestalModeEKN4defs18pedestalParametersE9Positions"></span><span id="_CPPv2N3sls8Detector15setPedestalModeEKN4defs18pedestalParametersE9Positions"></span><span id="sls::Detector::setPedestalMode__defs::pedestalParametersC.Positions"></span><span class="target" id="classsls_1_1Detector_1a8c26563e5ca9ccf8e5a8e4ab2691059b"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setPedestalMode</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">defs</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pedestalParameters</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">par</span></span>, <span class="n"><span class="pre">Positions</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">pos</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3sls8Detector15setPedestalModeEKN4defs18pedestalParametersE9Positions" title="Permalink to this definition"></a><br /></dt>
<dd><p><p>[Jungfrau] In pedestal mode, the number of frames or triggers is overwritten by</p>
<p>(#pedestal_frames x #pedestal_loops x 2). \nIn auto timing mode or in trigger mode with #frames &gt; 1, #frames is overwritten and #triggers = 1, \nelse #triggers is overwritten and #frames = 1. One cannot set #frames, #triggers or timing mode in pedestal mode (it will throw an exception). Disabling pedestal mode will set back the original values of #frames and #triggers</p>
</p>
<p>(</p>
pedestal_frames x pedestal_loops x 2). \nIn auto timing mode or in trigger mode with #frames &gt; 1, #frames is overwritten and #triggers = 1, \nelse #triggers is overwritten and #frames = 1. One cannot set #frames, #triggers or timing mode in pedestal mode (it will throw an exception). Disabling pedestal mode will set back the original values of #frames and #triggers </p>
</dd></dl>

<dl class="cpp function">
Expand Down
2 changes: 1 addition & 1 deletion examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion fileformat.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion firmware.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion hdf5fileformat.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 3 additions & 1 deletion installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -201,6 +201,8 @@ <h2>Install binaries using conda<a class="headerlink" href="#install-binaries-us
conda<span class="w"> </span>search<span class="w"> </span>slsdet
<span class="c1"># gui</span>
conda<span class="w"> </span>search<span class="w"> </span>slsdetgui
<span class="c1"># moench</span>
conda<span class="w"> </span>search<span class="w"> </span>moenchzmq
</pre></div>
</div>
</section>
Expand Down
2 changes: 1 addition & 1 deletion masterfileattributes.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion pydetector.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion pyenums.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion pyexamples.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion pygettingstarted.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion quick_start_guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion receiver_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion receivers.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion result.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion serverdefaults.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion servers.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion serverupgrade.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion slsreceiver.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion slsreceiverheaderformat.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion type_traits.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion udpconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion udpdetspec.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion udpheader.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion virtualserver.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion zmqjsonheaderformat.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
slsDetectorPackage
</a>
<div class="version">
9.0.0
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down

0 comments on commit ee2e297

Please sign in to comment.