Updating installation instructions now that Conda packages are available on the RIA Hub Conda Package Registry
Some checks failed
Build Project / Build Project (3.10) (push) Failing after 0s
Build Project / Build Project (3.11) (push) Failing after 0s
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 12s
Test with tox / Test with tox (3.12) (push) Successful in 24s
Some checks failed
Build Project / Build Project (3.10) (push) Failing after 0s
Build Project / Build Project (3.11) (push) Failing after 0s
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 12s
Test with tox / Test with tox (3.12) (push) Successful in 24s
This commit is contained in:
parent
5cb1b1b3e0
commit
27d3c4cf92
69
README.md
69
README.md
|
@ -12,10 +12,6 @@
|
|||
<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" />
|
||||
|
@ -50,24 +46,60 @@ RIA Toolkit OSS is the open-source version of the RIA Toolkit, providing the fun
|
|||
|
||||
## 🚀 Getting started
|
||||
|
||||
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/).
|
||||
RIA Hub Toolkit OSS can be installed either as a standard Python package or as a Conda package.
|
||||
|
||||
### Installation from Conda Forge (recommended)
|
||||
### Installation with Conda (recommended)
|
||||
|
||||
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 is available is available as a Conda packages on the [RIA Hub Conda Package Registry](https://riahub.ai/qoherent/-/packages/conda/ria-toolkit-oss).
|
||||
|
||||
Install RIA Toolkit OSS into the base environment:
|
||||
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:
|
||||
|
||||
```bash
|
||||
conda activate base
|
||||
conda install ria-toolkit-oss
|
||||
```
|
||||
|
||||
(Coming soon) Install RIA Toolkit OSS from RIA Hub's Conda Package Registry.
|
||||
4. Verify the installation
|
||||
|
||||
### Installation from PyPI / RIA Hub
|
||||
After installing RIA Toolkit OSS, confirm that it was successfully installed by running:
|
||||
|
||||
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).
|
||||
```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:
|
||||
|
||||
1. Create and activate a Python virtual environment:
|
||||
|
||||
|
@ -86,21 +118,17 @@ venv\Scripts\activate
|
|||
|
||||
</details>
|
||||
|
||||
2. Install RIA Toolkit OSS with Pip:
|
||||
2. Install RIA Toolkit OSS from PyPI with Pip:
|
||||
|
||||
```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.
|
||||
|
||||
```bash
|
||||
pip install --index-url https://riahub.ai/api/packages/qoherent/pypi/simple/ ria-toolkit-oss --no-deps
|
||||
```
|
||||
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
|
||||
|
||||
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:
|
||||
```bash
|
||||
|
@ -108,11 +136,13 @@ 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:
|
||||
3. Install the package with pip:
|
||||
|
||||
```bash
|
||||
pip install .
|
||||
```
|
||||
|
@ -120,6 +150,7 @@ 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
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue
Block a user