-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
103 lines (79 loc) · 4.63 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
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8' />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<meta name="description" content="EUDAQ : a generic data acquisition framework" />
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>EUDAQ</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/eudaq">View on GitHub</a>
<h1 id="project_title">EUDAQ</h1>
<h2 id="project_tagline">a generic data acquisition framework</h2>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h3>
<a name="basic-installation-instructions" class="anchor" href="#basic-installation-instructions"><span class="octicon octicon-link"></span></a>Basic Installation</h3>
<p>In order to use and run EUDAQ, we recommend to use <a href="https://github.com/eudaq/eudaq/releases">a stable release!</a></p>
<p>Download the zip file or clone the repository to stay up-to-date, just follow these steps:</p>
<pre><code>git clone https://github.com/eudaq/eudaq.git eudaq </code></pre>
<p>In order to get the latest release version, list all releases and switch to the latest one (here e.g. v2.2.0):</p>
<pre><code>git tag
git checkout v2.2.0
</code></pre>
<p>For installation, execute these steps:</p>
<pre><code>cd eudaq/build
cmake ..
make install
</code></pre>
<p>Detailed installation: Please have a look at the <a href="https://github.com/eudaq/eudaq/blob/master/README.md">README.md</a> included in the source code or the EUDAQ user manual (see below).</p>
<h3>
<a name="versions-development" class="anchor" href="#versions-development"><span class="octicon octicon-link"></span></a>Version 1 and 2 and development</h3>
<p>EUDAQ 1 is based on one central data collector providing an event definition by associating one trigger to one read-out of each sub-detector.
This comes with a (EUDET or AIDA) TLU providing a global trigger-busy handshake communication. </p>
<p>EUDAQ 2 comes with feature updates: This version additionally provides distributed data taking by using multiple data collectors.
The synchronisation can also performed by trigger IDs or by timestamps provided by a common clock.
For these new options the TLU has to provide a individual trigger-busy handshake communication or a common clock to the device-DAQs.</p>
<p>There are two development branches which are used for new commits:
<code>master</code> for version 2 and <code>v1.x-dev</code> for version 1.
The development for version 1 reduces mainly to bug fixes and anhancements, the development of new functionalities and features will happen on the master-branch.</p>
<h3>
<a name="users-manual" class="anchor" href="#users-manual"><span class="octicon octicon-link"></span></a>User Manual</h3>
<p>You can generate the pdf manual from the LaTeX sources included in EUDAQ:</p>
<pre><code>cd build
cmake -DEUDAQ_BUILD_MANUAL=ON ..
make pdf
</code></pre>
<p>Afterwards, the manual can then be found in <code>eudaq/build/doc/manual/EUDAQUserManual.pdf</code></p>
<p>Find here the compiled version of the EUDAQ user manual: <a href="http://eudaq.github.io/manual/EUDAQUserManual_v2_0_1.pdf">v2.0</a>
or <a href="http://eudaq.github.io/manual/EUDAQUserManual_v1.pdf">v1.7</a></p>
<h3>
<a name="doxygen-source-code-documentation" class="anchor" href="#doxygen-source-code-documentation"><span class="octicon octicon-link"></span></a>Doxygen Source Code Documentation</h3>
<p>To be checked/updated for version 2!</p>
<p>You can generate a html doxygen documentation from the source code itself, which describes the used namespaces, classes and file hierarchy of the EUDAQ code:</p>
<pre><code>cd build
cmake ..
make doxygen
</code></pre>
<p>The resulting HTML files are stored in <code>eudaq/doc/doxygen/html</code>.</p>
<p>Find here a generated version of the <a href="http://eudaq.github.io/doxygen/index.html">code documentation </a>.</p>
<h3>
<a name="support-and-bug-tracker" class="anchor" href="#support-and-bug-tracker"><span class="octicon octicon-link"></span></a>Support and Bug Tracker</h3>
<p>Having trouble with EUDAQ or found a bug? Please report it on the <a href="https://github.com/eudaq/eudaq/issues">EUDAQ issue tracker</a> and we'll try to sort it out!</p>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>