Compare commits

..

No commits in common. "27d3c4cf92c9cb1511aa98e3327d165882e2e62f" and "84e1336bbd4ffd22edbe7c7914457abbf1cf6bd6" have entirely different histories.

2 changed files with 88 additions and 50 deletions

View File

@ -12,6 +12,10 @@
<a href="https://pypi.org/project/ria-toolkit-oss/">
<img src="https://img.shields.io/pypi/v/ria-toolkit-oss"/>
</a>
<!-- Conda-Forge -->
<a href="https://anaconda.org/conda-forge/ria-toolkit-oss/">
<img src="https://img.shields.io/conda/vn/conda-forge/ria-toolkit-oss"/>
</a>
<!-- License -->
<a href="https://www.gnu.org/licenses/agpl-3.0">
<img src="https://img.shields.io/badge/License-AGPLv3-blue.svg" />
@ -46,60 +50,24 @@ 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.
The RIA Hub Toolkit OSS is available on [PyPI](https://pypi.org/project/ria-toolkit-oss/), [Conda Forge](https://anaconda.org/conda-forge/ria-toolkit-oss), and [RIA Hub](https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss/).
### Installation with Conda (recommended)
### Installation from Conda Forge (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).
While the RIA Toolkit OSS can be installed into any Conda environment, 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).
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.
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:
```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 the RIA Hub Conda Package Registry to your Conda channel configuration:
```bash
conda config --add channels https://raihub.ai/api/packages/qoherent/conda --prepend
```
3. Activate your base Radioconda environment and install RIA Toolkit OSS:
Install RIA Toolkit OSS into the base environment:
```bash
conda activate base
conda install ria-toolkit-oss
```
4. Verify the installation
(Coming soon) Install RIA Toolkit OSS from RIA Hub's Conda Package Registry.
After installing RIA Toolkit OSS, confirm that it was successfully installed by running:
### Installation from PyPI / RIA Hub
```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:
```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
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. 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:
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:
@ -118,17 +86,21 @@ venv\Scripts\activate
</details>
2. Install RIA Toolkit OSS from PyPI with Pip:
2. Install RIA Toolkit OSS with Pip:
```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.
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.
```bash
pip install --index-url https://riahub.ai/api/packages/qoherent/pypi/simple/ ria-toolkit-oss --no-deps
```
### 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:
You can also install RIA Toolkit OSS directly from the source code:
1. Clone the repository. For example:
```bash
@ -136,13 +108,11 @@ git clone https://riahub.ai/qoherent/ria-toolkit-oss.git
```
2. Navigate into the project directory:
```bash
cd ria-toolkit-oss
```
3. Install the package with pip:
3. Install the package:
```bash
pip install .
```
@ -150,7 +120,6 @@ pip install .
### 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:
```python
from ria_toolkit_oss.datatypes import Recording
```

69
meta.yaml Normal file
View File

@ -0,0 +1,69 @@
# To release a new version of RIA Toolkit OSS on Conda-Forge, please update this
# recipe by addressing the below comments. Please refrain from versioning
# any updates to this file unless they are expected to persist across all
# or many future releases. Please remember to remove all comments prior
# to staging this recipe.
{% set name = "ria-toolkit-oss" %}
# Enter the version number below, and then remove this comment. Please
# use the version identifier of the release you want to upload to Conda-Forge,
# which is not necessarily the current version indicated in pyproject.toml.
# E.g., {% set version = "0.1.2" %}
{% set version = "..." %}
package:
name: {{ name|lower }}
version: {{ version }}
source:
url: https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/ria-toolkit-oss-{{ version }}.tar.gz
# Copy the SHA256 **source** distribution hash from PyPI: https://pypi.org/project/ria-toolkit-oss/#files,
# paste it below, and then remove this comment. Please use the hash corresponding the version
# identifier entered above.
# E.g., sha256: d32879a4e1b3e102fc5d65338f623764fbfb197570e536a5dfd57197aeec74c5
sha256: ...
build:
number: 0
noarch: python
script: {{ PYTHON }} -m pip install . --no-deps -vv
requirements:
host:
- python >=3.10
- poetry
- pip
run:
# Confirm that all the runtime dependencies are listed here, and then
# remove this comment. Please include all dependencies within the
# [dependencies] section in pyproject.toml.
- python >=3.10
- numpy ==1.26.4
- scipy <1.16
- sigmf >=1.2.10,<2.0.0
- quantiphy >=2.20,<3.0
- plotly >=6.3.0,<7.0.0
- h5py >=3.14.0,<4.0.0
- pandas >=2.3.2,<3.0.0
test:
imports:
- ria_toolkit_oss
commands:
- pip check
requires:
- pip
about:
home: https://riahub.ai/qoherent/ria-toolkit-oss
summary: Radio Intelligence Apps' open-source core, by Qoherent 📡🚀
description: |
An open-source version of the RIA Toolkit, including the fundamental tools to get started developing, testing, and deploying radio intelligence applications
license: AGPL-3.0-only
license_file: LICENSE
extra:
recipe-maintainers:
# Ensure there are at least 2 maintainers listed, notify all maintainers
# of your intent to publish, and then remove this comment.
- mrl280
- benChinnery