-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
501 lines (481 loc) · 34.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to slsDetectorPackage’s documentation! — slsDetectorPackage documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/css/extra.css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></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="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="#" class="icon icon-home">
slsDetectorPackage
</a>
<div class="version">
0.0.0
</div>
<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>
<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="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="#">slsDetectorPackage</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="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to slsDetectorPackage’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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="welcome-to-slsdetectorpackage-s-documentation">
<h1>Welcome to slsDetectorPackage’s documentation!<a class="headerlink" href="#welcome-to-slsdetectorpackage-s-documentation" title="Permalink to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is the documentation for the latest development version of slsDetectorPackage.
For further documentation, visit the official page: <a class="reference external" href="https://www.psi.ch/en/detectors/documentation">https://www.psi.ch/en/detectors/documentation</a></p>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#install-binaries-using-conda">Install binaries using conda</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#build-from-source">Build from source</a><ul>
<li class="toctree-l3"><a class="reference internal" href="installation.html#download-source-code-from-github">1. Download Source Code from github</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-from-source-using-cmake">2. Build from Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-using-cmake">Build using CMake</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-using-in-built-cmk-sh-script">Build using in-built cmk.sh script</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-on-old-distributions">Build on old distributions</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-slsdetectorgui-qt5">Build slsDetectorGui (Qt5)</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#build-this-documentation">Build this documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#pybind-and-zeromq">Pybind and Zeromq</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#core">Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#python-bindings">Python bindings</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#zeromq">ZeroMQ</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#gui">GUI</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#moench-executables">Moench executables</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#packaged-in-libs">Packaged in libs/</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="consuming.html#cmake-slsdetectorpackage-as-submodule-in-your-project">CMake: slsDetectorPackage as submodule in your project</a></li>
<li class="toctree-l2"><a class="reference internal" href="consuming.html#cmake-find-package-slsdetectorpackage">CMake: find_package(slsDetectorPackage)</a></li>
<li class="toctree-l2"><a class="reference internal" href="consuming.html#cmake-find-package-and-conda">CMake: find_package and conda</a></li>
<li class="toctree-l2"><a class="reference internal" href="consuming.html#no-tools-minimal-approach">No tools minimal approach</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#compile-examples">Compile examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#running-a-config-file-e1">Running a config file [e1]</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#using-the-return-type-sls-result-e2">Using the return type sls::Result [e2]</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#setting-exposure-time-e3">Setting exposure time [e3]</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#which-python">Which Python?</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#building-from-source">Building from Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#pythonpath">PYTHONPATH</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#which-detector-class-should-i-use">Which detector class should I use?</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#hey-there-seems-to-be-two-apis">Hey, there seems to be two APIs?</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#finding-functions">Finding functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#finding-out-what-the-function-does">Finding out what the function does</a></li>
<li class="toctree-l2"><a class="reference internal" href="pygettingstarted.html#where-are-the-enums">Where are the ENUMs?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pydetector.html">Detector</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pydetector.html#slsdet.Detector"><code class="docutils literal notranslate"><span class="pre">Detector</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyenums.html">Enums</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.runStatus"><code class="docutils literal notranslate"><span class="pre">runStatus</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.detectorType"><code class="docutils literal notranslate"><span class="pre">detectorType</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.frameDiscardPolicy"><code class="docutils literal notranslate"><span class="pre">frameDiscardPolicy</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.fileFormat"><code class="docutils literal notranslate"><span class="pre">fileFormat</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.dimension"><code class="docutils literal notranslate"><span class="pre">dimension</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.externalSignalFlag"><code class="docutils literal notranslate"><span class="pre">externalSignalFlag</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.timingMode"><code class="docutils literal notranslate"><span class="pre">timingMode</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.dacIndex"><code class="docutils literal notranslate"><span class="pre">dacIndex</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.detectorSettings"><code class="docutils literal notranslate"><span class="pre">detectorSettings</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.clockIndex"><code class="docutils literal notranslate"><span class="pre">clockIndex</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.speedLevel"><code class="docutils literal notranslate"><span class="pre">speedLevel</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.readoutMode"><code class="docutils literal notranslate"><span class="pre">readoutMode</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.burstMode"><code class="docutils literal notranslate"><span class="pre">burstMode</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.timingSourceType"><code class="docutils literal notranslate"><span class="pre">timingSourceType</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.M3_GainCaps"><code class="docutils literal notranslate"><span class="pre">M3_GainCaps</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.portPosition"><code class="docutils literal notranslate"><span class="pre">portPosition</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.streamingInterface"><code class="docutils literal notranslate"><span class="pre">streamingInterface</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.vetoAlgorithm"><code class="docutils literal notranslate"><span class="pre">vetoAlgorithm</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pyenums.html#slsdet.gainMode"><code class="docutils literal notranslate"><span class="pre">gainMode</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyexamples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#setting-exposure-time">Setting exposure time</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#converting-numbers-to-hex">Converting numbers to hex</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#simple-threshold-scan">Simple threshold scan</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#reading-temperatures">Reading temperatures</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#non-blocking-acquire">Non blocking acquire</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#setting-and-getting-times">Setting and getting times</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyexamples.html#reading-dacs">Reading dacs</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#help">Help</a></li>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#commands">Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#deprecated-commands">Deprecated commands</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#detector">Detector</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#receiver">Receiver</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#client">Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#gui">Gui</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#eiger">Eiger</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#jungfrau">Jungfrau</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#gotthard-i">Gotthard I</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#mythen-iii">Mythen III</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#gotthard-ii">Gotthard II</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#moench">Moench</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#ctb">Ctb</a></li>
<li class="toctree-l2"><a class="reference internal" href="firmware.html#firmware-troubleshooting-with-blackfin">Firmware Troubleshooting with blackfin</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="servers.html#location">Location</a></li>
<li class="toctree-l2"><a class="reference internal" href="servers.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="servers.html#automatic-start">Automatic start</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="serverupgrade.html">Upgrade</a><ul>
<li class="toctree-l2"><a class="reference internal" href="serverupgrade.html#no-tftp-required">6.1.1+ (no tftp required)</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverupgrade.html#id1">5.0.0 - 6.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverupgrade.html#id2">< 5.0.0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="virtualserver.html">Simulators</a><ul>
<li class="toctree-l2"><a class="reference internal" href="virtualserver.html#compilation">Compilation</a></li>
<li class="toctree-l2"><a class="reference internal" href="virtualserver.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="virtualserver.html#client">Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="virtualserver.html#receivers">Receivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="virtualserver.html#gui">Gui</a></li>
<li class="toctree-l2"><a class="reference internal" href="virtualserver.html#limitations">Limitations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="serverdefaults.html">Default Values</a><ul>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#mythen3">Mythen3</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#gotthard2">Gotthard2</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#moench">Moench</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#ctb">Ctb</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#eiger">Eiger</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#jungfrau">Jungfrau</a></li>
<li class="toctree-l2"><a class="reference internal" href="serverdefaults.html#gotthard">Gotthard</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="udpheader.html#current-version">Current Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpheader.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpheader.html#detector-enum">Detector Enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpheader.html#previous-versions">Previous Versions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="udpconfig.html">Config file</a><ul>
<li class="toctree-l2"><a class="reference internal" href="udpconfig.html#source-port">Source Port</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpconfig.html#udp-srcip-source-ip">udp_srcip - Source IP</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpconfig.html#udp-srcmac-source-mac">udp_srcmac - Source MAC</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpconfig.html#udp-dstport-desintation-port">udp_dstport - Desintation Port</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpconfig.html#udp-dstip-destination-ip">udp_dstip - Destination IP</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpconfig.html#udp-dstmac-destination-mac">udp_dstmac - Destination MAC</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="udpdetspec.html">Detector Specific Fields</a><ul>
<li class="toctree-l2"><a class="reference internal" href="udpdetspec.html#eiger">Eiger</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpdetspec.html#jungfrau">Jungfrau</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpdetspec.html#gotthard2">Gotthard2</a></li>
<li class="toctree-l2"><a class="reference internal" href="udpdetspec.html#mythen3">Mythen3</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="receivers.html#custom-receiver">Custom Receiver</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="slsreceiver.html">slsReceiver/ slsMultiReceiver</a><ul>
<li class="toctree-l2"><a class="reference internal" href="slsreceiver.html#client-commands">Client Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="slsreceiver.html#performance">Performance</a></li>
<li class="toctree-l2"><a class="reference internal" href="slsreceiver.html#using-callbacks">Using Callbacks</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="fileformat.html#number-of-files">Number of Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="fileformat.html#naming">Naming</a></li>
<li class="toctree-l2"><a class="reference internal" href="fileformat.html#formats">Formats</a></li>
</ul>
</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><ul>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#eiger">Eiger</a></li>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#jungfrau">Jungfrau</a></li>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#gotthard-ii">Gotthard II</a></li>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#mythen3">Mythen3</a></li>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#moench">Moench</a></li>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#gotthard-i">Gotthard I</a></li>
<li class="toctree-l2"><a class="reference internal" href="masterfileattributes.html#chip-test-board">Chip Test Board</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="binaryfileformat.html">Binary File Format</a><ul>
<li class="toctree-l2"><a class="reference internal" href="binaryfileformat.html#master-file">Master File</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryfileformat.html#data-file">Data File</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryfileformat.html#json-master-file-examples">JSON Master File Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#eiger">Eiger</a></li>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#jungfrau">Jungfrau</a></li>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#gotthard2">Gotthard2</a></li>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#mythen3">Mythen3</a></li>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#moench">Moench</a></li>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#gotthard-i">Gotthard I</a></li>
<li class="toctree-l3"><a class="reference internal" href="binaryfileformat.html#chip-test-board">Chip Test Board</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hdf5fileformat.html">HDF5 File Format</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hdf5fileformat.html#compilation">Compilation</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf5fileformat.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf5fileformat.html#master-file">Master File</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf5fileformat.html#data-file">Data File</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf5fileformat.html#virtual-data-file">Virtual Data File</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#common">Common</a><ul>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#total-failure-of-packet-delivery">1. Total Failure of Packet Delivery</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#partial-or-random-packet-loss-performance">2. Partial or Random Packet Loss (Performance)</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#receiver-pc-tuning-options">Receiver PC Tuning Options</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#slsreceiver-tuning">slsReceiver Tuning</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#shared-memory-error">Shared memory error</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#cannot-connect-to-detector">Cannot connect to detector</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#cannot-connect-to-receiver">Cannot connect to receiver</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#receiver-cannot-bind-socket">Receiver: cannot bind socket</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#cannot-get-multi-module-data">Cannot get multi module data</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#cannot-ping-module-nios">Cannot ping module (Nios)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#gotthard2">Gotthard2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#cannot-get-data-without-a-module-attached">Cannot get data without a module attached</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#gotthard">Gotthard</a><ul>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#missing-first-frame-or-next-frame-after-a-delay">Missing first frame or next frame after a delay</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#mythen3">Mythen3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#detector-status-is-waiting-even-in-auto-timing-mode">Detector status is waiting even in auto timing mode</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#jungfrau">Jungfrau</a><ul>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#temperature-event-occured">Temperature event occured</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#jungfrau-troubleshooting-power-supply">Cannot get multi module data</a></li>
<li class="toctree-l3"><a class="reference internal" href="troubleshooting.html#cannot-stop-slaves-in-sync-mode">Cannot stop slaves in sync mode</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" 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>