nuZOO-COLT 0.1.1

CAEN Output Loader and Translator

CAEN Output Loader & Translator

_{Modification of photograph taken by Softeis, distributed under CC BY-SA 3.0 license.}

---

About   |   Installation   |   Quickstart   |   Contributing   |   Citations   |   License

What is COLT?

COLT is a simple python package for extracting WaveDump events into iterators from binary files, written in Rust.

COLT currently supports Wavedump 1 & 2 files, and has been tested with these digitisers

Installation

Using pip

pip install nuZOO-COLT 

From scratch

git clone https://github.com/nu-ZOO/COLT.git
cd COLT
source setup.sh

At this point, the wheel files should be generated locally:

cd target/wheels
pip install colt_version.whl

This will install COLT into the local virtual environment, which through setup.sh should be .venv.

Quickstart

With COLT initialised, write a python script like so:

import numpy as np
from nuzoo-colt import EventReader                                              #  Wavedump 1
                                                                          # \/
for evt in EventReader('/home/e78368jw/Documents/COLT/scripts/wave1.dat', "WD1"):
    print(evt)

This will output:

more events...
{'event_size': 284, 'board_id': 0, 'pattern': 0, 'board_channel': 1, 'event_counter': 9862, 'timestamp': 1232799195, 'data': array([7703, 7708, 7693, 7706, 7709, 7699, 7707, 7699, 7708, 7707, 7699,
       7706, 7703, 7710, 7699, 7702, 7704, 7702, 7707, 7704, 7702, 7702,
       7708, 7701, 7703, 7708, 7701, 7699, 7704, 7703, 7704, 7706, 7707,
       7695, 7711, 7702, 7706, 7702, 7701, 7704, 7707, 7707, 7697, 7707,
       7703, 7700, 7705, 7704, 7697, 7711, 7704, 7702, 7701, 7714, 7697,
       7705, 7705, 7706, 7708, 7702, 7711, 7701, 7711, 7699, 7706, 7702,
       7700, 7702, 7710, 7703, 7697, 7704, 7712, 7698, 7707, 7699, 7705,
       7702, 7709, 7703, 7711, 7707, 7699, 7707, 7707, 7704, 7700, 7703,
       7710, 7704, 7704, 7708, 7703, 7709, 7696, 7707, 7713, 7703, 7702,
       7706, 7708, 7698, 7707, 7704, 7703, 7709, 7707, 7707, 7698, 7709,
       7709, 7700, 7706, 7708, 7704, 7702, 7711, 7702, 7705, 7705, 7703,
       7706, 7705, 7710, 7699, 7702, 7713, 7700, 7708, 7698], dtype=uint16)}
more events...

which includes all relevant information regarding the data within each waveform.

For WaveDump 2, each iterator produces an array containing the waveforms of all channels, which needs to be separated by the user. A template for this can be seen in test_colt_WD2.py. General templates of the usage are seen in python/scripts/

To get a wheel file, there are currently two options:

• within the artifacts section of the most recently run CI.yml github workflow, found here.
• run maturin build, and a .whl file will be placed within COLT/target/wheels

Contributing

Contributions follow the standard MULE guidelines as found here

Citations

Citations have yet to be generated, please use the MULE citation found here

License

COLT uses a GPL-3.0 license. The full license is provided in LICENCE.