docs: improve getting_started and installation readability #30

Closed

gillian wants to merge 0 commits from docs/sdr-guides-update into main

pull from: docs/sdr-guides-update

merge into: qoherent:main

qoherent:main

qoherent:agent-naming-fix

qoherent:zfp-oss

qoherent:screens-connection

qoherent:dataset-manager-v2

Conversation 0 Commits - Files Changed -

G

G gillian commented 2026-04-24 14:36:38 -04:00

Owner

Copy Link

• 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

- 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

gillian added 1 commit 2026-04-24 14:36:38 -04:00

G 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

2c1fba75da

G gillian requested review from muq 2026-04-24 14:36:43 -04:00

gillian added 1 commit 2026-04-24 14:36:55 -04:00

G Merge branch 'main' into docs/sdr-guides-update a4cd158b2a

gillian added 1 commit 2026-04-28 11:28:50 -04:00

F docs: enhance getting started guide with example output and image reference 9a304faa00

gillian added 2 commits 2026-04-28 14:09:03 -04:00

G Changed datasets to data to match utils 4c94f6ae94

G refactor: unify signal viewer styling and update docs screenshots ...

- Align view_simple and view_full on background colour (#161616), title
  size (25pt), subtitle size (15pt), base font/tick/label sizes, grid
  style (alpha=0.2), and legend fontsize (10pt)
- Spectrogram placed above IQ plot in view_simple; subplot renamed from
  "Time Series" to "IQ Sample Plot"
- Frequency and spectrogram Y-axes formatted in MHz across both viewers
- Added xlabel/ylabel, subtle grids, and IQ legend to view_full subplots
- Fixed spectrogram right-side clipping in view_simple by syncing xlim
  from specgram output rather than total signal duration
- Updated getting_started.rst to reference both simple and full viewer
  screenshots; replaced doc images with latest renders

e5a3d327e5

madrigal added 1 commit 2026-04-29 09:55:40 -04:00

M Formatting, updated lock file 4ce42fa71a

M madrigal approved these changes 2026-04-29 10:00:07 -04:00

M madrigal left a comment

Member

Copy Link

Looks good

Looks good

gillian added 2 commits 2026-04-30 10:31:58 -04:00

G fix: harden annotation pipeline and CLI robustness ...

- Replace bare metadata["sample_rate"] access with .get() + clear
  ValueError in threshold_qualifier, energy_detector, cusum_annotator,
  parallel_signal_separator, and signal_isolation
- Add --sample-rate option to energy, threshold, cusum, and separate
  CLI commands with a pre-flight error if sample rate is still absent
- Normalize namespaced metadata keys (e.g. BlockGenerator:Foo:sample_rate)
  to standard keys on legacy .npy load
- Cap threshold_qualifier smoothing window at 1% of signal length to
  prevent over-smoothing short recordings into a flat envelope
- Warn when threshold or energy detector returns 0 annotations due to
  constant-envelope signal; point to cusum as the right tool
- Enforce --overwrite before any work begins; error fires before load
  and detection, not after
- Fix qualify_slice off-by-one that silently dropped the last slice
- Surface split failures in parallel_signal_separator via warnings.warn
  instead of swallowing them silently
- Add threshold annotation example image to getting_started docs

0a1bef8453

G Merge branch 'docs/sdr-guides-update' of https://riahub.ai/qoherent/ria-toolkit-oss into docs/sdr-guides-update 04099fdbac

gillian added 1 commit 2026-05-05 14:32:04 -04:00

F docs: expand getting_started with real command output, examples, and images ...

- Add example output for every section 4 command (discover, init, capture,
  view, annotate, convert, split, combine, generate, transform, transmit)
- Add examples for all annotate subcommands (list, add, remove, clear,
  energy, threshold, cusum, separate)
- Clarify separate workflow: requires existing annotations as input;
  show threshold → separate two-step example with before/after images
- Regenerate all viewer images using updated viewer (post e5a3d32 styling)
- Add images for energy, threshold, cusum, and separate annotation views,
  AWGN transform output, and qam64_35 simple/full views
- Reorder annotate subcommands: manual first, auto-detection second
- Simplify section 3 workflow to one command per step with links to section 4
- Remove all italic inline option-group labels and redundant sub-headers
- Rewrite generate subcommand options as a table; consolidate capture and
  transmit option lists

18666d95ee

gillian added 1 commit 2026-05-05 14:36:05 -04:00

F docs: add generated viewer images for getting_started examples c2dc2e6d43

gillian added 1 commit 2026-05-12 12:20:02 -04:00

F Fix flake8 E501 line too long in annotate.py separate() signature ...

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

3b8b55ae7a

gillian added 1 commit 2026-05-12 13:11:07 -04:00

F Fix flake8 E501 and C901 violations in annotate.py and annotation classes ...

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

f23bac08a1

gillian added 1 commit 2026-05-12 13:22:30 -04:00

G Drop Python 3.10 support, minimum is now 3.11 ...

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

70c790cadd

gillian added 1 commit 2026-05-12 13:33:24 -04:00

G Fix duplicate 3.11 key in tox gh-actions config ...

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

657dd0d499

gillian added 2 commits 2026-05-12 13:39:35 -04:00

G Revert "Fix duplicate 3.11 key in tox gh-actions config" ...

This reverts commit 657dd0d499.

57d1d6e55e

G Revert "Drop Python 3.10 support, minimum is now 3.11" ...

This reverts commit 70c790cadd.

7ef3fe8fb1

G gillian referenced this issue from a commit 2026-05-12 14:05:25 -04:00

Merge pull request 'docs: improve getting_started and installation readability' (#30) from docs/sdr-guides-update into main

G gillian closed this pull request 2026-05-12 14:18:03 -04:00

Some checks failed

Hide all checks

Test with tox / Test with tox (3.11) (pull_request) Successful in 15m58s

Details

Build Sphinx Docs Set / Build Docs (pull_request) Successful in 18m3s

Details

Build Project / Build Project (3.10) (pull_request) Successful in 21m51s

Details

Test with tox / Test with tox (3.10) (pull_request) Failing after 21m59s

Details

Build Project / Build Project (3.11) (pull_request) Successful in 22m37s

Details

Build Project / Build Project (3.12) (pull_request) Successful in 22m35s

Details

Test with tox / Test with tox (3.12) (pull_request) Successful in 6m53s

Details

Pull request closed

This pull request cannot be reopened because the branch was deleted.

Sign in to join this conversation.

Reviewers

No reviewers

Mmuq

Mmadrigal

Labels

Clear labels

  

CI/CD 🛠️

This issue relates to our automated testing, building, and publishing processes

  

WIP 🚧

Someone is currently worked on this issue

  

bug 🐞

There is a problem, error, or unexpected behaviour

  

code quality 🧹

This issues pertains to code quality improvements or tech debt reduction

  

data collection 🗃️

This issue involves machine learning data collection or filing

  

dependency 📦

This issue pertains to dependency changes or deprecation warnings

  

do not merge 🚫

This pull request is not to be merged

  

documentation 📝

Improvements or additions to documentation or tutorials

  

duplicate 🔄

This issue or pull request already exists

  

enhancement ✨

This issue is important and will require attention soon, but does not pose any immediate risks

  

good first issue 🌱

A good first issue for newcomers

  

help wanted 👋

Additional development support is required

  

inference 🧠

This issue involves designing or improving inference solutions

  

invalid 🛑

Something is wrong with this issue or it not does conform to project guidelines

  

machine learning 🚀

This issue pertains to and may require expertise in machine learning

  

priority

high🔥

This issue is critical and requires immediate attention to prevent further consequence or escalation

  

priority

low 🍃

  

priority

medium 🌟

This issue is important and will require attention soon, but does not pose any immediate risks

  

quantum ⚛️

This issue pertains to and may require expertise in quantum technology

  

question ❓

Additional information is required

  

radio 📡

This issue involves radio interface components and may requires access to radio hardware

  

sprintable 🏃‍♂️

This issue could be resolved in a single sprint

  

test 🧪

This issue pertains to our testing efforts

  

wont fix ❌

We've chosen not to address this issue

No Label

CI/CD 🛠️

WIP 🚧

bug 🐞

code quality 🧹

data collection 🗃️

dependency 📦

do not merge 🚫

documentation 📝

duplicate 🔄

enhancement ✨

good first issue 🌱

help wanted 👋

inference 🧠

invalid 🛑

machine learning 🚀

priority

high🔥

priority

low 🍃

priority

medium 🌟

quantum ⚛️

question ❓

radio 📡

sprintable 🏃‍♂️

test 🧪

wont fix ❌

Milestone

Clear milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

No Assignees

2 Participants

G M

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: qoherent/ria-toolkit-oss#30

No description provided.