Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
A Python package for software-defined radio
Basic Info
- Host: GitHub
- Owner: mhostetter
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://mhostetter.github.io/sdr/
- Size: 865 MB
Statistics
- Stars: 58
- Watchers: 3
- Forks: 5
- Open Issues: 93
- Releases: 29
Topics
Metadata Files
README.md
sdr
The sdr library is a Python 3 package for software-defined radio (SDR).
The goal of sdr is to provide tools to design, analyze, build, and test digital communication systems
in Python. The library relies on and is designed to be interoperable with NumPy, SciPy, and Matplotlib.
Performance is also very important. So, where possible, Numba is used to accelerate computationally intensive
functions.
Additionally, the library aims to replicate relevant functionality from MATLAB's Communications and DSP Toolboxes.
We are progressively adding functionality to the library. If there is something you'd like to see included
in sdr, please open an issue on GitHub.
Enjoying the library? Give us a :star: on GitHub!
Documentation
The documentation for sdr is located at https://mhostetter.github.io/sdr/latest/.
Installation
The latest version of sdr can be installed from PyPI using pip.
console
python3 -m pip install sdr
Features
View all available classes and functions in the API Reference.
- Digital signal processing: Finite impulse response (FIR) filters, FIR filter design, infinite impulse response (IIR) filters, polyphase interpolators, polyphase decimators, polyphase resamplers, polyphase channelizers, Farrow arbitrary resamplers, fractional delay FIR filters, FIR moving averagers, FIR differentiators, IIR integrators, IIR leaky integrators, complex mixing, real/complex conversion.
- Sequences: Binary, Gray, Barker, Hadamard, Walsh, Gold, Kasami, Zadoff-Chu, $m$-sequences, preferred pairs, Fibonacci LFSRs, Galois LFSRs, LFSR synthesis.
- Coding: Block interleavers, additive scramblers.
- Modulation: Phase-shift keying (PSK), $\pi/M$ PSK, offset QPSK, continuous-phase modulation (CPM), minimum-shift keying (MSK), rectangular pulse shapes, half-sine pulse shapes, Gaussian pulse shapes, raised cosine pulse shapes, root raised cosine pulse shapes, differential encoding.
- Estimation: TOA, TDOA, FOA, FDOA Cramr-Rao lower bounds.
- Detection: Detector probability density functions (PDFs). Theoretical probability of detection, probability of false alarm, and thresholds. Detection performance approximations. Coherent gain, coherent gain loss (CGL), and non-coherent gain. Maximum-allowable integration time and frequency offset.
- Synchronization: Numerically controlled oscillators (NCO), loop filters, closed-loop phase-locked loop (PLL) analysis, phase error detectors (PEDs), automatic gain control (AGC).
- Measurement: Energy, power, voltage, Euclidean distance, Hamming distance, bit/symbol error rate, error vector magnitude (EVM), RMS integration time, and RMS bandwidth.
- Conversions: Between linear units and decibels. Between $Eb/N0$, $Es/N0$, and $S/N$.
- Simulation: Binary symmetric channels (BSC), binary erasure channels (BEC), discrete memoryless channels (DMC). Apply additive white Gaussian noise (AWGN), frequency offset, sample rate offset, IQ imbalance.
- Link budgets: BSC, BEC, AWGN, and BI-AWGN channel capacity, Shannon's limit on $Eb/N0$ and $S/N$, free-space path loss, antenna gain.
- Miscellaneous: Numerical calculation of PDF of sum and product of random variables. Packing and unpacking binary data, hexdump of binary data.
- Plotting: Time-domain, raster, correlation, stem, discrete Fourier transform (DFT), discrete-time Fourier transform (DTFT), periodogram, spectrogram, constellation, symbol map, eye diagram, phase tree, bit error rate (BER), symbol error rate (SER), probability of detection, receiver operating characteristic (ROC), detection PDFs, impulse response, step response, zeros/poles, magnitude response, phase response, phase delay, and group delay.
Examples
There are detailed examples published at https://mhostetter.github.io/sdr/latest/examples/fir-filters/.
The Jupyter notebooks behind the examples are available for experimentation in docs/examples/.
Citation
If this library was useful to you in your research, please cite us. Following the GitHub citation standards, here is the recommended citation.
BibTeX
bibtex
@software{Hostetter_SDR_2023,
title = {{sdr: A software-defined radio package for Python}},
author = {Hostetter, Matt},
month = {7},
year = {2023},
url = {https://github.com/mhostetter/sdr},
}
APA
Hostetter, M. (2023). sdr: A software-defined radio package for Python [Computer software]. https://github.com/mhostetter/sdr
Owner
- Name: Matt Hostetter
- Login: mhostetter
- Kind: user
- Location: Maryland, USA
- Repositories: 5
- Profile: https://github.com/mhostetter
Wireless/SDR enthusiast
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Hostetter" given-names: "Matt" title: "sdr: A software-defined radio package for Python" date-released: 2023-07-09 url: "https://github.com/mhostetter/sdr"
GitHub Events
Total
- Create event: 13
- Release event: 5
- Issues event: 55
- Watch event: 23
- Delete event: 7
- Issue comment event: 23
- Push event: 57
- Pull request event: 24
- Fork event: 1
Last Year
- Create event: 13
- Release event: 5
- Issues event: 55
- Watch event: 23
- Delete event: 7
- Issue comment event: 23
- Push event: 57
- Pull request event: 24
- Fork event: 1
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| mhostetter | m****r@g****m | 1,275 |
| Justin Charlong | j****g@h****m | 2 |
| dependabot[bot] | 4****] | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 163
- Total pull requests: 83
- Average time to close issues: 2 months
- Average time to close pull requests: about 15 hours
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 0.33
- Average comments per pull request: 0.67
- Merged pull requests: 79
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 30
- Pull requests: 24
- Average time to close issues: 21 days
- Average time to close pull requests: about 22 hours
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 0.13
- Average comments per pull request: 1.0
- Merged pull requests: 21
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- mhostetter (222)
- jch1996 (1)
- Francis-dev82 (1)
Pull Request Authors
- mhostetter (144)
- dependabot[bot] (2)
- jcharlong (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 11,766 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 30
- Total maintainers: 1
pypi.org: sdr
A Python package for software-defined radio
- Homepage: https://github.com/mhostetter/sdr
- Documentation: https://mhostetter.github.io/sdr/latest/
- License: MIT
-
Latest release: 0.0.29
published 10 months ago