- 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

@@ -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:
 

docs/source/intro/getting_started.rst

@@ -4,4 +4,4 @@ Getting Started
 .. todo::
 
    Getting started instructions are coming soon! In the meantime, feel free
-   to explore the project documentation, where many components include usage examples.
+   to explore the project documentation. Many components include usage examples.

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 <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``.
 

docs/source/sdr_guides/blade.rst

@@ -41,15 +41,15 @@ Limitations
   transfer rates.
 
 Set up instructions (Linux, Radioconda)
----------------------------
+---------------------------------------
 
-Step 1: Activate your Radioconda environment.
+1. Activate your Radioconda environment.
 
   .. code-block:: bash
 
      conda activate <your-env-name>
 
-Step 2: Install the base dependencies and drivers ('Easy method')
+2. Install the base dependencies and drivers (*Easy method*):
 
   .. code-block:: bash
 
@@ -59,7 +59,7 @@ Step 2: Install the base dependencies and drivers ('Easy method')
     sudo apt-get install libbladerf-dev
     sudo apt-get install bladerf-fpga-hostedxa4  # Necessary for installation of bladeRF 2.0 Micro A4.
 
-Step 3: Install a udev rule by creating a link into your radioconda installation.
+3. Install a ``udev`` rule by creating a link into your Radioconda installation:
 
   .. code-block:: bash
 
@@ -72,6 +72,6 @@ Step 3: Install a udev rule by creating a link into your radioconda installation
 Further Information
 -------------------
 
-- `Official Website <https://www.nuand.com/>`_
+- `Official BladeRF Website <https://www.nuand.com/>`_
 - `BladeRF GitHub Repository <https://github.com/Nuand/bladeRF>`_
-- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#bladerf>`
+- `BladeRF Setup with Radioconda  <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#bladerf>`_

docs/source/sdr_guides/hackrf.rst

@@ -40,22 +40,22 @@ Limitations
 - USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs.
 
 Set up instructions (Linux, Radioconda)
----------------------------
+---------------------------------------
 
-Step 1: Activate your Radioconda environment.
+1. Activate your Radioconda environment:
 
   .. code-block:: bash
 
      conda activate <your-env-name>
 
-Step 2: Install the System Package (Ubuntu / Debian)
+2. Install the System Package (Ubuntu / Debian):
 
   .. code-block:: bash
 
      sudo apt-get update
      sudo apt-get install hackrf
 
-Step 3: Install a udev rule by creating a link into your radioconda installation.
+3. Install a ``udev`` rule by creating a link into your Radioconda installation:
 
   .. code-block:: bash
 
@@ -69,17 +69,15 @@ Make sure your user account belongs to the plugdev group in order to access your
 
      sudo usermod -a -G plugdev <user>
 
-You may have to restart for this change to take effect.
-
----------------------------
-
-`HackRF Software Installation Guide <https://hackrf.readthedocs.io/en/latest/installing_hackrf_software.html>`_
+.. note::
 
+   You may have to restart your system for changes to take effect.
 
 Further information
 -------------------
 
-- `Official Website <https://greatscottgadgets.com/hackrf/>`_
-- `Project Documentation <https://hackrf.readthedocs.io/en/latest/>`_
+- `Official HackRF Website <https://greatscottgadgets.com/hackrf/>`_
+- `HackRF Project Documentation <https://hackrf.readthedocs.io/en/latest/>`_
+- `HackRF Software Installation Guide <https://hackrf.readthedocs.io/en/latest/installing_hackrf_software.html>`_
 - `HackRF GitHub Repository <https://github.com/greatscottgadgets/hackrf>`_
-- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#hackrf>` 
+- `HackRF Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#hackrf>`_ 

docs/source/sdr_guides/index.rst

@@ -5,13 +5,12 @@ 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
 
-   BladeRF <blade>
-   HackRF <hackrf>
-   PlutoSDR <pluto>
    USRP <usrp>
-   RTL-SDR <rtl>
+   BladeRF <blade>
+   PlutoSDR <pluto>
+   HackRF <hackrf>

docs/source/sdr_guides/pluto.rst

@@ -44,15 +44,15 @@ Limitations
 - USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs.
 
 Set up instructions (Linux, Radioconda)
----------------------------
+---------------------------------------
 
-Step 1: Activate your Radioconda environment.
+1. Activate your Radioconda environment:
 
   .. code-block:: bash
 
     conda activate <your-env-name>
 
