fastplotlib · kushalkolar · Jun 26, 2023 · Jun 26, 2023 · Jun 26, 2023 · Jun 26, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -61,9 +61,9 @@ jobs:
         PYGFX_EXPECT_LAVAPIPE: true
       run: |
         pytest -v examples
-        pytest --nbmake notebooks/
+        pytest --nbmake examples/notebooks/
     - uses: actions/upload-artifact@v3
       if: ${{ failure() }}
       with:
         name: screenshot-diffs
-        path: examples/diffs
+        path: examples/desktop/diffs
diff --git a/.github/workflows/screenshots.yml b/.github/workflows/screenshots.yml
@@ -48,4 +48,4 @@ jobs:
         if: always()
         with:
           name: screenshots
-          path: examples/screenshots/
+          path: examples/desktop/screenshots/
diff --git a/README.md b/README.md
@@ -77,29 +77,37 @@ pip install -e ".[notebook,docs,tests]"
 > 
 > `fastplotlib` and `pygfx` are fast evolving, you may require the latest `pygfx` and `fastplotlib` from github to use the examples in the master branch.
 
-Clone or download the repo to try the examples
+First clone or download the repo to try the examples
 
 ```bash
-# clone the repo
 git clone https://github.com/kushalkolar/fastplotlib.git
+```
+
+### Desktop examples using `glfw` or `Qt`
 
-# IMPORTANT: if you are using a specific version from pip, checkout that version to get the examples which work for that version
-# example:
-# git checkout git checkout v0.1.0.a9 # replace "v0.1.0.a9" with the version you have
+```bash
+# most dirs within examples contain example code
+cd examples/desktop
 
-# cd into notebooks and launch jupyter lab
-cd fastplotlib/notebooks
+# simplest example
+python image/image_simple.py
+```
+
+### Notebook examples
+
+```bash
+cd examples/notebooks
 jupyter lab
 ```
 
 **Start out with `simple.ipynb`.**
 
 ### Simple image plot
 ```python
-from fastplotlib import Plot
+import fastplotlib as fpl
 import numpy as np
 
-plot = Plot()
+plot = fpl.Plot()
 
 data = np.random.rand(512, 512)
 plot.add_image(data=data)
@@ -110,10 +118,10 @@ plot.show()
 
 ### Fast animations
 ```python
-from fastplotlib import Plot
+import fastplotlib as fpl
 import numpy as np
 
-plot = Plot()
+plot = fpl.Plot()
 
 data = np.random.rand(512, 512)
 image = plot.image(data=data)

diff --git a/examples/README.md b/examples/README.md
diff --git a/examples/data/iris.npy → examples/desktop/data/iris.npy b/examples/data/iris.npy → examples/desktop/data/iris.npy
diff --git a/examples/gridplot/__init__.py → examples/desktop/gridplot/__init__.py b/examples/gridplot/__init__.py → examples/desktop/gridplot/__init__.py
diff --git a/examples/gridplot/gridplot.py → examples/desktop/gridplot/gridplot.py b/examples/gridplot/gridplot.py → examples/desktop/gridplot/gridplot.py
@@ -6,17 +6,13 @@
 
 # test_example = true
 
-from fastplotlib import GridPlot
-import numpy as np
+import fastplotlib as fpl
 import imageio.v3 as iio
 
-from wgpu.gui.offscreen import WgpuCanvas
-from pygfx import WgpuRenderer
 
-canvas = WgpuCanvas()
-renderer = WgpuRenderer(canvas)
-
-plot = GridPlot(shape=(2,2), canvas=canvas, renderer=renderer)
+plot = fpl.GridPlot(shape=(2, 2))
+# to force a specific framework such as glfw:
+# plot = fpl.GridPlot(canvas="glfw")
 
 im = iio.imread("imageio:clock.png")
 im2 = iio.imread("imageio:astronaut.png")
@@ -35,7 +31,6 @@
 for subplot in plot:
     subplot.auto_scale()
 
