Uptading installation instructions in the project docs set
All checks were successful
Build Sphinx Docs Set / Build Docs (push) Successful in 13s
Test with tox / Test with tox (3.11) (push) Successful in 32s
Test with tox / Test with tox (3.12) (push) Successful in 32s
Test with tox / Test with tox (3.10) (push) Successful in 41s
Build Project / Build Project (3.11) (push) Successful in 47s
Build Project / Build Project (3.10) (push) Successful in 50s
Build Project / Build Project (3.12) (push) Successful in 49s
All checks were successful
Build Sphinx Docs Set / Build Docs (push) Successful in 13s
Test with tox / Test with tox (3.11) (push) Successful in 32s
Test with tox / Test with tox (3.12) (push) Successful in 32s
Test with tox / Test with tox (3.10) (push) Successful in 41s
Build Project / Build Project (3.11) (push) Successful in 47s
Build Project / Build Project (3.10) (push) Successful in 50s
Build Project / Build Project (3.12) (push) Successful in 49s
This commit is contained in:
parent
7cd8d3556b
commit
49857071d2
|
@ -4,4 +4,4 @@ Contribution
|
||||||
Contributions are always welcome! Whether it's an enhancement, bug fix, or new usage examples, your input is valuable.
|
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.
|
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.
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
Getting Started
|
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.
|
||||||
|
|
|
@ -1,30 +1,69 @@
|
||||||
Installation
|
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 <https://anaconda.org/ryanvolz/radioconda>`_ environment,
|
We want your experience with RIA Toolkit OSS to be as smooth and frictionless as possible. If you run into any
|
||||||
which provides pre-configured packages and libraries required for common SDR devices. Radioconda installation and setup instructions
|
issues during installation, please reach out to our support team: ``support@qoherent.ai``.
|
||||||
can be found in the project README: `radioconda-installer <https://github.com/radioconda/radioconda-installer>`_.
|
|
||||||
|
|
||||||
Install RIA Toolkit OSS into the base environment:
|
Installation with Conda (recommended)
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
Conda package for RIA Toolkit OSS are available on the RIA Hub
|
||||||
|
`here <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.
|
||||||
|
|
||||||
|
Please follow the steps below to install RIA Toolkit OSS using Conda:
|
||||||
|
|
||||||
|
1. Before installing RIA Toolkit OSS into your Conda environment, update the Conda package manager:
|
||||||
|
|
||||||
|
.. code-block:: 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 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
|
.. code-block:: bash
|
||||||
|
|
||||||
conda activate base
|
conda activate base
|
||||||
conda install ria-toolkit-oss
|
conda install ria-toolkit-oss
|
||||||
|
|
||||||
.. note::
|
4. After installing RIA Toolkit OSS, verify that the installation was successful by running:
|
||||||
|
|
||||||
**(Coming soon)** Install RIA Toolkit OSS from RIA Hub's Conda Package Registry.
|
.. code-block:: bash
|
||||||
|
|
||||||
Installation from PyPI / RIA Hub
|
conda list
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
You can also install RIA Toolkit OSS in a standard Python virtual environment using Pip.
|
If installation was successful, you should see a line item for `ria-toolkit-oss`:
|
||||||
Addition information on Python virtual environments can be found here: `W3Schools: Python Virtual Environment <https://www.w3schools.com/python/python_virtualenv.asp>`_.
|
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
ria-toolkit-oss <version> <build> 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 <https://riahub.ai/qoherent/-/packages/pypi/ria-toolkit-oss>`_ and PyPI
|
||||||
|
`here <https://pypi.org/project/ria-toolkit-oss/>`_.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
1. Create and activate a Python virtual environment:
|
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
|
python -m venv venv
|
||||||
venv\Scripts\activate
|
venv\Scripts\activate
|
||||||
|
|
||||||
|
2. Install RIA Toolkit OSS from PyPI with pip:
|
||||||
2. Install RIA Toolkit OSS with Pip:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
pip install ria-toolkit-oss
|
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
|
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:
|
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
|
cd ria-toolkit-oss
|
||||||
|
|
||||||
3. Install the package:
|
3. Install with pip:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
pip install .
|
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 .
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user