From 537207ca9194240fbed9cd8b6b1eb09f50a96f5c Mon Sep 17 00:00:00 2001 From: michael Date: Fri, 3 Oct 2025 10:01:28 -0400 Subject: [PATCH] Formatting updates to setup instructions in the SDR guides --- docs/source/intro/getting_started.rst | 2 +- docs/source/sdr_guides/blade.rst | 32 +++++----- docs/source/sdr_guides/hackrf.rst | 46 +++++++------- docs/source/sdr_guides/index.rst | 7 +-- docs/source/sdr_guides/pluto.rst | 91 ++++++++++++++------------- docs/source/sdr_guides/usrp.rst | 47 +++++++------- 6 files changed, 111 insertions(+), 114 deletions(-) diff --git a/docs/source/intro/getting_started.rst b/docs/source/intro/getting_started.rst index ed8e14b..928e753 100644 --- a/docs/source/intro/getting_started.rst +++ b/docs/source/intro/getting_started.rst @@ -4,4 +4,4 @@ Getting Started .. todo:: Getting started instructions are coming soon! In the meantime, feel free - to explore the project documentation, where many components include usage examples. + to explore the project documentation. Many components include usage examples. diff --git a/docs/source/sdr_guides/blade.rst b/docs/source/sdr_guides/blade.rst index b52ffd6..41641b6 100644 --- a/docs/source/sdr_guides/blade.rst +++ b/docs/source/sdr_guides/blade.rst @@ -41,37 +41,37 @@ Limitations transfer rates. Set up instructions (Linux, Radioconda) ---------------------------- +--------------------------------------- -Step 1: Activate your Radioconda environment. +1. Activate your Radioconda environment. -.. code-block:: bash + .. code-block:: bash - conda activate + conda activate -Step 2: Install the base dependencies and drivers ('Easy method') +2. Install the base dependencies and drivers (*Easy method*): -.. code-block:: bash + .. code-block:: bash sudo add-apt-repository ppa:nuandllc/bladerf sudo apt-get update sudo apt-get install bladerf sudo apt-get install libbladerf-dev - sudo apt-get install bladerf-fpga-hostedxa4 # Necessary for installation of bladeRF 2.0 Micro A4. + sudo apt-get install bladerf-fpga-hostedxa4 # Necessary for installation of bladeRF 2.0 Micro A4. -Step 3: Install a udev rule by creating a link into your radioconda installation. +3. Install a ``udev`` rule by creating a link into your Radioconda installation: -.. code-block:: bash + .. code-block:: bash - sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/88-nuand-bladerf1.rules /etc/udev/rules.d/88-radioconda-nuand-bladerf1.rules - sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/88-nuand-bladerf2.rules /etc/udev/rules.d/88-radioconda-nuand-bladerf2.rules - sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/88-nuand-bootloader.rules /etc/udev/rules.d/88-radioconda-nuand-bootloader.rules - sudo udevadm control --reload - sudo udevadm trigger + sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/88-nuand-bladerf1.rules /etc/udev/rules.d/88-radioconda-nuand-bladerf1.rules + sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/88-nuand-bladerf2.rules /etc/udev/rules.d/88-radioconda-nuand-bladerf2.rules + sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/88-nuand-bootloader.rules /etc/udev/rules.d/88-radioconda-nuand-bootloader.rules + sudo udevadm control --reload + sudo udevadm trigger Further Information ------------------- -- `Official Website `_ +- `Official BladeRF Website `_ - `BladeRF GitHub Repository `_ -- `Radioconda Github Repository ` +- `BladeRF Setup with Radioconda `_ diff --git a/docs/source/sdr_guides/hackrf.rst b/docs/source/sdr_guides/hackrf.rst index 741e140..6f65a6d 100644 --- a/docs/source/sdr_guides/hackrf.rst +++ b/docs/source/sdr_guides/hackrf.rst @@ -40,46 +40,44 @@ Limitations - USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs. Set up instructions (Linux, Radioconda) ---------------------------- +--------------------------------------- -Step 1: Activate your Radioconda environment. +1. Activate your Radioconda environment: -.. code-block:: bash + .. code-block:: bash - conda activate + conda activate -Step 2: Install the System Package (Ubuntu / Debian) +2. Install the System Package (Ubuntu / Debian): -.. code-block:: bash + .. code-block:: bash - sudo apt-get update - sudo apt-get install hackrf + sudo apt-get update + sudo apt-get install hackrf -Step 3: Install a udev rule by creating a link into your radioconda installation. +3. Install a ``udev`` rule by creating a link into your Radioconda installation: -.. code-block:: bash + .. code-block:: bash - sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/53-hackrf.rules /etc/udev/rules.d/53-radioconda-hackrf.rules - sudo udevadm control --reload - sudo udevadm trigger + sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/53-hackrf.rules /etc/udev/rules.d/53-radioconda-hackrf.rules + sudo udevadm control --reload + sudo udevadm trigger -Make sure your user account belongs to the plugdev group in order to access your device: + Make sure your user account belongs to the plugdev group in order to access your device: -.. code-block:: bash + .. code-block:: bash - sudo usermod -a -G plugdev + sudo usermod -a -G plugdev -You may have to restart for this change to take effect. - ---------------------------- - -`HackRF Software Installation Guide `_ +.. note:: + You may have to restart your system for changes to take effect. Further information ------------------- -- `Official Website `_ -- `Project Documentation `_ +- `Official HackRF Website `_ +- `HackRF Project Documentation `_ +- `HackRF Software Installation Guide `_ - `HackRF GitHub Repository `_ -- `Radioconda Github Repository ` +- `HackRF Setup with Radioconda `_ diff --git a/docs/source/sdr_guides/index.rst b/docs/source/sdr_guides/index.rst index de6df14..2e14fc7 100644 --- a/docs/source/sdr_guides/index.rst +++ b/docs/source/sdr_guides/index.rst @@ -10,8 +10,7 @@ their key capabilities and limitations, and any additional information needed fo .. toctree:: :maxdepth: 2 - BladeRF - HackRF - PlutoSDR USRP - RTL-SDR + BladeRF + PlutoSDR + HackRF diff --git a/docs/source/sdr_guides/pluto.rst b/docs/source/sdr_guides/pluto.rst index 61413b8..2eaa475 100644 --- a/docs/source/sdr_guides/pluto.rst +++ b/docs/source/sdr_guides/pluto.rst @@ -44,72 +44,73 @@ Limitations - USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs. Set up instructions (Linux, Radioconda) ---------------------------- +--------------------------------------- -Step 1: Activate your Radioconda environment. +1. Activate your Radioconda environment: -.. code-block:: bash + .. code-block:: bash conda activate -Step 2: Install system dependancies. +2. Install system dependencies: -.. code-block:: bash + .. code-block:: bash sudo apt-get update sudo apt-get install -y \ - build-essential \ - git \ - libxml2-dev \ - bison \ - flex \ - libcdk5-dev \ - cmake \ - libusb-1.0-0-dev \ - libavahi-client-dev \ - libavahi-common-dev \ - libaio-dev + build-essential \ + git \ + libxml2-dev \ + bison \ + flex \ + libcdk5-dev \ + cmake \ + libusb-1.0-0-dev \ + libavahi-client-dev \ + libavahi-common-dev \ + libaio-dev +3. Install a ``udev`` rule by creating a link into your Radioconda installation: -Step 3: Install a udev rule by creating a link into your radioconda installation. + .. code-block:: bash -.. code-block:: bash + sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/90-libiio.rules /etc/udev/rules.d/90-radioconda-libiio.rules + sudo udevadm control --reload + sudo udevadm trigger - sudo ln -s $CONDA_PREFIX/lib/udev/rules.d/90-libiio.rules /etc/udev/rules.d/90-radioconda-libiio.rules - sudo udevadm control --reload - sudo udevadm trigger + Once you can talk to the hardware, you may want to perform the post-install steps detailed on the `PlutoSDR Documentation `_. -Once you can talk to the hardware, you may want to perform the post-install steps detailed on the PlutoSDR documentation below. +4. (Optional) Building ``libiio`` or ``libad9361-iio`` from source: -Step 4 (Optional): Building libiio or libad9361-iio from source. + This step is only required if you want the latest version of these libraries not provided in Radioconda. -Only needed if you want the very latest version of the libraries not provided in Radioconda: + .. code-block:: bash -.. code-block:: bash + # Build libiio from source + cd ~ + git clone --branch v0.23 https://github.com/analogdevicesinc/libiio.git + cd libiio + mkdir -p build + cd build + cmake -DPYTHON_BINDINGS=ON .. + make -j"$(nproc)" + sudo make install + sudo ldconfig - # Clone and build libiio - cd ~ - git clone --branch v0.23 https://github.com/analogdevicesinc/libiio.git - cd libiio - mkdir -p build - cd build - cmake -DPYTHON_BINDINGS=ON .. - make -j"$(nproc)" - sudo make install - sudo ldconfig + .. code-block:: bash - # Clone and build libad9361-iio - cd ~ - git clone https://github.com/analogdevicesinc/libad9361-iio.git - cd libad9361-iio - mkdir -p build - cd build - cmake .. - make -j"$(nproc)" - sudo make install + # Build libad9361-iio from source + cd ~ + git clone https://github.com/analogdevicesinc/libad9361-iio.git + cd libad9361-iio + mkdir -p build + cd build + cmake .. + make -j"$(nproc)" + sudo make install Further information ------------------- - `PlutoSDR Documentation `_ -- `Radioconda Github Repository ` \ No newline at end of file +- `PlutoSDR Setup with Radioconda `_ \ No newline at end of file diff --git a/docs/source/sdr_guides/usrp.rst b/docs/source/sdr_guides/usrp.rst index d88775b..e4aa614 100644 --- a/docs/source/sdr_guides/usrp.rst +++ b/docs/source/sdr_guides/usrp.rst @@ -42,52 +42,51 @@ Limitations - Price range can be a consideration, especially for high-end models. Set up instructions (Linux, Radioconda) ---------------------------- +--------------------------------------- -Step 1: Activate your Radioconda environment. +1. Activate your Radioconda environment: -.. code-block:: bash + .. code-block:: bash - conda activate + conda activate -Step 2: Install UHD and Python Bindings. +2. Install UHD and Python bindings: -.. code-block:: bash + .. code-block:: bash - conda install conda-forge::uhd + conda install conda-forge::uhd -Step 3: Download UHD images. +3. Download UHD images: -.. code-block:: bash + .. code-block:: bash uhd_images_downloader -Step 4: Verify Installation. +4. Verify access to your device: -To verify access to your device: + .. code-block:: bash -.. code-block:: bash + uhd_find_devices - uhd_find_devices + For USB devices only (e.g. B series), install a ``udev`` rule by creating a link into your Radioconda installation. -For USB devices only (e.g. B series), install a udev rule by creating a link into your radioconda installation. + .. code-block:: bash -.. code-block:: bash - sudo ln -s $CONDA_PREFIX/lib/uhd/utils/uhd-usrp.rules /etc/udev/rules.d/radioconda-uhd-usrp.rules - sudo udevadm control --reload - sudo udevadm trigger + sudo ln -s $CONDA_PREFIX/lib/uhd/utils/uhd-usrp.rules /etc/udev/rules.d/radioconda-uhd-usrp.rules + sudo udevadm control --reload + sudo udevadm trigger -Step 5: (optional): Update Firmware/FPGA images +5. (Optional) Update firmware/FPGA images: -.. code-block:: bash + .. code-block:: bash - uhd_usrp_probe + uhd_usrp_probe -This will ensure your device is running the latest firmware and FPGA versions. + This will ensure your device is running the latest firmware and FPGA versions. Further information ------------------- -- `Official Website `_ +- `Official USRP Website `_ - `USRP Documentation `_ -- `Radioconda Github Repository `_ +- `USRP Setup with Radioconda `_