D. Coderre, 2018, D. Masson, 2020. Please see license in LICENSE file.
See documentation here: link
- mongodb cxx driver
- CAENVMElib v2.5+
- libblosc-dev
- liblz4-dev
- C++17-compatible compiler. Tested on gcc 7.3.0
- Driver for your CAEN PCI card
- A DAQ hardware setup (docs coming on xenon wiki)
- A MongoDB deployment you can write to
- tcl8.6-dev, and tcl-expect-dev (optional, for DDC10 support)
To build:
make
./redax --id <id> --uri <mongo_uri> [--reader | --cc ] [--db <database_name>] [--logdir <logging directory>] [--log-retention <days>] [--arm-delay <ms>] [--help]
The first argument is a unique ID that will identify your reader. This is important since your physical hardware setup needs to be associated with the software programs that will read the things out. So you probably want to map out ahead of time which reader processes will read out which optical links.
Three arguments are required. First is the ID of this instance, second is the full MongoDB URI, and third is one of 'reader' or 'cc', depending on if you want this instance to be a reader or a crate controller. Note: while this can run multiple times on a given host (one readout instance per link), it also works fine with all links in one instance (slightly better, even, because of overhead).
The ID number will create a unique process identifier for this instance of redax which appears as so: HOSTNAME_reader_ID. So if you run on host daq00 with ID 1 your process ID will be daq00_reader_1. This is the ID you use to address commands to this host.
Optionally, you can also specify the name of the database the program should look in for the various collections, where you want the log files written, how long to keep the log files around, and how long to wait between receiving an ARM command and actually beginning the arming sequence.
If you run with more than one readout process (this includes a crate controller) you should configure a dispatcher. The dispatcher handles communication with the user interface and translates human-level commands to the readout nodes. The provided example is a python script stored in the 'dispatcher' subdirectory, but is written for XENONnT, so YMMV.
At the moment the dispatcher is just a script, not an executable. So it can be run with:
python dispatcher.py --config=options.ini
The config option points to an ini file for the dispatcher. See the subdirectory for a readme detailing the options herein.
You need to provide connectivity to a mongodb database using the URI. This database should have the following collections.
control: is where commands go. Configure this as a capped or TTL collection, size approx 1MB (really not much needed). If you have no dispatcher you'll write directly to this collection, otherwise the dispatcher handles it.
status: should be configured as a capped or TTL collection. Each readout node will write its status here every second or so.
log: The DAQ will log here.
options: is where settings docs go. When sending the 'arm' command the name of the options file should be embedded in the command doc. If the reader can't find an options doc with that name it won't be able to arm the DAQ.
If you run with the dispatcher you additionally need a collection called detector_control, which will supercede control as the top-level user interface. The control collection will still be used by the dispatcher to control the readout nodes but the user should not use it in this case. If there is just one readout node you may want to skip the dispatcher and just directly control that node for simplicity.
Install all prerequisites, a mongodb database, and the redax software as described above. If you have XENON wiki access there are some build notes on the DAQ page [here](https://xe1t-wiki.lngs.infn.it/doku.php?id=xenon:xenonnt:dsg:daq#reader wiki), however if you don't have access don't worry too much since everything is straight off google searches.
Consult the documentation as linked above.
If you want to configure your status collection as capped (as well as the 'aggregate_status', which stored dispatcher state history and 'system_monitor' for use with the optional monitor script) you can run helpers/initialize_databases.py.
Hook your digitizer up via optical link to your PC. Hopefully you're using our self-triggering firmware, if not you'll have to deal with configuring an external trigger for your digitizer yourself. This example will use just one digitizer.
Start the reader process as above.