View on GitHub

EUDAQ

a generic data acquisition framework

Basic Installation

In order to use and run EUDAQ, we recommend to use a stable release!

Download the zip file or clone the repository to stay up-to-date, just follow these steps:

git clone https://github.com/eudaq/eudaq.git eudaq 

In order to get the latest release version, list all releases and switch to the latest one (here e.g. v2.1.0):

git tag 
git checkout v2.1.0

For installation, execute these steps:

cd eudaq/build
cmake ..
make install

Detailed installation: Please have a look at the README.md included in the source code or the EUDAQ user manual (see below).

Versions and development

There are two EUDAQ versions: 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 usually with a TLU providing a global trigger-busy handshake communication. EUDAQ 2 additionally provides distributed data taking by using multiple data collectors. The synchronisation happens by trigger IDs in each data stream or by timestamps provided by a common clock. For this options a TLU has to provide a individual trigger-busy handshake communication or a common clock to the device-DAQs.

There are two development branches which are used for new commits: master for version 2 and v1.7-dev 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.

User Manual

You can generate the pdf manual from the LaTeX sources included in EUDAQ:

cd build
cmake -DEUDAQ_BUILD_MANUAL=ON ..
make pdf

Afterwards, the manual can then be found in eudaq/build/doc/manual/EUDAQUserManual.pdf

Find here the compiled version of the EUDAQ user manual: v2.0 or v1.7

Doxygen Source Code Documentation

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:

cd build
cmake ..
make doxygen

The resulting HTML files are stored in eudaq/doc/doxygen/html.

Find here a generated version of the code documentation .

Support and Bug Tracker

Having trouble with EUDAQ or found a bug? Please report it on the EUDAQ issue tracker and we'll try to sort it out!