event formation unit

Unit Pembentukan Acara

Proyek ini mengimplementasikan pengolahan data kejadian detektor neutron menjadi kejadian neutron. Jalur pipa untuk pemrosesan data mentah dari Gd-GEM, Muli-Grid, Multi-Blade, SoNDe serta beberapa detektor lainnya telah diterapkan. Sebagian besar diimplementasikan dalam C/C++.

Dokumentasi

Untuk rincian lebih lanjut tentang struktur file, arsitektur, primitif lihat dokumentasi/README.md

Memulai

Repositori essdaq memiliki skrip untuk mengunduh dan mengkompilasi proyek ini secara otomatis. Ikuti instruksi untuk menyusun perangkat lunak unit pembentukan acara secara manual.

Prasyarat

Untuk membangun dan menjalankan perangkat lunak ini, diperlukan dependensi berikut.

• Conan Skrip conan harus tersedia di $PATH saat ini. Gunakan versi terbaru yang lebih kecil dari 2.
• CMake Setidaknya diperlukan CMake versi 2.8.12. Beberapa paket yang memerlukan versi CMake yang lebih baru akan mengunduh ini sebagai ketergantungan.
• bash Untuk mengatur jalur dengan benar ke dependensi yang disediakan conan.
• Kompiler C/C++ terbaru dengan dukungan untuk C++14.

Conan digunakan untuk mengunduh dependensi. Agar conan mengetahui dari mana dependensi dapat diunduh, repositori paket ecdc harus ditambahkan dengan menjalankan perintah berikut:

• conan remote add ecdc-conan-release https://artifactory.esss.lu.se/artifactory/api/conan/ecdc-conan-release

Perhatikan juga bahwa untuk fungsionalitas tambahan Anda mungkin ingin menginstal dependensi berikut secara manual:

• libpcap
• Valgrind Untuk melakukan tes penggunaan memori (dan lainnya).
• lcov/gcov/gcovr Diperlukan untuk membuat laporan cakupan.

Bangunan

Jalankan perintah berikut:

git clone https://github.com/ess-dmsc/event-formation-unit.git

cd event-formation-unit

mkdir build

cd build

cmake ..

make

Membangun di bawah Ubuntu 16

Jika menggunakan conan untuk menyediakan dependensi, opsi tambahan harus disediakan: --settings compiler.libcxx=libstdc++11 . Dengan demikian panggilan kepada conan berubah menjadi :

conan install --build=outdated .. --settings compiler.libcxx=libstdc++11

Menjalankan tes

Tes satuan

Untuk menjalankan pengujian unit untuk proyek ini, jalankan perintah berikut:

 make runtest

Tes lainnya

Dimungkinkan juga untuk mendapatkan laporan cakupan pengujian jika prasyarat yang diperlukan telah diinstal. Untuk ini, Anda harus mengaktifkan tes cakupan di makefile dengan cmake. Untuk mengaktifkan uji cakupan untuk makefile, jalankan

 cmake -DCOV=Y

Kemudian untuk mendapatkan laporan cakupan, jalankan

 make coverage

Untuk menjalankan tes kebocoran memori (menggunakan Valgrind), jalankan:

 make valgrind

Menjalankan aplikasi pembentukan acara

Contoh perintah yang diperlukan untuk menjalankan pipeline pembentukan peristiwa (dalam hal ini pipeline freia ) adalah sebagai berikut:

 make efu freia
cd bin
./efu -d ../modules/freia --nohwcheck

Catatan, Anda juga perlu menyediakan file konfigurasi untuk modul freia .

Untuk mendapatkan argumen baris perintah yang tersedia, gunakan -h atau --help . Ini juga berfungsi saat memberikan argumen modul detektor. Misalnya:

 ./efu -d ../modules/freia -h

Berkontribusi

Silakan baca file CONTRIBUTING.md untuk detail tentang kode etik kami dan proses pengajuan pull request kepada kami.

Penulis

• Morten Jagd Christensen
• Martin Shetty
• Jonas Nilsson
• Jenny Walker

Lihat juga daftar kontributor di Github.

Lisensi

Proyek ini dilisensikan di bawah Lisensi BSD-2, lihat file LISENSI untuk rinciannya.