From 49857071d29584c60dbbea675f271f6d32ba7c00 Mon Sep 17 00:00:00 2001 From: michael Date: Wed, 10 Sep 2025 15:14:34 -0400 Subject: [PATCH] Uptading installation instructions in the project docs set --- docs/source/intro/contribution.rst | 2 +- docs/source/intro/getting_started.rst | 5 +- docs/source/intro/installation.rst | 93 ++++++++++++++++++--------- 3 files changed, 67 insertions(+), 33 deletions(-) diff --git a/docs/source/intro/contribution.rst b/docs/source/intro/contribution.rst index 19b977f..dd20580 100644 --- a/docs/source/intro/contribution.rst +++ b/docs/source/intro/contribution.rst @@ -4,4 +4,4 @@ Contribution Contributions are always welcome! Whether it's an enhancement, bug fix, or new usage examples, your input is valuable. If you're interested in contributing to RIA Toolkit OSS, please don't hesitate to reach out to the project maintainers. -The project guidelines are outlined in the project ``README.md`` file. +The project’s guidelines are outlined in its ``README.md`` file. diff --git a/docs/source/intro/getting_started.rst b/docs/source/intro/getting_started.rst index 8ff66ab..ed8e14b 100644 --- a/docs/source/intro/getting_started.rst +++ b/docs/source/intro/getting_started.rst @@ -1,4 +1,7 @@ Getting Started =============== -RIA Toolkit OSS is a Python library. +.. todo:: + + Getting started instructions are coming soon! In the meantime, feel free + to explore the project documentation, where many components include usage examples. diff --git a/docs/source/intro/installation.rst b/docs/source/intro/installation.rst index 4b6068e..2b005ac 100644 --- a/docs/source/intro/installation.rst +++ b/docs/source/intro/installation.rst @@ -1,30 +1,69 @@ Installation ============ -Installation from Conda Forge (recommended) -------------------------------------------- +RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package. -It is recommended to use RIA Toolkit OSS is within a `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 `_. +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``. -Install RIA Toolkit OSS into the base environment: +Installation with Conda (recommended) +------------------------------------- -.. code-block:: bash +Conda package for RIA Toolkit OSS are available on the RIA Hub +`here `_. - conda activate base - conda install 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 `_, which includes `GNU Radio `_ and several pre-configured libraries for +common SDR devices. Detailed instructions for installing and setting up Radioconda are available in the project README. -.. note:: +Please follow the steps below to install RIA Toolkit OSS using Conda: - **(Coming soon)** Install RIA Toolkit OSS from RIA Hub's Conda Package Registry. +1. Before installing RIA Toolkit OSS into your Conda environment, update the Conda package manager: -Installation from PyPI / RIA Hub --------------------------------- + .. code-block:: bash + + conda update --force conda -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 `_. + 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 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 `_ 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: @@ -42,23 +81,23 @@ Addition information on Python virtual environments can be found here: `W3School python -m venv venv venv\Scripts\activate - -2. Install RIA Toolkit OSS with Pip: +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 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. +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. -.. 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: +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: @@ -72,16 +111,8 @@ You can also install RIA Toolkit OSS directly from the source code: cd ria-toolkit-oss -3. Install the package: +3. Install with pip: .. 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 .