qoherent/ria-toolkit-oss
19
6
Fork 0
Code Issues Pull Requests 1 Workflows Packages Projects Releases 6 Wiki Activity

docs: improve getting_started and installation readability #30

Open
gillian wants to merge 6 commits from docs/sdr-guides-update into main
pull from: docs/sdr-guides-update
merge into: qoherent:main
Conversation 0 Commits 6 Files Changed 10 +16 -11
2 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 9a304faa00 - Show all commits

6
docs/source/intro/getting_started.rst
View File

@ -413,6 +413,12 @@ Device selection (``--device``) is optional if only one device is detected. Exac
ria view capture.npy --type full --title "Test Capture" --format pdf
ria view capture.npy --show --no-save
ria view old.npy --legacy --type simple
ria view recordings\qam64_35.npy --type simple
.. figure:: ../images/qam64_35.png
:alt: Example output of ria view recordings\qam64_35.npy --type simple
Output of ``ria view recordings\qam64_35.npy --type simple``
.. _cmd-annotate:

19
src/ria_toolkit_oss/view/tools.py
View File

@ -32,16 +32,15 @@ def extract_metadata_fields(metadata):
def set_path(output_path):
split_path = output_path.split("/")
path = pathlib.Path(output_path)
if len(split_path) == 1:
folder = "images"
file = split_path[0]
elif len(split_path) > 2:
file = split_path[-1]
folder = "/".join(split_path[:-1])
# If only filename provided (no directory), use default 'images' folder
if len(path.parts) == 1:
folder = pathlib.Path("images")
file = path.name
else:
folder, file = split_path
folder = path.parent
file = path.name
split_file = file.split(".")
if len(split_file) == 2:
@ -53,5 +52,5 @@ def set_path(output_path):
extension = "png"
file = file + ".png"
pathlib.Path(folder).mkdir(parents=True, exist_ok=True)
return "/".join([folder, file]), extension
folder.mkdir(parents=True, exist_ok=True)
return str(folder / file), extension