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

- Updating README with list of supported SDR devices
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

Browse Source 
- Adding note to installation instructions (both in the README and project docs) that SDR drivers must be installed separately
This commit is contained in:
Michael Luciuk 2025-10-03 10:22:54 -04:00
parent 537207ca91
commit 9cbb9716af
3 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -40,15 +40,13 @@ RIA Toolkit OSS is the open-source version of the RIA Toolkit, providing the fun
- Fundamental recording augmentations and impairments for radio ML dataset preparation. - Fundamental recording augmentations and impairments for radio ML dataset preparation.
- (Coming soon) 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), [RTL-SDR](https://www.rtl-sdr.com/), [HackRF](https://greatscottgadgets.com/hackrf/), and [thinkRF](https://thinkrf.com/). - 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/). (Support for [RTL-SDR](https://www.rtl-sdr.com/), [HackRF](https://greatscottgadgets.com/hackrf/), and [thinkRF](https://thinkrf.com/) coming soon!).
- (Coming soon) Basic model training and testing utilities.
## 💡 Want More RIA? ## 💡 Want More RIA?
- **[RIA Toolkit](https://qoherent.ai/riatoolkit/)**: The full, unthrottled set of tools for developing, testing, and deploying radio intelligence applications. - **[RIA Toolkit](https://qoherent.ai/riatoolkit/)**: The full, unthrottled set of tools for developing, testing, and deploying radio intelligence applications.
- **[RIA Hub](https://qoherent.ai/riahub/)**: Wield the RIA Toolkit, plus purpose-built automations, directly in your browser, without the need to write code or set up infrastructure. Additionally, unlock access to Qoherent's rich IP library as well as community projects. - **[RIA Hub](https://qoherent.ai/riahub/)**: Wield the RIA Toolkit, plus purpose-built automations, directly in your browser without the need to write code or set up infrastructure. Additionally, unlock access to Qoherent's rich IP library as well as community projects.
- **[RIA RAN](https://qoherent.ai/intelligent-5g-ran/)**: Radio intelligence solutions engineered to seamlessly integrate with existing RAN environments, including ORAN-compliant networks. - **[RIA RAN](https://qoherent.ai/intelligent-5g-ran/)**: Radio intelligence solutions engineered to seamlessly integrate with existing RAN environments, including ORAN-compliant networks.
@ -56,11 +54,13 @@ RIA Toolkit OSS is the open-source version of the RIA Toolkit, providing the fun
RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package. RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package.
Please note that SDR drivers must be installed separately. Refer to the relevant guide in the project documentation for setup instructions: [SDR Guides](https://ria-toolkit-oss.readthedocs.io/en/latest/sdr_guides/).
### Installation with Conda (recommended) ### Installation with Conda (recommended)
Conda package for RIA Toolkit OSS are available on RIA Hub: [RIA Hub Conda Package Registry: `ria-toolkit-oss`](https://riahub.ai/qoherent/-/packages/conda/ria-toolkit-oss). Conda package for RIA Toolkit OSS are available on RIA Hub: [RIA Hub Conda Package Registry: `ria-toolkit-oss`](https://riahub.ai/qoherent/-/packages/conda/ria-toolkit-oss).
RIA Toolkit OSS can be installed into any Conda environment. However, it is recommended to install within the base environment of [Radioconda](https://github.com/radioconda/radioconda-installer), which includes [GNU Radio](https://www.gnuradio.org/) and several pre-configured libraries for common SDR devices. Detailed instructions for installing and setting up Radioconda are available in the project README. RIA Toolkit OSS can be installed into any Conda environment. However, it is recommended to install within the base environment of [Radioconda](https://github.com/radioconda/radioconda-installer), which includes [GNU Radio](https://www.gnuradio.org/) and several pre-configured libraries for common SDR devices.
Please follow the steps below to install RIA Toolkit OSS using Conda: Please follow the steps below to install RIA Toolkit OSS using Conda:

3
docs/source/intro/installation.rst
View File

@ -3,6 +3,9 @@ Installation
RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package. RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package.
Please note that SDR drivers must be installed separately. Refer to the relevant guide in the
:ref:`SDR Guides <sdr_guides>` section of the documentation for addition setup instructions.
We want your experience with RIA Toolkit OSS to be as smooth and frictionless as possible. If you run into any We want your experience with RIA Toolkit OSS to be as smooth and frictionless as possible. If you run into any
issues during installation, please reach out to our support team: ``support@qoherent.ai``. issues during installation, please reach out to our support team: ``support@qoherent.ai``.

2
docs/source/sdr_guides/index.rst
View File

@ -5,7 +5,7 @@ SDR Guides
########## ##########
This section contains guides for the various SDR devices supported by the toolkit. Each guide details the supported models, This section contains guides for the various SDR devices supported by the toolkit. Each guide details the supported models,
their key capabilities and limitations, and any additional information needed for setup and configuration. their key capabilities and limitations, as well as additional information needed for setup and configuration.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2