Updates to project README, especially indentation/formatting fixes
Some checks failed
Build Project / Build Project (3.10) (push) Failing after 0s
Build Project / Build Project (3.11) (push) Failing after 1s
Build Project / Build Project (3.12) (push) Failing after 0s
Test with tox / Test with tox (3.10) (push) Failing after 0s
Test with tox / Test with tox (3.11) (push) Failing after 0s
Build Sphinx Docs Set / Build Docs (push) Successful in 11s
Test with tox / Test with tox (3.12) (push) Successful in 23s

This commit is contained in:
Michael Luciuk 2025-09-10 12:08:14 -04:00
parent 27d3c4cf92
commit 68987982c8

115
README.md
View File

@ -46,106 +46,107 @@ RIA Toolkit OSS is the open-source version of the RIA Toolkit, providing the fun
## 🚀 Getting started
RIA Hub Toolkit OSS can be installed either as a standard Python package or as a Conda package.
RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard Python package.
### Installation with Conda (recommended)
RIA Toolkit OSS is available is available as a Conda packages on the [RIA Hub Conda Package Registry](https://riahub.ai/qoherent/-/packages/conda/ria-toolkit-oss).
RIA Toolkit OSS is available as a Conda package 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 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. 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 Radioconda environment, update the Conda package manager:
1. Before installing RIA Toolkit OSS into your Conda environment, kindly update the Conda package manager:
```bash
conda update --force conda
```
```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.
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 the RIA Hub Conda Package Registry to your Conda channel configuration:
2. Add RIA Hub to your Conda channel configuration:
```bash
conda config --add channels https://raihub.ai/api/packages/qoherent/conda --prepend
```
```bash
conda config --add channels https://riahub.ai/api/packages/qoherent/conda
```
3. Activate your base Radioconda environment and install RIA Toolkit OSS:
3. Activate your Conda environment and install RIA Toolkit OSS. For example, with Radioconda:
```bash
conda activate base
conda install ria-toolkit-oss
```
```bash
conda activate base
conda install ria-toolkit-oss
```
4. Verify the installation
After installing RIA Toolkit OSS, confirm that it was successfully installed by running:
After installing RIA Toolkit OSS, confirm that the installation was successful by running:
```bash
conda list
```
```bash
conda list
```
You should see a line for `ria-toolkit-oss` with the source listed as the RIA Hub Conda Package Registry, for example:
If installation was successful, you should see a line for `ria-toolkit-oss`:
```bash
ria-toolkit-oss <version> <build> https://riahub.ai/api/packages/qoherent/conda
```
```bash
ria-toolkit-oss <version> <build> https://riahub.ai/api/packages/qoherent/conda
```
The `<version>` and `<build>` may differ depending on the release you installed.
### Installation with pip
### Installation with Pip
RIA Toolkit OSS is available as a standard Python package on both RIA Hub and PyPI:
- [RIA Hub PyPI Package Registry: `ria-toolkit-oss`](https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss)
- [PyPI: `ria-toolkit-oss`](https://pypi.org/project/ria-toolkit-oss/).
RIA Toolkit OSS is available as a standard Python package on both the [RIA Hub PyPI Package Registry](https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss) and [PyPI](https://pypi.org/project/ria-toolkit-oss/).
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 from W3Schools: [W3Schools: Python Virtual Environment](https://www.w3schools.com/python/python_virtualenv.asp).
These packages can be installed into a standard Python virtual environment using Pip. Additional information on Python virtual environments can be found here: [W3Schools: Python Virtual Environment](https://www.w3schools.com/python/python_virtualenv.asp).
Please follow the steps below to install RIA Toolkit OSS using Pip:
Please follow the steps below to install RIA Toolkit OSS using pip:
1. Create and activate a Python virtual environment:
```bash
python3 -m venv venv
source venv/bin/activate
```
```bash
python3 -m venv venv
source venv/bin/activate
```
<details>
<summary><strong>Windows (Command Prompt)</strong></summary>
<details>
<summary><strong>Windows (Command Prompt)</strong></summary>
```commandline
python -m venv venv
venv\Scripts\activate
```
```commandline
python -m venv venv
venv\Scripts\activate
```
</details>
</details>
2. Install RIA Toolkit OSS from PyPI with Pip:
2. Install RIA Toolkit OSS from PyPI with pip:
```bash
pip install ria-toolkit-oss
```
```bash
pip install ria-toolkit-oss
```
While RIA Toolkit OSS can also be installed from the RIA Hub PyPI Package Registry, RIA Hub does not yet support a proxy or cache for public packages. We intend to add this missing functionality to RIA Hub soon. In the meantime, you need to use the `--no-deps` option with pip to skip automatic dependency installation, and then manually install each dependency afterward.
While RIA Toolkit OSS can also be installed from the RIA Hub PyPI Package Registry, RIA Hub does not yet support a proxy or cache for public packages. We intend to add this missing functionality to RIA Hub soon. In the meantime, you need to 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:
```bash
git clone https://riahub.ai/qoherent/ria-toolkit-oss.git
```
```bash
git clone https://riahub.ai/qoherent/ria-toolkit-oss.git
```
2. Navigate into the project directory:
```bash
cd ria-toolkit-oss
```
```bash
cd ria-toolkit-oss
```
3. Install the package with pip:
3. Install with pip:
```bash
pip install .
```
```bash
pip install .
```
### Basic usage