This project implements processing of neutron detector event data into neutron events. Pipelines for processing of raw data from Gd-GEM, Muli-Grid, Multi-Blade, SoNDe as well as a few other detectors have been implemented. Mostly implemented in C/C++.
For more details on the file structure, architecture, primitives see documentation/README.md
The essdaq repository has scripts for automatically downloading and compiling this project. Instructions for manually compiling the event formation unit software follow.
To build and run this software the following dependencies are required.
- Conan The conan script has to be available in the current
$PATH. Use the latest version smaller than 2. - CMake At least CMake version 2.8.12 is required. Some packages that requires more recent versions of CMake will download this as a dependency.
- bash For properly setting paths to the conan provided dependencies.
- A recent C/C++ compiler with support for C++14.
Note also that for additional functionality, you might want to install the following dependencies manually:
- libpcap —Network monitoring
- Valgrind — Memory usage (and other) tests
- gcovr, lcov, and gcov — Generate coverage reports
Conan is a Python package used to download dependencies. To install the latest version smaller than 2, run
pip install "conan<2"
and ensure that the directory conatining the conan executable has been added to your path.
For conan to know where the dependencies can be downloaded from, the ECDC package repository must be added by running the following command
conan remote add ecdc-conan-release https://artifactory.esss.lu.se/artifactory/api/conan/ecdc-conan-release
Run the following commands:
git clone https://github.com/ess-dmsc/event-formation-unit.git
cd event-formation-unit
mkdir build
cd build
cmake ..
make
Note, by utilizing several processors, you can speed up the build process by running parallel compiler jobs. You do this by passing the -j option to make. For example, to launch eight parallel jobs run make as
make -j 8
The total number of available processors on can be queried by calling the nproc command. To use all available processors, run make like this
make -j $(nproc)
Wen using conan to provide the dependencies, an extra option has to be provided:
--settings compiler.libcxx=libstdc++11. Thus the call to conan turns into:
conan install --build=outdated .. --settings compiler.libcxx=libstdc++11
To run the unit tests for this project, run the following commands:
make runtest
It is also possible to get a test coverage report if the required prerequisites have been installed. For this you have to enable coverage test in the makefile with cmake. To enable coverage test for makefiles, run
cmake -DCOV=Y
Then to get the coverage report, run
make coverage
To run a memory leak test (using Valgrind), run:
make valgrind
Doxygen documentation for the EFU C++ classes can be build by running
make doxygen
After the documentation has been build, the doxygen documentation tree can be accesed in the cmake build directory, by opening the file doxygen/html/index.html.
An example of the commands required to run an event formation pipeline (in this case the freia pipeline) follows:
make efu freia
cd bin
./efu -d ../modules/freia --nohwcheck
Note you will need to provide a config file in the case of the freia module as well.
To get the available command line arguments, use -h or --help. This works when providing a detector module argument as well. For example:
./efu -d ../modules/freia -h
Please read the CONTRIBUTING.md file for details on our code of conduct and the process for submitting pull requests to us.
- Morten Jagd Christensen
- Martin Shetty
- Jonas Nilsson
- Jenny Walker
See also the list of contributors on Github.
This project is licensed under the BSD-2 License see the LICENSE file for details.