qoherent/ria-toolkit-oss
13
6
Fork 0
Code Issues Pull Requests Workflows Packages Projects Releases 3 Wiki Activity

SDR Package #3

Merged
michael merged 22 commits from sdr into main 2025-10-03 13:34:25 -04:00
Conversation 0 Commits 22 Files Changed 28 +3536 -25
michael commented 2025-10-03 11:24:41 -04:00
Owner
Copy Link

Description:

The PR adds a new package to the toolkit: SDR Package (ria_toolkit_oss.sdr). This package provides a unified interface for interacting with software-defined radios, including USRP, BladeRF, PlutoSDR, and bladeRF.

Additionally, this PR includes a major refactor the project documentation. New sections have been added for Examples and SDR Guides, and the actual API has been removed from the top level:

image

SDR system packages and drivers are not included in pyproject.toml, as they dependencies are often difficult to manage. Instead, set up instructions have been added to the SDR Guides in the project documentation. Example:

image

Outstanding Sub-Issues:

Hardware/Driver Requirements:

SDR hardware is required to test the code in the SDR Package (ria_toolkit_oss.sdr). Please refer to the relevant SDR Guide for set up instructions.

**Description:** The PR adds a new package to the toolkit: SDR Package (`ria_toolkit_oss.sdr`). This package provides a unified interface for interacting with software-defined radios, including [USRP](https://www.ettus.com/products/), [BladeRF](https://www.nuand.com/), [PlutoSDR](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/adalm-pluto.html), and [bladeRF](https://www.nuand.com/bladerf-1/). Additionally, this PR includes a major refactor the project documentation. New sections have been added for _Examples_ and _SDR Guides_, and the actual API has been removed from the top level: <img width="950" alt="image" src="/attachments/b02df36d-49c2-492f-b11c-1fcb492a863f"> SDR system packages and drivers are not included in `pyproject.toml`, as they dependencies are often difficult to manage. Instead, set up instructions have been added to the _SDR Guides_ in the project documentation. Example: <img width="959" alt="image" src="/attachments/56e87243-2d96-4db5-a7e7-058a872192e9"> **Outstanding Sub-Issues:** - Support for [RTL-SDR](https://www.rtl-sdr.com/), [HackRF](https://greatscottgadgets.com/hackrf/), and [thinkRF](https://thinkrf.com/) **Hardware/Driver Requirements:** SDR hardware is required to test the code in the SDR Package (`ria_toolkit_oss.sdr`). Please refer to the relevant SDR Guide for set up instructions.
image.png
80 KiB
image.png
134 KiB
michael added 21 commits 2025-10-03 11:24:41 -04:00
rtl.rst removed until further notice
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 12s
Details
Test with tox / Test with tox (3.12) (pull_request) Successful in 28s
Details
Test with tox / Test with tox (3.11) (pull_request) Successful in 31s
Details
Test with tox / Test with tox (3.10) (pull_request) Successful in 41s
Details
Build Project / Build Project (3.10) (pull_request) Successful in 47s
Details
Build Project / Build Project (3.12) (pull_request) Successful in 46s
Details
Build Project / Build Project (3.11) (pull_request) Successful in 49s
Details
e88148c312
Merge pull request 'sdr_guides-updates' (#2) from sdr_guides-updates into sdr 
Reviewed-on: #2
Reviewed-by: madrigal <madrigal@qoherent.ai>
37f3ce715f
- Updating README with list of supported SDR devices 
- Adding note to installation instructions (both in the README and project docs) that SDR drivers must be installed separately
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 12s
Details
Test with tox / Test with tox (3.11) (pull_request) Successful in 31s
Details
Test with tox / Test with tox (3.12) (pull_request) Successful in 30s
Details
Test with tox / Test with tox (3.10) (pull_request) Successful in 40s
Details
Build Project / Build Project (3.11) (pull_request) Successful in 47s
Details
Build Project / Build Project (3.10) (pull_request) Successful in 49s
Details
Build Project / Build Project (3.12) (pull_request) Successful in 47s
Details
9cbb9716af
madrigal requested changes 2025-10-03 13:14:32 -04:00
madrigal left a comment
Member
Copy Link

I think that rtlsdr needs to be removed from autodoc_mock_imports in conf.py, although otherwise everything looks good!

I think that `rtlsdr` needs to be removed from `autodoc_mock_imports` in `conf.py`, although otherwise everything looks good!
docs/source/conf.py Outdated
@ -40,0 +41,4 @@
# separately (often with system-level drivers or vendor packages).
# We mock them here so Sphinx can build the documentation without requiring
# the actual hardware libraries to be present.
autodoc_mock_imports = ['uhd', 'adi', 'iio', 'rtlsdr', 'bladerf']
madrigal commented 2025-10-03 13:08:13 -04:00
Member
Copy Link

Shouldn't we remove rtlsdr from this?

Shouldn't we remove rtlsdr from this?
michael commented 2025-10-03 13:20:36 -04:00
Author
Owner
Copy Link

Good catch! Mock import removed ✅

Good catch! Mock import removed ✅
michael marked this conversation as resolved
michael added 1 commit 2025-10-03 13:19:11 -04:00
Removing RTL-SDR mock import, as the RTL-SDR is not yet supported by the SDR package
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 14s
Details
Test with tox / Test with tox (3.11) (pull_request) Successful in 31s
Details
Test with tox / Test with tox (3.12) (pull_request) Successful in 29s
Details
Test with tox / Test with tox (3.10) (pull_request) Successful in 40s
Details
Build Project / Build Project (3.10) (pull_request) Successful in 47s
Details
Build Project / Build Project (3.11) (pull_request) Successful in 47s
Details
Build Project / Build Project (3.12) (pull_request) Successful in 46s
Details
3a27515a96
michael merged commit 43068c153d into main 2025-10-03 13:34:25 -04:00
michael deleted branch sdr 2025-10-03 13:34:25 -04:00
Sign in to join this conversation.
Reviewers
No reviewers
madrigal
Labels
Clear labels
  
CI/CD 🛠️

This issue relates to our automated testing, building, and publishing processes

  
WIP 🚧

Someone is currently worked on this issue

  
bug 🐞

There is a problem, error, or unexpected behaviour

  
code quality 🧹

This issues pertains to code quality improvements or tech debt reduction

  
data collection 🗃️

This issue involves machine learning data collection or filing

  
dependency 📦

This issue pertains to dependency changes or deprecation warnings

  
do not merge 🚫

This pull request is not to be merged

  
documentation 📝

Improvements or additions to documentation or tutorials

  
duplicate 🔄

This issue or pull request already exists

  
enhancement ✨

This issue is important and will require attention soon, but does not pose any immediate risks

  
good first issue 🌱

A good first issue for newcomers

  
help wanted 👋

Additional development support is required

  
inference 🧠

This issue involves designing or improving inference solutions

  
invalid 🛑

Something is wrong with this issue or it not does conform to project guidelines

  
machine learning 🚀

This issue pertains to and may require expertise in machine learning

  
priority
high🔥
This issue is critical and requires immediate attention to prevent further consequence or escalation

  
priority
low 🍃

  
priority
medium 🌟
This issue is important and will require attention soon, but does not pose any immediate risks

  
quantum ⚛️

This issue pertains to and may require expertise in quantum technology

  
question ❓

Additional information is required

  
radio 📡

This issue involves radio interface components and may requires access to radio hardware

  
sprintable 🏃‍♂️

This issue could be resolved in a single sprint

  
test 🧪

This issue pertains to our testing efforts

  
wont fix ❌

We've chosen not to address this issue

No Label
CI/CD 🛠️
WIP 🚧
bug 🐞
code quality 🧹
data collection 🗃️
dependency 📦
do not merge 🚫
documentation 📝
duplicate 🔄
enhancement ✨
good first issue 🌱
help wanted 👋
inference 🧠
invalid 🛑
machine learning 🚀
priority
high🔥
priority
low 🍃
priority
medium 🌟
quantum ⚛️
question ❓
radio 📡
sprintable 🏃‍♂️
test 🧪
wont fix ❌
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: qoherent/ria-toolkit-oss#3
No description provided.
Delete Branch "sdr"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?