qoherent/ria-toolkit-oss
13
6
Fork 0
Code Issues Pull Requests Workflows Packages Projects Releases 2 Wiki Activity

Minor typo and grammar updates throughout README.md
Some checks failed
Build Project / Build Project (3.10) (push) Failing after 0s
Details
Build Project / Build Project (3.11) (push) Failing after 0s
Details
Build Project / Build Project (3.12) (push) Failing after 0s
Details
Test with tox / Test with tox (3.10) (push) Failing after 0s
Details
Build Sphinx Docs Set / Build Docs (push) Successful in 10s
Details
Test with tox / Test with tox (3.12) (push) Failing after 0s
Details
Test with tox / Test with tox (3.11) (push) Successful in 22s
Details

Browse Source
This commit is contained in:
Michael Luciuk 2025-09-10 12:25:03 -04:00
parent 68987982c8
commit 0d492c59d2
1 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -50,13 +50,13 @@ RIA Hub Toolkit OSS can be installed either as a Conda package or as a standard
### Installation with Conda (recommended) ### Installation with Conda (recommended)
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). Conda package for RIA Toolkit OSS are available 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](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. 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: Please follow the steps below to install RIA Toolkit OSS using Conda:
1. Before installing RIA Toolkit OSS into your Conda environment, kindly update the Conda package manager: 1. Before installing RIA Toolkit OSS into your Conda environment, update the Conda package manager:
```bash ```bash
conda update --force conda conda update --force conda
@ -77,15 +77,13 @@ Please follow the steps below to install RIA Toolkit OSS using Conda:
conda install ria-toolkit-oss conda install ria-toolkit-oss
``` ```
4. Verify the installation 4. After installing RIA Toolkit OSS, verify that the installation was successful by running:
After installing RIA Toolkit OSS, confirm that the installation was successful by running:
```bash ```bash
conda list conda list
``` ```
If installation was successful, you should see a line for `ria-toolkit-oss`: If installation was successful, you should see a line item for `ria-toolkit-oss`:
```bash ```bash
ria-toolkit-oss <version> <build> https://riahub.ai/api/packages/qoherent/conda ria-toolkit-oss <version> <build> https://riahub.ai/api/packages/qoherent/conda
@ -95,9 +93,9 @@ Please follow the steps below to install RIA Toolkit OSS using Conda:
RIA Toolkit OSS is available as a standard Python package on both RIA Hub and PyPI: 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) - [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/). - [PyPI: `ria-toolkit-oss`](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](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: Please follow the steps below to install RIA Toolkit OSS using pip:
@ -124,7 +122,7 @@ Please follow the steps below to install RIA Toolkit OSS using pip:
pip install ria-toolkit-oss 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. 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 ### Installation from source
@ -150,7 +148,7 @@ Finally, RIA Toolkit OSS can be installed directly from the source code. This ap
### Basic usage ### Basic usage
Once the project is installed, you can import its modules, functions, and classes for use in your Python code. For example, you can use the following import statement to access the `Recording` object: Once the project is installed, you can import modules, functions, and classes from the Toolkit for use in your Python code. For example, you can use the following import statement to access the `Recording` object:
```python ```python
from ria_toolkit_oss.datatypes import Recording from ria_toolkit_oss.datatypes import Recording
@ -160,11 +158,11 @@ Additional usage information is provided in the project documentation: [RIA Tool
## 🐛 Issues ## 🐛 Issues
Kindly report any issues to the project issues board on RIA Hub: [RIA Toolkit OSS Issues Board](https://riahub.ai/qoherent/ria-toolkit-oss/issues). Kindly report any issues on RIA Hub: [RIA Toolkit OSS Issues Board](https://riahub.ai/qoherent/ria-toolkit-oss/issues).
## 🤝 Contribution ## 🤝 Contribution
Contributions are always welcome! Whether it's an enhancement, bug fix, or new usage example, your input is valuable. If you'd like to contribute to the project, please reach out to the project maintainers. Contributions are always welcome! Whether it's an enhancement, bug fix, or new example, your input is valuable. If you'd like to contribute to the project, please reach out to the project maintainers.
If you have a larger project in mind, please [contact us](https://www.qoherent.ai/contact/) directly, we'd love to collaborate with you. 🚀 If you have a larger project in mind, please [contact us](https://www.qoherent.ai/contact/) directly, we'd love to collaborate with you. 🚀
@ -197,7 +195,7 @@ To ensure a consistent development environment, this project uses [Poetry](https
poetry install poetry install
``` ```
Running `install` when a `poetry.lock` file is present resolves and installs all dependencies listed in `pyproject.toml`, but Poetry uses the exact versions listed in `poetry.lock` to ensure that the package versions are consistent for everyone working on your project. Please note that the project itself will be installed in editable mode when running `poetry install`. Running `install` when a `poetry.lock` file is present resolves and installs all dependencies listed in `pyproject.toml`, but Poetry uses the exact versions listed in `poetry.lock` to ensure that the package versions are consistent for everyone working on your project. Please note that the project itself will be installed in editable mode.
Unit tests can be run with the following command: Unit tests can be run with the following command:
```bash ```bash
@ -213,7 +211,7 @@ For more information on basic Poetry usage, start [here](https://python-poetry.o
### Sphinx ### Sphinx
Project documentation is auto-generated from project docstrings using [Sphinx](https://www.sphinx-doc.org/en/master/). Therefore, all importable components require comprehensive docstrings, complete with doctests demonstrating usage. Project documentation is auto-generated from project docstrings using [Sphinx](https://www.sphinx-doc.org/en/master/). Therefore, all importable components require complete and comprehensive docstrings, complete with [doctest](https://docs.python.org/3/library/doctest.html) usage examples.
It's recommended to use `sphinx-autobuild`, which eliminates the need to manually rebuild the docs after making changes: It's recommended to use `sphinx-autobuild`, which eliminates the need to manually rebuild the docs after making changes:
```bash ```bash
@ -237,7 +235,7 @@ For more information on basic Sphinx usage, start [here](https://sphinx-rtd-tuto
This project uses [`tox`](https://tox.wiki/en/latest/index.html) to streamline testing and release. tox runs linting and formatting checks and tests This project uses [`tox`](https://tox.wiki/en/latest/index.html) to streamline testing and release. tox runs linting and formatting checks and tests
the package across multiple version of Python. the package across multiple version of Python.
To run the tests, simply execute: Use the following command to run tests with tox:
```bash ```bash
poetry run tox poetry run tox
``` ```