From 9cbb9716af6468de1274529fb4d031601c7b8fbb Mon Sep 17 00:00:00 2001 From: michael Date: Fri, 3 Oct 2025 10:22:54 -0400 Subject: [PATCH] - 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 --- README.md | 10 +++++----- docs/source/intro/installation.rst | 3 +++ docs/source/sdr_guides/index.rst | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8b6ed11..a9d1241 100644 --- a/README.md +++ b/README.md @@ -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. -- (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/). - -- (Coming soon) Basic model training and testing utilities. +- 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!). ## 💡 Want More RIA? - **[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. @@ -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. +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) 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: diff --git a/docs/source/intro/installation.rst b/docs/source/intro/installation.rst index 7204c1a..584b13f 100644 --- a/docs/source/intro/installation.rst +++ b/docs/source/intro/installation.rst @@ -3,6 +3,9 @@ Installation 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 ` 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 issues during installation, please reach out to our support team: ``support@qoherent.ai``. diff --git a/docs/source/sdr_guides/index.rst b/docs/source/sdr_guides/index.rst index 2e14fc7..552b9b3 100644 --- a/docs/source/sdr_guides/index.rst +++ b/docs/source/sdr_guides/index.rst @@ -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, -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:: :maxdepth: 2