-img = np.asarray(plot.renderer.target.draw())
-
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/image/__init__.py → examples/desktop/image/__init__.py b/examples/image/__init__.py → examples/desktop/image/__init__.py
diff --git a/examples/image/image_cmap.py → examples/desktop/image/image_cmap.py b/examples/image/image_cmap.py → examples/desktop/image/image_cmap.py
@@ -5,17 +5,13 @@
 """
 # test_example = true
 
-from fastplotlib import Plot
-import numpy as np
+import fastplotlib as fpl
 import imageio.v3 as iio
 
-from wgpu.gui.offscreen import WgpuCanvas
-from pygfx import WgpuRenderer
 
-canvas = WgpuCanvas()
-renderer = WgpuRenderer(canvas)
-
-plot = Plot(canvas=canvas, renderer=renderer)
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 im = iio.imread("imageio:camera.png")
 
@@ -30,7 +26,6 @@
 
 image_graphic.cmap = "viridis"
 
-img = np.asarray(plot.renderer.target.draw())
-
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/image/image_rgb.py → examples/desktop/image/image_rgb.py b/examples/image/image_rgb.py → examples/desktop/image/image_rgb.py
@@ -5,17 +5,13 @@
 """
 # test_example = true
 
-from fastplotlib import Plot
-import numpy as np
+import fastplotlib as fpl
 import imageio.v3 as iio
 
-from wgpu.gui.offscreen import WgpuCanvas
-from pygfx import WgpuRenderer
 
-canvas = WgpuCanvas()
-renderer = WgpuRenderer(canvas)
-
-plot = Plot(canvas=canvas, renderer=renderer)
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 im = iio.imread("imageio:astronaut.png")
 
@@ -28,7 +24,7 @@
 
 plot.auto_scale()
 
-img = np.asarray(plot.renderer.target.draw())
 
 if __name__ == "__main__":
-    print(__doc__)
+    print(__doc__)
+    fpl.run()
diff --git a/examples/image/image_rgbvminvmax.py → examples/desktop/image/image_rgbvminvmax.py b/examples/image/image_rgbvminvmax.py → examples/desktop/image/image_rgbvminvmax.py
@@ -5,17 +5,13 @@
 """
 # test_example = true
 
-from fastplotlib import Plot
-import numpy as np
+import fastplotlib as fpl
 import imageio.v3 as iio
 
-from wgpu.gui.offscreen import WgpuCanvas
-from pygfx import WgpuRenderer
 
-canvas = WgpuCanvas()
-renderer = WgpuRenderer(canvas)
-
-plot = Plot(canvas=canvas, renderer=renderer)
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 im = iio.imread("imageio:astronaut.png")
 
@@ -31,7 +27,7 @@
 image_graphic.cmap.vmin = 0.5
 image_graphic.cmap.vmax = 0.75
 
-img = np.asarray(plot.renderer.target.draw())
 
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/image/image_simple.py → examples/desktop/image/image_simple.py b/examples/image/image_simple.py → examples/desktop/image/image_simple.py
@@ -6,17 +6,13 @@
 
 # test_example = true
 
-from fastplotlib import Plot
-import numpy as np
+import fastplotlib as fpl
 import imageio.v3 as iio
 
-from wgpu.gui.offscreen import WgpuCanvas
-from pygfx import WgpuRenderer
 
-canvas = WgpuCanvas()
-renderer = WgpuRenderer(canvas)
-
-plot = Plot(canvas=canvas, renderer=renderer)
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 data = iio.imread("imageio:camera.png")
 
@@ -29,7 +25,6 @@
 
 plot.auto_scale()
 
-img = np.asarray(plot.renderer.target.draw())
-
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/image/image_vminvmax.py → examples/desktop/image/image_vminvmax.py b/examples/image/image_vminvmax.py → examples/desktop/image/image_vminvmax.py
@@ -5,18 +5,13 @@
 """
 # test_example = true
 
-from fastplotlib import Plot
-import numpy as np
-from pathlib import Path
+import fastplotlib as fpl
 import imageio.v3 as iio
 
-from wgpu.gui.offscreen import WgpuCanvas
-from pygfx import WgpuRenderer
 
