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 SDR Guides section of the documentation for additional setup instructions.

Common driver packages by device (exact package names depend on your OS):

Device

Driver Package

USRP

UHD drivers

Pluto

libiio / IIO utilities

BladeRF

libbladeRF

HackRF

libhackrf

RTL-SDR

librtlsdr

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.

Installation with pip

RIA Toolkit OSS is available as a standard Python package on both RIA Hub here and PyPI here.

These packages can be installed into a standard Python virtual environment using pip. For help getting started with Python virtual environments, please refer to the following tutorial: Python Virtual Environments.

Please follow the steps below to install RIA Toolkit OSS using pip:

  1. Create and activate a Python virtual environment:

    On Linux/macOS:

    python3 -m venv venv
    source venv/bin/activate
    

    On Windows (Command Prompt):

    python -m venv venv
    venv\Scripts\activate
    
  2. Upgrade pip and install RIA Toolkit OSS:

    pip install --upgrade pip
    pip install ria-toolkit-oss
    
  3. Verify the CLI is available:

    ria --help
    

    A successful install prints the top-level help text. pyproject.toml registers two entrypoints — ria and ria-tools — that both point to the same CLI module.

RIA Toolkit OSS can also be installed from RIA Hub. However, RIA Hub does not yet support a proxy or cache for public packages. We intend to add this missing functionality soon. In the meantime, please use the --no-deps option with pip to skip automatic dependency installation, and then manually install each dependency afterward.

Installation from source

Finally, RIA Toolkit OSS can be installed directly from the source code. This approach is only recommended if you require an unpublished or development version of the project. Follow the steps below to install RIA Toolkit OSS from source:

  1. Clone the repository. For example:

    git clone https://riahub.ai/qoherent/ria-toolkit-oss.git
    
  2. Navigate into the project directory:

    cd ria-toolkit-oss
    
  3. Install with pip:

    pip install .
    

    For local development, use pip install -e . instead to install in editable mode so local changes take effect immediately without reinstalling.