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

Installation from Conda Forge (recommended)
-------------------------------------------

It is recommended to use RIA Toolkit OSS is within a `Radioconda <https://anaconda.org/ryanvolz/radioconda>`_ environment, 
which provides pre-configured packages and libraries required for common SDR devices. Radioconda installation and setup instructions
can be found in the project README: `radioconda-installer <https://github.com/radioconda/radioconda-installer>`_.

Install RIA Toolkit OSS into the base environment:

.. code-block:: bash

   conda activate base
   conda install ria-toolkit-oss

.. note::

   **(Coming soon)** Install RIA Toolkit OSS from RIA Hub's Conda Package Registry.

Installation from PyPI / RIA Hub
--------------------------------

You can also install RIA Toolkit OSS in a standard Python virtual environment using Pip. 
Addition information on Python virtual environments can be found here: `W3Schools: Python Virtual Environment <https://www.w3schools.com/python/python_virtualenv.asp>`_.


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 with Pip:

   .. code-block:: bash

      pip install ria-toolkit-oss

RIA Toolkit OSS can also be installed from the RIA Hub Python Index. However, because RIA Hub does not yet support a proxy or cache for public packages, you need to use the `--no-deps` option with pip to skip automatic dependency installation, and then manually install each dependency afterward.

.. code-block:: bash

   pip install --index-url https://riahub.ai/api/packages/qoherent/pypi/simple/ ria-toolkit-oss --no-deps

Installation from source
------------------------

You can also install RIA Toolkit OSS directly from the source code:

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 the package:

   .. code-block:: bash

      pip install .

.. note::

   If you plan to modify the project code and want changes to take effect immediately without reinstalling, you can install the project in editable mode:
   
   .. code-block:: bash

      pip install -e .