From c550aa628ef3defa0bb81919227134934873efda Mon Sep 17 00:00:00 2001 From: michael Date: Fri, 12 Sep 2025 15:10:18 -0400 Subject: [PATCH] Moving usage examples into their own folder --- docs/source/examples/index.rst | 13 +++++++++++++ docs/source/examples/sdr/index.rst | 14 ++++++++++++++ .../sdr/examples => examples/sdr}/rx.rst | 18 +++++++++++------- .../sdr/examples => examples/sdr}/tx.rst | 14 ++++++++------ docs/source/index.rst | 3 ++- .../{sdr => }/ria_toolkit_oss.sdr.rst | 11 ----------- 6 files changed, 48 insertions(+), 25 deletions(-) create mode 100644 docs/source/examples/index.rst create mode 100644 docs/source/examples/sdr/index.rst rename docs/source/{ria_toolkit_oss/sdr/examples => examples/sdr}/rx.rst (75%) rename docs/source/{ria_toolkit_oss/sdr/examples => examples/sdr}/tx.rst (83%) rename docs/source/ria_toolkit_oss/{sdr => }/ria_toolkit_oss.sdr.rst (60%) diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst new file mode 100644 index 0000000..f018b6f --- /dev/null +++ b/docs/source/examples/index.rst @@ -0,0 +1,13 @@ +.. _examples: + +######## +Examples +######## + +This section contains usage examples designed to help you get started with RIA Toolkit OSS. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + SDR Examples diff --git a/docs/source/examples/sdr/index.rst b/docs/source/examples/sdr/index.rst new file mode 100644 index 0000000..525e983 --- /dev/null +++ b/docs/source/examples/sdr/index.rst @@ -0,0 +1,14 @@ +.. _examples: + +############ +SDR Examples +############ + +This section contains examples of how to use the SDR package in RIA Toolkit OSS, such as receiving and transmitting signals. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + Example 1: SDR Reception + Example 2: SDR Transmission diff --git a/docs/source/ria_toolkit_oss/sdr/examples/rx.rst b/docs/source/examples/sdr/rx.rst similarity index 75% rename from docs/source/ria_toolkit_oss/sdr/examples/rx.rst rename to docs/source/examples/sdr/rx.rst index 5ec0975..a314b42 100644 --- a/docs/source/ria_toolkit_oss/sdr/examples/rx.rst +++ b/docs/source/examples/sdr/rx.rst @@ -1,9 +1,7 @@ .. _rx: -Rx Example -========== - -This example code for getting started with RIA Toolkit OSS SDR package. +Example 1: SDR Reception +======================== .. contents:: :local: @@ -18,8 +16,8 @@ In this example, we use the [bladeRF](https://www.nuand.com/bladerf-1/). However this package presents a common interface for all SDR devices, the same code can be used to interface with additional supported radios. -Example 1: Recording a Signal ------------------------------ +Code +---- In this example, we initialize the `Blade` SDR, configure it to record a signal for a specified duration. @@ -47,4 +45,10 @@ In this example, we initialize the `Blade` SDR, configure it to record a signal end = time.time() print(f"Total time: {end - start} seconds") - print(f"Length of the recording: {len(my_rec)} samples") \ No newline at end of file + print(f"Length of the recording: {len(my_rec)} samples") + +Conclusion +---------- + +This example demonstrates how to use the ``Blade`` class to receive samples into a ``Recording`` object. By customizing the parameters, +we can adapt this example to various signal processing and SDR tasks. diff --git a/docs/source/ria_toolkit_oss/sdr/examples/tx.rst b/docs/source/examples/sdr/tx.rst similarity index 83% rename from docs/source/ria_toolkit_oss/sdr/examples/tx.rst rename to docs/source/examples/sdr/tx.rst index b053b32..4975f1d 100644 --- a/docs/source/ria_toolkit_oss/sdr/examples/tx.rst +++ b/docs/source/examples/sdr/tx.rst @@ -1,9 +1,7 @@ .. _tx: -Tx Example -========== - -This example code for getting started with RIA Toolkit OSS SDR package. +Example 2: SDR Transmission +=========================== .. contents:: :local: @@ -14,11 +12,15 @@ Introduction This example illustrates how to generate a custom chirp signal and transmit it using the ``Blade`` SDR. The waveform is created using the ``numpy`` library and encapsulated in a ``Recording`` object. +Code +---- + .. code-block:: python import time import numpy as np + from ria_toolkit_oss.datatypes.recording import Recording from ria_toolkit_oss.sdr.blade import Blade @@ -63,5 +65,5 @@ created using the ``numpy`` library and encapsulated in a ``Recording`` object. Conclusion ---------- -These examples provide a foundation for working with SDRs using the ``Blade`` class. By customizing the parameters, -you can adapt these scripts to various signal processing and SDR tasks. +This example demonstrates how to use the ``Blade`` class to transmit a custom waveform. By customizing the parameters, +we can adapt this example to various signal processing and SDR tasks. diff --git a/docs/source/index.rst b/docs/source/index.rst index 0e1e9d1..1ac0e62 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,8 +6,9 @@ RIA Toolkit OSS Documentation Introduction SDR Guides + Examples Datatypes Package - SDR Package + SDR Package IO Package Transforms Package Utils Package diff --git a/docs/source/ria_toolkit_oss/sdr/ria_toolkit_oss.sdr.rst b/docs/source/ria_toolkit_oss/ria_toolkit_oss.sdr.rst similarity index 60% rename from docs/source/ria_toolkit_oss/sdr/ria_toolkit_oss.sdr.rst rename to docs/source/ria_toolkit_oss/ria_toolkit_oss.sdr.rst index cafc7cc..0ac9cfe 100644 --- a/docs/source/ria_toolkit_oss/sdr/ria_toolkit_oss.sdr.rst +++ b/docs/source/ria_toolkit_oss/ria_toolkit_oss.sdr.rst @@ -7,17 +7,6 @@ SDR Package (ria_toolkit_oss.sdr) :inherited-members: :show-inheritance: -SDR Code Examples ------------------ - -This section contains usage examples designed to help you get started with the RIA Toolkit OSS SDR package. - -.. toctree:: - :maxdepth: 2 - - Rx Example - Tx Example - Radio Classes -------------