Skip to content

Commit

Permalink
Upgrade to version 0.2.0 (#7)
Browse files Browse the repository at this point in the history
* Try a new readme layout

* Try another layout

* Try something else

* Try new layout

* Set border 0

* Update border = 0

* New layout

* Update StrathSDR Banners

* Remove unnecessary gifs

* Update readme instructions

* Add version 0.2.0 to pip3 install instructions
  • Loading branch information
dnorthcote authored May 20, 2021
1 parent d228260 commit 756ca89
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 35 deletions.
69 changes: 44 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,47 @@
<img src="strathclyde_banner.png" width="100%"/>
<img src="strathsdr_banner.png" />

# The Strathclyde RFSoC Studio
This repository is only compatible with [PYNQ images v2.6](https://github.com/Xilinx/PYNQ/releases) for the [ZCU111](https://www.xilinx.com/products/boards-and-kits/zcu111.html) and [RFSoC2x2](http://rfsoc-pynq.io/).

## Introduction
This repository contains the RFSoC Studio installer, which will install several demonstrations and notebooks onto your RFSoC development board.

<figure align="center">
<img src="demo_spectrum_analyser.jpg" width="100%"/>
</figure>

[RFSoC Spectrum Analyser](https://github.com/strath-sdr/rfsoc_sam)

<br>

<figure align="center">
<img src="demo_frequency_planner.jpg" width="100%"/>
</figure>

[RFSoC Frequency Planner](https://github.com/strath-sdr/rfsoc_frequency_planner)
<table border="0" align="center">
<tr border="0">
<td align="center" width="43.5%" border="0">
<img src="notebooks/images/gif/rfsoc_sam.gif" alt="oscthumb" style="width: 100%" border="0"/>
</td>
<td align="center" width="50%" border="0">
<img src="notebooks/images/gif/rfsoc_ofdm.gif" alt="oscthumb" style="width: 100%" border="0"/>
</td>
</tr>
</table>
<table border="0" align="center">
<tr border="0">
<td align="center" width="48%" border="0">
<img src="notebooks/images/gif/rfsoc_qpsk.gif" alt="oscthumb" style="width: 100%" border="0"/>
</td>
<td align="center" width="52%" border="0">
<img src="notebooks/images/gif/rfsoc_radio.gif" alt="oscthumb" style="width: 100%" border="0"/>
</td>
</tr>
</table>
<table border="0" align="center">
<tr border="0">
<td align="center" width="38.5%" border="0">
<img src="notebooks/images/gif/pynq_agc.gif" alt="oscthumb" style="width: 100%" border="0"/>
</td>
<td align="center" width="61.5%" border="0">
<img src="notebooks/images/gif/rfsoc_frequency_planner.gif" alt="oscthumb" style="width: 100%" border="0"/>
</td>
</tr>
</table>

<br>

Other demonstrations include:
RFSoC Tools and SDR demonstrations include:
* [RFSoC Spectrum Analyser](https://github.com/strath-sdr/rfsoc_sam)
* [RFSoC Frequency Planner](https://github.com/strath-sdr/rfsoc_frequency_planner)
* [OFDM Demonstrator](https://github.com/strath-sdr/rfsoc_ofdm)
* [QPSK Demonstrator](https://github.com/strath-sdr/rfsoc_qpsk)
* [BPSK Demonstrator](https://github.com/strath-sdr/rfsoc_radio)
Expand Down Expand Up @@ -57,7 +76,7 @@ pip3 uninstall -y rfsoc-sam rfsoc-freqplan rfsoc-ofdm rfsoc-qpsk rfsoc-radio pyn
* We can now install the RFSoC Studio. This will install all of the above projects and notebooks, and will also add a few additional notebooks.

```sh
pip3 install git+https://github.com/strath-sdr/rfsoc_studio
pip3 install git+https://github.com/strath-sdr/rfsoc_studio@v0.2.0
```

Once the installation has complete, your Jupyter home workspace will be populated with several folders installed by each package. You can access the `rfsoc-studio` folder and open the getting started notebook to begin using all of the demonstrations and educational resources.
Expand Down Expand Up @@ -124,7 +143,7 @@ You are using the individual installer workflow and encountered the message `zip

> _Resolution_ <br>
Simply add `--no-cache-dir` at the end of the installation command. For example: <br>
`pip3 install https://github.com/strath-sdr/pynq_agc/releases/download/v0.3/pynq_agc.tar.gz --no-cache-dir`
`pip3 install https://github.com/strath-sdr/pynq_agc/releases/download/v0.3.1/pynq_agc.tar.gz --no-cache-dir`

## Individual Package Installation <a class="anchor" id="individual_install"></a>
If you have a problem using the RFSoC-Studio installer, please run the following in your Jupyter Terminal.
Expand All @@ -138,14 +157,14 @@ pip3 uninstall -y rfsoc-sam rfsoc-freqplan rfsoc-ofdm rfsoc-qpsk rfsoc-radio pyn
* Then run individual installation for each package.

```sh
pip3 install https://github.com/strath-sdr/rfsoc_sam/archive/v0.2.2.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_frequency_planner/archive/v0.1.0.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_ofdm/archive/v0.2.0.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_qpsk/archive/v1.3.0.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_radio/archive/v0.1.0.tar.gz
pip3 install https://github.com/strath-sdr/dsp_notebooks/archive/v0.1.0.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_notebooks/archive/v0.1.0.tar.gz
pip3 install https://github.com/strath-sdr/pynq_agc/releases/download/v0.3/pynq_agc.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_sam/archive/v0.3.1.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_frequency_planner/archive/v0.1.1.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_ofdm/archive/v0.2.2.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_qpsk/archive/v1.3.1.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_radio/archive/v0.1.2.tar.gz
pip3 install https://github.com/strath-sdr/dsp_notebooks/archive/v0.1.1.tar.gz
pip3 install https://github.com/strath-sdr/rfsoc_notebooks/archive/v0.1.1.tar.gz
pip3 install https://github.com/strath-sdr/pynq_agc/releases/download/v0.3.1/pynq_agc.tar.gz
```

* Finally run the rfsoc-studio installer again to complete setup.
Expand Down
Binary file removed demo_frequency_planner.jpg
Binary file not shown.
Binary file removed demo_spectrum_analyser.jpg
Binary file not shown.
7 changes: 7 additions & 0 deletions notebooks/getting_started.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
{
"cells": [
{
"source": [
"<img src=\"images/strathsdr_banner.png\" align=\"left\">"
],
"cell_type": "markdown",
"metadata": {}
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
Binary file modified notebooks/images/gif/rfsoc_sam.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added notebooks/images/strathsdr_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion notebooks/rfsoc_studio_hub.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
{
"cells": [
{
"source": [
"<img src=\"images/strathsdr_banner.png\" align=\"left\">"
],
"cell_type": "markdown",
"metadata": {}
},
{
"cell_type": "markdown",
"metadata": {},
Expand All @@ -22,7 +29,8 @@
" * [Specialised Topics](#specialised_topics)\n",
"\n",
"## Revision History\n",
"* **v0.1** | 02/03/2021 | First RFSoC Studio Revision"
"* **v0.1** | 02/03/2021 | First RFSoC Studio Revision\n",
"* **v0.2** | 20/05/2021 | Add Strath SDR Banner"
]
},
{
Expand Down
18 changes: 9 additions & 9 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ def copy_notebooks():

setup(
name=package_name,
version='0.1.3',
version='0.2.0',
install_requires=[
'plotly==4.5.2',
'pynq==2.6',
'rfsoc-sam @ https://github.com/strath-sdr/rfsoc_sam/archive/v0.2.2.tar.gz',
'rfsoc-freqplan @ https://github.com/strath-sdr/rfsoc_frequency_planner/archive/v0.1.0.tar.gz',
'rfsoc-ofdm @ https://github.com/strath-sdr/rfsoc_ofdm/archive/v0.2.0.tar.gz',
'rfsoc-qpsk @ https://github.com/strath-sdr/rfsoc_qpsk/archive/v1.3.0.tar.gz',
'rfsoc-radio @ https://github.com/strath-sdr/rfsoc_radio/archive/v0.1.0.tar.gz',
'pystrath-dsp @ https://github.com/strath-sdr/dsp_notebooks/archive/v0.1.0.tar.gz',
'pystrath-rfsoc @ https://github.com/strath-sdr/rfsoc_notebooks/archive/v0.1.0.tar.gz',
'pynq-agc @ https://github.com/strath-sdr/pynq_agc/releases/download/v0.3/pynq_agc.tar.gz'
'rfsoc-sam @ https://github.com/strath-sdr/rfsoc_sam/archive/v0.3.1.tar.gz',
'rfsoc-freqplan @ https://github.com/strath-sdr/rfsoc_frequency_planner/archive/v0.1.1.tar.gz',
'rfsoc-ofdm @ https://github.com/strath-sdr/rfsoc_ofdm/archive/v0.2.2.tar.gz',
'rfsoc-qpsk @ https://github.com/strath-sdr/rfsoc_qpsk/archive/v1.3.1.tar.gz',
'rfsoc-radio @ https://github.com/strath-sdr/rfsoc_radio/archive/v0.1.2.tar.gz',
'pystrath-dsp @ https://github.com/strath-sdr/dsp_notebooks/archive/v0.1.1.tar.gz',
'pystrath-rfsoc @ https://github.com/strath-sdr/rfsoc_notebooks/archive/v0.1.1.tar.gz',
'pynq-agc @ https://github.com/strath-sdr/pynq_agc/releases/download/v0.3.1/pynq_agc.tar.gz'
],
author="David Northcote",
packages=find_packages(),
Expand Down
Binary file removed strathclyde_banner.png
Binary file not shown.
Binary file added strathsdr_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 756ca89

Please sign in to comment.