Quick Start Guide¶

Start here: Try the example above with your own data
Explore demos: Find the demo matching your use case
Read API docs: Deep dive into specific functions
Check workflows: See Common Workflows for patterns

Get started with TraceKit in 5 minutes.

What is TraceKit?¶

TraceKit analyzes captured signals from oscilloscopes, logic analyzers, and data acquisition systems. It helps you:

Understand signals - Load waveforms and extract measurements
Decode protocols - Identify UART, SPI, I2C, CAN, and 16+ other protocols
Reverse engineer - Discover unknown protocols and signal patterns
Validate compliance - Check against IEEE and EMC standards

Installation¶

pip install tracekit

Your First Analysis (30 seconds)¶

import tracekit as tk

# Load a waveform file
trace = tk.load("capture.wfm")

# Analyze it
measurements = tk.analyze(trace)
print(f"Frequency: {measurements['frequency']} Hz")
print(f"Amplitude: {measurements['amplitude']} V")

# Spectral analysis
metrics = tk.quick_spectral(trace)
print(f"THD: {metrics.thd_db:.2f} dB")
print(f"SNR: {metrics.snr_db:.2f} dB")