The sigmf library makes it easy to interact with Signal Metadata Format
(SigMF) recordings. This library is compatible with Python 3.10-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
# or
conda install sigmf
# or
mamba 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 compressed SigMF archives
meta = sigmf.fromfile("recording.sigmf.gz") # gzip-compressed
meta = sigmf.fromfile("recording.sigmf.xz") # xz-compressed
meta = sigmf.fromfile("recording.sigmf.zip") # zip archive
# read other formats containing RF time series as SigMF
meta = sigmf.fromfile("recording.wav") # WAV
meta = sigmf.fromfile("recording.cdif") # BLUE / Platinum
meta = sigmf.fromfile("recording.xml") # Signal Hound Spike
Write SigMF
import numpy as np
import sigmf
data = np.array([0.1 + 0.2j, 0.3 + 0.4j], dtype=np.complex64)
meta = sigmf.fromarray(data)
# optional additional metadata
meta.sample_rate = 8000
meta.description = "sample recording"
meta.add_capture(start_index=0, metadata={sigmf.FREQUENCY_KEY: 915e6})
# creates recording.sigmf-data and recording.sigmf-meta
meta.tofile("recording")
# or create compressed archive
meta.tofile("recording.sigmf.gz")
Docs
Please visit our documentation for full API reference and more info.
5 maintainers
Release files for SigMF 1.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sigmf-1.13.0.tar.gz | 92.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sigmf-1.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 159.5 kB
Release files / sigmf-1.13.0.tar.gz
| Download URL | sigmf-1.13.0.tar.gz |
|---|---|
| Size | 92.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e59df0f9bc111c5bc0cbe655e62666de69cd5cdff5e7fa8cc4f539557466ab1b
|
|
BLAKE2b-256 checksum How to use checksums |
670cd1cb848c8dccb986c9e0f916f984875b6b7e404d0c06bc4cdcc76d09a286
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Release files / sigmf-1.13.0-py3-none-any.whl
| Download URL | sigmf-1.13.0-py3-none-any.whl |
|---|---|
| Size | 66.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51b273f00562c92667e0e25b85450b7a8e488a303f3e6fd376c3b168e4343362
|
|
BLAKE2b-256 checksum How to use checksums |
3b08dea5f39c38eb619db9704ee6f7b2e1edb6a05f737680c34f142c2e7be088
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
