Deliver overlay with the package into the site-package directory. Fix #…

…50 - Include pynq.overlays entry point in setup.py - Update notebooks to only use bitstream name
Xilinx · Feb 1, 2022 · eac23b1 · eac23b1
1 parent 5ea3059
commit eac23b1
Show file tree

Hide file tree

Showing 23 changed files with 27 additions and 25 deletions.
diff --git a/boards/KV260/notebooks/applications/01_difference_gaussians_app.ipynb b/boards/KV260/notebooks/applications/01_difference_gaussians_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import DifferenceGaussians, VSource, VSink\n",
     "\n",
-    "app = DifferenceGaussians(\"../overlay/cv_dfx_4_pr.bit\", VSource.MIPI, VSink.DP)"
+    "app = DifferenceGaussians(\"cv_dfx_4_pr.bit\", VSource.MIPI, VSink.DP)"
    ]
   },
   {

diff --git a/boards/KV260/notebooks/applications/02_corner_detect_app.ipynb b/boards/KV260/notebooks/applications/02_corner_detect_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import CornerDetect, VSource, VSink\n",
     "\n",
-    "app = CornerDetect(\"../overlay/cv_dfx_4_pr.bit\", VSource.MIPI, sink=VSink.DP)"
+    "app = CornerDetect(\"cv_dfx_4_pr.bit\", VSource.MIPI, sink=VSink.DP)"
    ]
   },
   {

diff --git a/boards/KV260/notebooks/applications/03_color_detect_app.ipynb b/boards/KV260/notebooks/applications/03_color_detect_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import ColorDetect, VSource, VSink\n",
     "\n",
-    "app = ColorDetect(\"../overlay/cv_dfx_4_pr.bit\", VSource.MIPI, sink=VSink.DP)"
+    "app = ColorDetect(\"cv_dfx_4_pr.bit\", VSource.MIPI, sink=VSink.DP)"
    ]
   },
   {

diff --git a/boards/KV260/notebooks/applications/04_color_detect_app_webcam.ipynb b/boards/KV260/notebooks/applications/04_color_detect_app_webcam.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import ColorDetect, VSource, VSink\n",
     "\n",
-    "app = ColorDetect(\"../overlay/cv_dfx_4_pr.bit\", VSource.OpenCV, sink=VSink.DP)"
+    "app = ColorDetect(\"cv_dfx_4_pr.bit\", VSource.OpenCV, sink=VSink.DP)"
    ]
   },
   {

diff --git a/boards/KV260/notebooks/applications/05_color_detect_app_file.ipynb b/boards/KV260/notebooks/applications/05_color_detect_app_file.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import ColorDetect, VSource, VSink\n",
     "\n",
-    "app = ColorDetect(\"../overlay/cv_dfx_4_pr.bit\", VSource.OpenCV, sink=VSink.DP, file='../mountains.mp4')"
+    "app = ColorDetect(\"cv_dfx_4_pr.bit\", VSource.OpenCV, sink=VSink.DP, file='../mountains.mp4')"
    ]
   },
   {

diff --git a/boards/KV260/notebooks/custom_pipeline/08_webcam_pipeline.ipynb b/boards/KV260/notebooks/custom_pipeline/08_webcam_pipeline.ipynb
@@ -59,7 +59,7 @@
     "from pynq_composable import *\n",
     "from ipywidgets import widgets, interact, FloatSlider, IntSlider\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/boards/Pynq-Z2/notebooks/applications/04_filter2d_app.ipynb b/boards/Pynq-Z2/notebooks/applications/04_filter2d_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import Filter2DApp\n",
     "\n",
-    "app = Filter2DApp(\"../overlay/cv_dfx_4_pr.bit\")"
+    "app = Filter2DApp(\"cv_dfx_4_pr.bit\")"
    ]
   },
   {

diff --git a/boards/Pynq-Z2/notebooks/applications/05_lut_app.ipynb.ipynb b/boards/Pynq-Z2/notebooks/applications/05_lut_app.ipynb.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import LutApp\n",
     "\n",
-    "app = LutApp(\"../overlay/cv_dfx_4_pr.bit\")"
+    "app = LutApp(\"cv_dfx_4_pr.bit\")"
    ]
   },
   {

diff --git a/boards/Pynq-ZU/notebooks/applications/06_mipi_difference_gaussians_app.ipynb b/boards/Pynq-ZU/notebooks/applications/06_mipi_difference_gaussians_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import DifferenceGaussians, VSource\n",
     "\n",
-    "app = DifferenceGaussians(\"../overlay/cv_dfx_4_pr.bit\", VSource.MIPI)"
+    "app = DifferenceGaussians(\"cv_dfx_4_pr.bit\", VSource.MIPI)"
    ]
   },
   {

diff --git a/boards/Pynq-ZU/notebooks/applications/07_mipi_corner_detect_app.ipynb b/boards/Pynq-ZU/notebooks/applications/07_mipi_corner_detect_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import CornerDetect, VSource\n",
     "\n",
-    "app = CornerDetect(\"../overlay/cv_dfx_4_pr.bit\", VSource.MIPI)"
+    "app = CornerDetect(\"cv_dfx_4_pr.bit\", VSource.MIPI)"
    ]
   },
   {

diff --git a/boards/Pynq-ZU/notebooks/custom_pipeline/09_mipi_pipeline.ipynb b/boards/Pynq-ZU/notebooks/custom_pipeline/09_mipi_pipeline.ipynb
@@ -59,7 +59,7 @@
     "from pynq_composable import *\n",
     "import numpy as np\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/applications/01_difference_gaussians_app.ipynb b/pynq_composable/notebooks/applications/01_difference_gaussians_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import DifferenceGaussians\n",
     "\n",
-    "app = DifferenceGaussians(\"../overlay/cv_dfx_4_pr.bit\")"
+    "app = DifferenceGaussians(\"cv_dfx_4_pr.bit\")"
    ]
   },
   {

diff --git a/pynq_composable/notebooks/applications/02_corner_detect_app.ipynb b/pynq_composable/notebooks/applications/02_corner_detect_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import CornerDetect\n",
     "\n",
-    "app = CornerDetect(\"../overlay/cv_dfx_4_pr.bit\")"
+    "app = CornerDetect(\"cv_dfx_4_pr.bit\")"
    ]
   },
   {

diff --git a/pynq_composable/notebooks/applications/03_color_detect_app.ipynb b/pynq_composable/notebooks/applications/03_color_detect_app.ipynb
@@ -52,7 +52,7 @@
    "source": [
     "from pynq_composable import ColorDetect\n",
     "\n",
-    "app = ColorDetect(\"../overlay/cv_dfx_4_pr.bit\")"
+    "app = ColorDetect(\"cv_dfx_4_pr.bit\")"
    ]
   },
   {

diff --git a/pynq_composable/notebooks/custom_pipeline/01_composable_overlay_intro.ipynb b/pynq_composable/notebooks/custom_pipeline/01_composable_overlay_intro.ipynb
@@ -85,7 +85,7 @@
     "from pynq import Overlay\n",
     "import pynq_composable\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")"
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")"
    ]
   },
   {

diff --git a/pynq_composable/notebooks/custom_pipeline/02_first_custom_pipeline.ipynb b/pynq_composable/notebooks/custom_pipeline/02_first_custom_pipeline.ipynb
@@ -59,7 +59,7 @@
     "from pynq.lib.video import *\n",
     "from pynq_composable import *\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/custom_pipeline/03_introspect_pipeline.ipynb b/pynq_composable/notebooks/custom_pipeline/03_introspect_pipeline.ipynb
@@ -59,7 +59,7 @@
     "from pynq.lib.video import *\n",
     "from pynq_composable import *\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/custom_pipeline/04_modify_pipeline.ipynb b/pynq_composable/notebooks/custom_pipeline/04_modify_pipeline.ipynb
@@ -57,7 +57,7 @@
     "from pynq.lib.video import *\n",
     "from pynq_composable import *\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/custom_pipeline/05_dynamic_ip.ipynb b/pynq_composable/notebooks/custom_pipeline/05_dynamic_ip.ipynb
@@ -58,7 +58,7 @@
     "from pynq.lib.video import *\n",
     "from  pynq_composable import *\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/custom_pipeline/06_build_application.ipynb b/pynq_composable/notebooks/custom_pipeline/06_build_application.ipynb
@@ -63,7 +63,7 @@
     "from pynq.lib.video import *\n",
     "from pynq_composable import *\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/custom_pipeline/07_advanced_features.ipynb b/pynq_composable/notebooks/custom_pipeline/07_advanced_features.ipynb
@@ -56,7 +56,7 @@
     "from pynq.lib.video import *\n",
     "from pynq_composable import *\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/pynq_composable/notebooks/custom_pipeline/08_webcam_pipeline.ipynb b/pynq_composable/notebooks/custom_pipeline/08_webcam_pipeline.ipynb
@@ -60,7 +60,7 @@
     "from ipywidgets import widgets, interact, FloatSlider, IntSlider\n",
     "from pynq.ps import CPU_ARCH, ZYNQ_ARCH\n",
     "\n",
-    "ol = Overlay(\"../overlay/cv_dfx_4_pr.bit\")\n",
+    "ol = Overlay(\"cv_dfx_4_pr.bit\")\n",
     "\n",
     "cpipe = ol.composable"
    ]

diff --git a/setup.py b/setup.py
@@ -24,7 +24,7 @@
 board = os.environ["BOARD"]
 board_folder = "boards/{}".format(board)
 notebooks_dir = os.environ["PYNQ_JUPYTER_NOTEBOOKS"]
-overlay_dest = "{}/notebooks/".format(module_name)
+overlay_dest = "{}/".format(module_name)
 data_files = []
 cwd = os.getcwd()
 
@@ -170,8 +170,10 @@ def download_overlay(board, overlay_dest):
     ],
     entry_points={
         "pynq.notebooks": [
-            "pynq-composable = {}.notebooks".format(
-                module_name)
+            "pynq-composable = {}.notebooks".format(module_name)
+        ],
+        "pynq.overlays": [
+            "{} = {}.overlay".format(module_name, module_name)
         ]
     },
     cmdclass={"build_py": build_py},