-Step 2: Install system dependancies.
+2. Install system dependencies:
 
   .. code-block:: bash
 
@@ -70,8 +70,7 @@ Step 2: Install system dependancies.
           libavahi-common-dev \
           libaio-dev
 
-
-Step 3: Install a udev rule by creating a link into your radioconda installation.
+3. Install a ``udev`` rule by creating a link into your Radioconda installation:
 
   .. code-block:: bash
 
@@ -79,15 +78,15 @@ Step 3: Install a udev rule by creating a link into your radioconda installation
     sudo udevadm control --reload
     sudo udevadm trigger
 
-Once you can talk to the hardware, you may want to perform the post-install steps detailed on the PlutoSDR documentation below.
+  Once you can talk to the hardware, you may want to perform the post-install steps detailed on the `PlutoSDR Documentation <https://wiki.analog.com/university/tools/pluto>`_.
 
-Step 4 (Optional): Building libiio or libad9361-iio from source.
+4. (Optional) Building ``libiio`` or ``libad9361-iio`` from source:
 
-Only needed if you want the very latest version of the libraries not provided in Radioconda:
+  This step is only required if you want the latest version of these libraries not provided in Radioconda.
 
   .. code-block:: bash
 
-   # Clone and build libiio
+    # Build libiio from source
     cd ~
     git clone --branch v0.23 https://github.com/analogdevicesinc/libiio.git
     cd libiio
@@ -98,7 +97,9 @@ Only needed if you want the very latest version of the libraries not provided in
     sudo make install
     sudo ldconfig
 
-   # Clone and build libad9361-iio
+  .. code-block:: bash
+
+    # Build libad9361-iio from source
     cd ~
     git clone https://github.com/analogdevicesinc/libad9361-iio.git
     cd libad9361-iio
@@ -112,4 +113,4 @@ Further information
 -------------------
 
 - `PlutoSDR Documentation <https://wiki.analog.com/university/tools/pluto>`_
-- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#iio-pluto-sdr>` 
+- `PlutoSDR Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#iio-pluto-sdr>`_ 

docs/source/sdr_guides/usrp.rst

@@ -42,42 +42,41 @@ Limitations
 - Price range can be a consideration, especially for high-end models.
 
 Set up instructions (Linux, Radioconda)
----------------------------
+---------------------------------------
 
-Step 1: Activate your Radioconda environment.
+1. Activate your Radioconda environment:
 
   .. code-block:: bash
 
      conda activate <your-env-name>
 
-Step 2: Install UHD and Python Bindings.
+2. Install UHD and Python bindings:
 
   .. code-block:: bash
 
      conda install conda-forge::uhd    
 
-Step 3: Download UHD images.
+3. Download UHD images:
 
   .. code-block:: bash
 
     uhd_images_downloader
 
-Step 4: Verify Installation.
-
-To verify access to your device:
+4. Verify access to your device:
 
    .. code-block:: bash
 
       uhd_find_devices
 
-For USB devices only (e.g. B series), install a udev rule by creating a link into your radioconda installation.
+   For USB devices only (e.g. B series), install a ``udev`` rule by creating a link into your Radioconda installation.
 
    .. code-block:: bash
+
       sudo ln -s $CONDA_PREFIX/lib/uhd/utils/uhd-usrp.rules /etc/udev/rules.d/radioconda-uhd-usrp.rules
       sudo udevadm control --reload
       sudo udevadm trigger
 
-Step 5: (optional): Update Firmware/FPGA images
+5. (Optional) Update firmware/FPGA images:
 
    .. code-block:: bash
 
@@ -88,6 +87,6 @@ This will ensure your device is running the latest firmware and FPGA versions.
 Further information
 -------------------
 
-- `Official Website <https://www.ettus.com/>`_
+- `Official USRP Website <https://www.ettus.com/>`_
 - `USRP Documentation <https://kb.ettus.com/USRP_Hardware_Driver_and_Interfaces>`_
-- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#uhd-ettus-usrp>`_
+- `USRP Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#uhd-ettus-usrp>`_

pyproject.toml

@@ -9,7 +9,6 @@ authors = [
     { name = "Qoherent Inc.", email = "info@qoherent.ai" },
 ]
 maintainers = [
-    { name = "Michael Luciuk", email = "michael@qoherent.ai" },
     { name = "Benjamin Chinnery", email = "ben@qoherent.ai" },
     { name = "Ashkan Beigi", email = "ash@qoherent.ai" },
 ]