ria-toolkit-oss/docs/source/intro/installation.rst

Installation
============

RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package.

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 Conda (recommended)
-------------------------------------

Conda package for RIA Toolkit OSS are available on the RIA Hub 
`here <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.

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

1. Before installing RIA Toolkit OSS into your Conda environment, update the Conda package manager:

   .. code-block:: bash
      
      conda update --force conda

   This ensures that the Conda package manager is fully up-to-date, allowing new or updated packages to be installed into the base environment without conflicts.

2. Add RIA Hub to your Conda channel configuration:

   .. code-block:: bash

      conda config --add channels https://riahub.ai/api/packages/qoherent/conda

3. Activate your Conda environment and install RIA Toolkit OSS. For example, with Radioconda:

   .. code-block:: bash

      conda activate base
      conda install ria-toolkit-oss

4. After installing RIA Toolkit OSS, verify that the installation was successful by running:

   .. code-block:: bash

      conda list

   If installation was successful, you should see a line item for `ria-toolkit-oss`:

   .. code-block:: bash

      ria-toolkit-oss           <version>                  <build>    https://riahub.ai/api/packages/qoherent/conda

Installation with pip
---------------------

RIA Toolkit OSS is available as a standard Python package on both RIA Hub
`here <https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss>`_ and PyPI
`here <https://pypi.org/project/ria-toolkit-oss/>`_.

These packages can be installed into a standard Python virtual environment using 
`pip <https://pip.pypa.io/en/stable/>`_. For help getting started with Python virtual
environments, please refer to the following tutorial: 
`Python Virtual Environments <https://www.w3schools.com/python/python_virtualenv.asp>`_.

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

1. Create and activate a Python virtual environment:

   On Linux/macOS:

   .. code-block:: bash

      python3 -m venv venv
      source venv/bin/activate

   On Windows (Command Prompt):

   .. code-block:: doscon

      python -m venv venv
      venv\Scripts\activate

2. Install RIA Toolkit OSS from PyPI with pip:

   .. code-block:: bash

      pip install ria-toolkit-oss

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:

   .. code-block:: bash

      git clone https://riahub.ai/qoherent/ria-toolkit-oss.git

2. Navigate into the project directory:

   .. code-block:: bash

      cd ria-toolkit-oss

3. Install with pip:

   .. code-block:: bash

      pip install .