-canvas = WgpuCanvas()
-renderer = WgpuRenderer(canvas)
-
-plot = Plot(canvas=canvas, renderer=renderer)
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 data = iio.imread("imageio:astronaut.png")
 
@@ -32,7 +27,7 @@
 image_graphic.cmap.vmin = 0.5
 image_graphic.cmap.vmax = 0.75
 
-img = np.asarray(plot.renderer.target.draw())
 
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/line/__init__.py → examples/desktop/line/__init__.py b/examples/line/__init__.py → examples/desktop/line/__init__.py
diff --git a/examples/line/line.py → examples/desktop/line/line.py b/examples/line/line.py → examples/desktop/line/line.py
@@ -6,11 +6,13 @@
 
 # test_example = true
 
-from fastplotlib import Plot
+import fastplotlib as fpl
 import numpy as np
 
 
-plot = Plot()
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 xs = np.linspace(-10, 10, 100)
 # sine wave
@@ -41,7 +43,7 @@
 
 plot.auto_scale()
 
-img = np.asarray(plot.renderer.target.draw())
 
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/line/line_cmap.py → examples/desktop/line/line_cmap.py b/examples/line/line_cmap.py → examples/desktop/line/line_cmap.py
@@ -11,6 +11,8 @@
 
 
 plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 xs = np.linspace(-10, 10, 100)
 # sine wave
@@ -43,4 +45,5 @@
 plot.canvas.set_logical_size(800, 800)
 
 if __name__ == "__main__":
+    print(__doc__)
     fpl.run()
diff --git a/examples/line/line_colorslice.py → examples/desktop/line/line_colorslice.py b/examples/line/line_colorslice.py → examples/desktop/line/line_colorslice.py
@@ -6,11 +6,13 @@
 
 # test_example = true
 
-from fastplotlib import Plot
+import fastplotlib as fpl
 import numpy as np
 
 
-plot = Plot()
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 xs = np.linspace(-10, 10, 100)
 # sine wave
@@ -64,3 +66,4 @@
 
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/line/line_dataslice.py → examples/desktop/line/line_dataslice.py b/examples/line/line_dataslice.py → examples/desktop/line/line_dataslice.py
@@ -6,11 +6,13 @@
 
 # test_example = true
 
-from fastplotlib import Plot
+import fastplotlib as fpl
 import numpy as np
 
 
-plot = Plot()
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 xs = np.linspace(-10, 10, 100)
 # sine wave
@@ -53,3 +55,4 @@
 
 if __name__ == "__main__":
     print(__doc__)
+    fpl.run()
diff --git a/examples/line/line_present_scaling.py → ...ples/desktop/line/line_present_scaling.py b/examples/line/line_present_scaling.py → ...ples/desktop/line/line_present_scaling.py
@@ -6,11 +6,13 @@
 
 # test_example = true
 
-from fastplotlib import Plot
+import fastplotlib as fpl
 import numpy as np
 
 
-plot = Plot()
+plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 xs = np.linspace(-10, 10, 100)
 # sine wave
@@ -47,4 +49,4 @@
 
 if __name__ == "__main__":
     print(__doc__)
-
+    fpl.run()
diff --git a/examples/line_collection/__init__.py → examples/desktop/line_collection/__init__.py b/examples/line_collection/__init__.py → examples/desktop/line_collection/__init__.py
diff --git a/examples/line_collection/line_collection.py → ...esktop/line_collection/line_collection.py b/examples/line_collection/line_collection.py → ...esktop/line_collection/line_collection.py
@@ -28,6 +28,8 @@ def make_circle(center, radius: float, n_points: int = 75) -> np.ndarray:
 pos_xy = np.vstack(circles)
 
 plot = fpl.Plot()
+# to force a specific framework such as glfw:
+# plot = fpl.Plot(canvas="glfw")
 
 plot.add_line_collection(circles, cmap="jet", thickness=5)
 
@@ -36,4 +38,5 @@ def make_circle(center, radius: float, n_points: int = 75) -> np.ndarray:
 plot.canvas.set_logical_size(800, 800)
 
 if __name__ == "__main__":
+    print(__doc__)
     fpl.run()