Skutils Documentation

SkuTek Utilities or skutils is an open-source python library to control SkuTek Instrumentation’s product lines for data acquisition and data management. skutils runs on your lab computer, but controls your hardware remotely using a REST API.

---

This Documentation was built for:

Skutils version	0.2.1b0
Skutils Commit Sha	077f9664
FemtoDAQ Software Compatability	v6.0.0 or above

please note: skutils is currently in Beta. Please report any bugs, issues, or typos to support@skutek.com

Installation

Via Pip

pip install skutils

From Source

git clone https://gitlab.com/skutek/libraries/skutils.git
pip install ./skutils

A few Application Note Examples

Calibrating your Detector for Energy Response

Inspecting Individual Events During Data Collection

Testing Coincidence using a Na-22 Source

Recording and Histogramming Noise

All our published examples can be found here

Areas of interest:

Digitizer Control and Visualization

Digitizers are Data Acquisition (DAQ) hardware that digitizes analog signals and performs real-time digitial signal processing. This includes operations such pulse processing, triggering, and streaming data.

SkuTek’s Vireo and Kingfisher Digitizers can be controlled from your desktop using the FemtoDAQController class. In the following example, we connect to a Vireo digitizer connected to a computer via USB and print out some device information.

import skutils
digitizer = skutils.FemtoDAQController(skutils.FEMTODAQ_USB)
print(digitizer.summary())

Outputs

Vireo-000019 (192.168.7.2)
Product Revision    : VIREO100_REV_B
Number of Channels  : 2
Sampling Frequency  : 100.0 MHz
ADC Bitdepth        : 14 bits
Maximum Wave Length : 81.92us
Firmware Version    : 5.5.0-0
Software Version    : 5.4.0
Linux Image Version : 5.1.1

(Coming Soon) ChickdeeController

Loading Data

Tools to load, build, and visualize events from all SkuTek data formats.

1. Automatic File Loader

2. Gretina File Loader

3. Greta File Loader

4. Event CSV File Loader

5. IGOR Waveform File Loader

6. IGOR Pulse Height File Loader

7. Easy Event Plotting

Data Management

Data Management products are solutions that deal with data after digitization. This includes servers to receive digitizer data streams, event building, file handling.

1. Solidago UDP Cannon Controller

2. (Coming Soon) CollectorNodeController

Contents

• Controlling a FemtoDAQ Family Digitizer
  • FemtoDAQController
    • Connect to a Digitizer Hooked up via USB
    • Connect to a Digitizer on the Network
    • Print out Device Information
    • Changing Trigger Settings
    • Changing Pulse Height/DSP Filter Settings
    • Configuring Automatic Baseline Restoration
    • Configuring QuadQDC Integration Windows
    • Setting Bias (HV) Voltage Output
    • Setting GlobalID / Module Number
    • Setting Input Channel Analog Offsets
    • Setting Input Channel Digital Offsets
    • Inverting Input Channel ADC Signals
    • Configuring in-firmware histogramming
    • Configuring Coincidence
    • Configuring Data Recording
    • Starting/Stopping Data Collection
    • Forcing a Trigger
    • Downloading Recorded Data
    • Resetting Timestamps
    • Saving/Loading Data Collection Settings
    • Reserving your digitizer from others
• Reading & Processing Digitizer Data Files
  • Format Specifications
    • Event Comma Separated Values (Event CSV) Format
    • IGOR Wave Format
    • IGOR Pulse Height Format
    • Gretina Event Builder (GEB) Format
  • Loading Digitizer Data Files
    • Downloading Data from a FemtoDAQ Digitizer
    • Loading Data from Files
  • Working with Event Data
    • Iterating through channels in an Event
    • Waveform Data
    • Rebuilding Events
• Data Management Tools
  • SolidagoController
  • CollectorNodeController
• skutils package
  • skutils.FemtoDAQController module
    • BusyError
    • FemtoDAQController
  • skutils.Loader module
    • ChannelData
    • EventInfo
    • ChannelData
    • EventInfo
    • BaseLoader
    • EventCSVLoader
    • IGORPulseHeightLoader
    • GretinaLoader
    • IGORWaveLoader
    • quickLoad()
  • skutils.SolidagoController module
    • Stream
    • SolidagoController
  • skutils.helpers module
    • HitPatternCoincidenceBuilder
    • mac_to_num()
    • get_ip_address_of_interface()
    • get_mac_address_of_interface()
• Examples/Application Notes