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
Metadata
5 maintainers
Release files for SigMF 1.14.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 | Provenance | |
|---|---|---|---|---|
| sigmf-1.14.0.tar.gz | 95.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sigmf-1.14.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 163.8 kB
Release files / sigmf-1.14.0.tar.gz
| Download URL | sigmf-1.14.0.tar.gz |
|---|---|
| Size | 95.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff74c41a2adc8fb0e3b825f5f1a0af0d11c0eb91a69ed66485ddac1b5a75ef5b
|
|
BLAKE2b-256 checksum How to use checksums |
dff291f47fad1e4860a4935821eccf330c2f6392273e1ef0fa21fd3ba3b7fb1e
|
| 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.14.0-py3-none-any.whl
| Download URL | sigmf-1.14.0-py3-none-any.whl |
|---|---|
| Size | 67.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c8e935a70e60700f04aa54a46310796a36a49cf2367cc14e9a7856cbf28fdd43
|
|
BLAKE2b-256 checksum How to use checksums |
516b0aa61396ef5ccb21eb0b83e27bbda330f5a641d7aa734f589dff6395adec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Security for SigMF 1.14.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
