/RFSoC-Book

Companion Jupyter Notebooks for the RFSoC-Book.

Primary LanguageJupyter NotebookBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Software Defined Radio with Zynq® UltraScale+ RFSoC

This repository contains the companion Jupyter Notebooks for the Software Defined Radio with Zynq® UltraScale+ RFSoC book.

oscthumb
Free Download & Printed Edition

To begin installing the Jupyter Notebooks on your system, click-on one of the options below.

RFSoC Setup

This repository is currently only compatible with RFSoC-PYNQ v2.7 and greater. Follow the steps below to setup the RFSoC platform for installing the companion Jupyter Notebooks.

  1. Currently, there are 5 compatible RFSoC platforms. These are listed as follows:

  1. Install PYNQ v2.7 or greater onto an SD card and plug it in to your RFSoC platform.

  2. Your RFSoC platform requires internet access to install the companion Jupyter Notebooks. Follow the instructions here that assist with internet access.

  3. Navigate to JupyterLab by opening a browser (preferably Chrome) and connecting to http://<board_ip_address>:9090/lab.

Notebook Installation

The companion Jupyter Notebooks can be installed on a computer or RFSoC platform. Follow the instructions below to install the notebooks through JupyterLab. If you haven't already, launch JupyterLab on your computer or RFSoC platform.

  1. We need to open a terminal in JupyterLab. Firstly, open a launcher window as given in the following figure.

  1. Now open a terminal in Jupyter as shown below:

  1. Install the RFSoC Book notebooks through PIP by executing the following command in the terminal.
pip install https://github.com/strath-sdr/RFSoC-Book/archive/v1.1.0.tar.gz
  1. Run the following command in the Jupyter terminal window to install the notebooks and dependencies.
python -m rfsoc_book install
  1. The RFSoC-Book notebooks are installed. Navigate to the JupyterLab workspace and you will find the notebooks in a folder named rfsoc_book.

Additional Commands

The RFSoC Book module provides additional commands for those that would like to clean notebooks after use, or uninstall notebooks from their system.

Notebooks can be reset by running the following command in the Jupyter terminal.

python -m rfsoc_book clean

To uninstall all notebooks and dependencies, run the command below in the Jupyter terminal.

python -m rfsoc_book uninstall

Warning and Disclaimer

The best efforts of the authors have been used to ensure that accurate and current information is presented in this repository. This includes researching the topics covered and developing examples. The material included is provided on an "as-is" basis in the best of faith, and the authors do not make any warranty of any kind, expressed, or implied, with regard to the documentation contained in this repository. The authors shall not be held liable for any loss or damage resulting directly or indirectly from any information or examples contained herein.

Copyright © 2023 Strathclyde Academic Media