32 Commits

Author	SHA1	Message	Date
F fordg1	9a304faa00	docs: enhance getting started guide with example output and image reference	2026-04-28 11:27:47 -04:00
Ggillian	a4cd158b2a	Merge branch 'main' into docs/sdr-guides-update	2026-04-24 14:36:53 -04:00
Ggillian	2c1fba75da	docs: improve getting_started and installation readability ... - Consolidate installation steps into installation.rst (pip upgrade, ria --help verification, entrypoints note, editable install note, SDR driver table); replace getting_started §1 body with a link - Reformat command and subcommand lists as tables with purpose descriptions and internal ref links for navigation - Remove redundant §6 tips and §9 cheat sheet; trim duplicate descriptions in generate subcommand sections - Fix inline code comments to sit beside the command they describe - Add custom CSS for light body text, white headings, and table header colour to suit the dark background theme	2026-04-24 14:34:11 -04:00
Ggillian	4df5455af4	Merge branch 'main' into docs/sdr-guides-update	2026-04-24 10:36:18 -04:00
Mmadrigal	8a66860d33	Moved all contents of to , refactored accordingly	2026-04-21 14:38:06 -04:00
Mmuq	a68a325cb4	Update SDR guides and fix Sphinx warnings for release ... Fix Sphinx build errors: - Add missing blank lines in rtlsdr.rst code-block directives - Rename duplicate label in examples/sdr/index.rst - Fix field list indentation in usrp.py and hackrf.py docstrings Update SDR setup guides (all guides now cover both pip/venv and Radioconda): - rtlsdr: switch to rtl-sdr-blog fork (required for rtlsdr_set_dithering symbol), add pyrtlsdr==0.3.0 and setuptools==69.5.1 version pinning, preserve Radioconda blacklist and udev symlink paths alongside new steps - pluto: simplify primary path to apt install libiio, add Avahi network discovery note, preserve Radioconda udev symlink as alternative - hackrf: note out-of-box support, preserve Radioconda udev symlink - blade: note no extra Python packages needed, preserve Radioconda udev symlinks - usrp: add build-from-source path for pip/venv users with cmake flags, Python binding copy step, and version mismatch warning; keep conda install as primary option; preserve Radioconda udev symlink - thinkrf: add lib2to3 install step, Python <=3.12 restriction, and full Python 3 patching command to replace internal script reference Update copyright year to 2026 in conf.py	2026-04-21 12:29:18 -04:00
Mmadrigal	d6c66d2a07	Merge branch 'main' of https://riahub.ai/qoherent/ria-toolkit-oss into annotationsfix	2026-04-20 14:38:57 -04:00
Ggillian	e506d26450	Replaces the getting_started.rst placeholder with a full CLI reference ... covering installation, commands, YAML config patterns, and a cheat sheet. Adds custom CSS/JS for heading colours, warning admonition styling, code block colours, and ria command highlighting. Fixes .gitignore to exclude docs/_build/.	2026-04-20 13:10:31 -04:00
Ggillian	138fdeb68b	Added getting started guide	2026-04-20 13:06:54 -04:00
Ggillian	8e542919a8	updated tags for new release	2026-04-20 11:21:36 -04:00
F fordg1	11d9532b5c	Port annotation system from utils and fix ria package imports ... Annotations package (new): - Add threshold_qualifier with 3-pass hysteresis detector (Pass 1: strong bursts, Pass 2: weak residual bursts, Pass 3: macro-window faint burst detection), auto window_size scaled to 1ms, channel selection, and stable noise_floor baseline throughout - Add energy_detector, cusum_annotator, parallel_signal_separator, qualify_slice, signal_isolation, annotation_transforms - Add __init__.py exporting the four functions used by the CLI - Fix all imports from utils.data → ria_toolkit_oss.datatypes CLI annotate command (new): - Port full annotate CLI from utils including list, add, remove, clear, energy, cusum, threshold, and separate subcommands - Fix imports from utils.* → ria_toolkit_oss.* and utils_cli.* → ria_toolkit_oss_cli.* - Safe overwrite logic: _annotated files always writable, originals protected; --overwrite writes in-place only on _annotated inputs CLI view command: - Add 'annotations' as a valid --type, wiring view_annotations from view_signal view_signal.py: - Add view_annotations function with blue/purple alternating palette and threshold %-sorted drawing order (lower % renders on top) recording.py (datatypes): - Fix lazy imports in to_wav() and to_blue() from utils.io → ria_toolkit_oss.io io/recording.py: - Add compatibility shim in from_npy to remap utils.data.annotation.Annotation to ria_toolkit_oss.datatypes.annotation.Annotation when loading .npy files pickled by the utils package	2026-03-31 13:34:00 -04:00
Ggillian	ca45c5e86d	Added extra blacklist items to rtlsdr.rst	2025-11-14 11:01:51 -05:00
benchinnery	c237164a68	Merge branch 'main' into pytorch-widgets	2025-11-13 10:32:26 -05:00
ben	b8ccead21e	Updated to Version 0.1.4	2025-10-27 11:50:03 -04:00
Mmadrigal	79aa1fc0a4	Added RTL and ThinkRF documentation	2025-10-17 16:35:23 -04:00
michael	42af1a2c1e	Incrementing version numbers from v0.1.2 -> v0.1.3	2025-10-03 15:27:54 -04:00
michael	3a27515a96	Removing RTL-SDR mock import, as the RTL-SDR is not yet supported by the SDR package	2025-10-03 13:18:19 -04:00
michael	9cbb9716af	- Updating README with list of supported SDR devices ... - Adding note to installation instructions (both in the README and project docs) that SDR drivers must be installed separately	2025-10-03 10:22:54 -04:00
michael	537207ca91	Formatting updates to setup instructions in the SDR guides	2025-10-03 10:01:28 -04:00
Ggillian	e88148c312	rtl.rst removed until further notice	2025-10-02 15:19:29 -04:00
Ggillian	cc373a89f6	sdr_guides instructions updated for compatibility with radioconda	2025-09-29 16:24:18 -04:00
michael	312c55189e	Moving the Sphinx-generated API reference into it's package so it is not at top level	2025-09-12 15:38:49 -04:00
michael	c550aa628e	Moving usage examples into their own folder	2025-09-12 15:38:49 -04:00
michael	469e9422c6	Updating SDR guides	2025-09-12 15:38:49 -04:00
michael	26723c146a	Adding SDR package contents	2025-09-12 15:38:49 -04:00
michael	86d988ee55	Minor typo fix: "Conda package for RIA Toolkit OSS ..." -> "Conda packages for RIA Toolkit OSS ..."	2025-09-10 16:02:03 -04:00
michael	8135b5c872	Bumping version number from v0.1.1 -> v0.1.2	2025-09-10 16:00:50 -04:00
michael	49857071d2	Uptading installation instructions in the project docs set	2025-09-10 15:15:10 -04:00
michael	6c0dafd733	Bump version number from v0.1.0 to v0.1.1	2025-09-05 13:06:05 -04:00
michael	9f5579de0b	Adding project logo	2025-09-04 15:09:13 -04:00
michael	b4b8d27bfd	Minor fixes to docs layout and coloring	2025-09-04 14:04:33 -04:00
michael	131dc3f933	Adding Sphinx docs set	2025-09-04 12:29:54 -04:00