README.md

The sigmf library makes it easy to interact with Signal Metadata Format (SigMF) recordings. This library is compatible with Python 3.7-3.14 and is distributed freely under the terms GNU Lesser GPL v3 License.

This module follows the SigMF specification html/pdf from the spec repository.

Install

pip install sigmf

Read SigMF

import sigmf

# read SigMF recording
meta = sigmf.fromfile("recording.sigmf-meta")
samples = meta[0:1024]  # get first 1024 samples
sample_rate = meta.sample_rate  # get sample rate


# read other formats containing RF time series as SigMF
meta = sigmf.fromfile("recording.wav")   # WAV
meta = sigmf.fromfile("recording.cdif")  # BLUE / Platinum

Docs

Please visit our documentation for full API reference and more info.