fastplotlib · clewis7 · Jul 26, 2024 · Jul 10, 2024 · Jul 10, 2024 · Jul 10, 2024
@@ -17,6 +17,7 @@ jobs:
   docs-build:
     name: Docs
     runs-on: bigmem
+    timeout-minutes: 10
     if: ${{ !github.event.pull_request.draft }}
     strategy:
       fail-fast: false
@@ -49,6 +50,7 @@ jobs:
   test-build-full:
     name: Test Linux, notebook + glfw
     runs-on: bigmem
+    timeout-minutes: 10
     if: ${{ !github.event.pull_request.draft }}
     strategy:
       fail-fast: false
@@ -105,6 +107,7 @@ jobs:
   test-build-desktop:
     name: Test Linux, only glfw
     runs-on: bigmem
+    timeout-minutes: 10
     if: ${{ !github.event.pull_request.draft }}
     strategy:
       fail-fast: false

@@ -14,6 +14,7 @@ jobs:
   screenshots:
     name: Regenerate
     runs-on: bigmem
+    timeout-minutes: 10
     if: ${{ !github.event.pull_request.draft }}
     steps:
       - name: Install git-lfs

@@ -0,0 +1,14 @@
+fastplotlib
+***********
+
+.. currentmodule:: fastplotlib
+
+.. autofunction:: fastplotlib.pause_events
+
+.. autofunction:: fastplotlib.enumerate_adapters
+
+.. autofunction:: fastplotlib.select_adapter
+
+.. autofunction:: fastplotlib.print_wgpu_report
+
+.. autofunction:: fastplotlib.run
@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: ImageGraphic_api
 
+    ImageGraphic.axes
     ImageGraphic.block_events
     ImageGraphic.cmap
     ImageGraphic.cmap_interpolation
@@ -41,6 +42,7 @@ Methods
 .. autosummary::
     :toctree: ImageGraphic_api
 
+    ImageGraphic.add_axes
     ImageGraphic.add_event_handler
     ImageGraphic.add_linear_region_selector
     ImageGraphic.add_linear_selector

@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: LineCollection_api
 
+    LineCollection.axes
     LineCollection.block_events
     LineCollection.cmap
     LineCollection.colors
@@ -45,6 +46,7 @@ Methods
 .. autosummary::
     :toctree: LineCollection_api
 
+    LineCollection.add_axes
     LineCollection.add_event_handler
     LineCollection.add_graphic
     LineCollection.add_linear_region_selector

@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: LineGraphic_api
 
+    LineGraphic.axes
     LineGraphic.block_events
     LineGraphic.cmap
     LineGraphic.colors
@@ -39,6 +40,7 @@ Methods
 .. autosummary::
     :toctree: LineGraphic_api
 
+    LineGraphic.add_axes
     LineGraphic.add_event_handler
     LineGraphic.add_linear_region_selector
     LineGraphic.add_linear_selector

@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: LineStack_api
 
+    LineStack.axes
     LineStack.block_events
     LineStack.cmap
     LineStack.colors
@@ -45,6 +46,7 @@ Methods
 .. autosummary::
     :toctree: LineStack_api
 
+    LineStack.add_axes
     LineStack.add_event_handler
     LineStack.add_graphic
     LineStack.add_linear_region_selector

@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: ScatterGraphic_api
 
+    ScatterGraphic.axes
     ScatterGraphic.block_events
     ScatterGraphic.cmap
     ScatterGraphic.colors
@@ -39,6 +40,7 @@ Methods
 .. autosummary::
     :toctree: ScatterGraphic_api
 
+    ScatterGraphic.add_axes
     ScatterGraphic.add_event_handler
     ScatterGraphic.clear_event_handlers
     ScatterGraphic.remove_event_handler

@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: TextGraphic_api
 
+    TextGraphic.axes
     TextGraphic.block_events
     TextGraphic.deleted
     TextGraphic.event_handlers
@@ -40,6 +41,7 @@ Methods
 .. autosummary::
     :toctree: TextGraphic_api
 
+    TextGraphic.add_axes
     TextGraphic.add_event_handler
     TextGraphic.clear_event_handlers
     TextGraphic.remove_event_handler

@@ -20,6 +20,8 @@ Properties
 .. autosummary::
     :toctree: Subplot_api
 
+    Subplot.axes
+    Subplot.background_color
     Subplot.camera
     Subplot.canvas
     Subplot.controller
@@ -60,8 +62,6 @@ Methods
     Subplot.remove_animation
     Subplot.remove_graphic
     Subplot.render
-    Subplot.set_axes_visibility
-    Subplot.set_grid_visibility
     Subplot.set_title
     Subplot.set_viewport_rect
 
@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: LinearRegionSelector_api
 
+    LinearRegionSelector.axes
     LinearRegionSelector.axis
     LinearRegionSelector.block_events
     LinearRegionSelector.deleted
@@ -39,6 +40,7 @@ Methods
 .. autosummary::
     :toctree: LinearRegionSelector_api
 
+    LinearRegionSelector.add_axes
     LinearRegionSelector.add_event_handler
     LinearRegionSelector.add_ipywidget_handler
     LinearRegionSelector.clear_event_handlers

@@ -20,6 +20,7 @@ Properties
 .. autosummary::
     :toctree: LinearSelector_api
 
+    LinearSelector.axes
     LinearSelector.axis
     LinearSelector.block_events
     LinearSelector.deleted
@@ -39,6 +40,7 @@ Methods
 .. autosummary::
     :toctree: LinearSelector_api
 
+    LinearSelector.add_axes
     LinearSelector.add_event_handler
     LinearSelector.add_ipywidget_handler
     LinearSelector.clear_event_handlers

@@ -25,7 +25,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "fastplotlib"
-copyright = "2023, Kushal Kolar, Caitlin Lewis"
+copyright = "2024, Kushal Kolar, Caitlin Lewis"
 author = "Kushal Kolar, Caitlin Lewis"
 release = fastplotlib.__version__
 
@@ -57,7 +57,8 @@
             "../../examples/desktop/line_collection",
             "../../examples/desktop/scatter",
             "../../examples/desktop/heatmap",
-            "../../examples/desktop/misc"
+            "../../examples/desktop/misc",
+            "../../examples/desktop/selectors",
         ]
     ),
     "ignore_pattern": r'__init__\.py',
@@ -102,6 +103,7 @@
     "numpy": ("https://numpy.org/doc/stable/", None),
     "pygfx": ("https://pygfx.com/stable", None),
     "wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),
+    "fastplotlib": ("https://fastplotlib.readthedocs.io/en/latest/", None),
 }
 
 html_theme_options = {

@@ -11,15 +11,15 @@ Welcome to fastplotlib's documentation!
 .. toctree::
    :maxdepth: 1
    :caption: API
-
+
+   fastplotlib <api/fastplotlib>
    Figure <api/layouts/figure>
    Subplot <api/layouts/subplot>
    Graphics <api/graphics/index>
    Graphic Features <api/graphic_features/index>
    Selectors <api/selectors/index>
    Widgets <api/widgets/index>
    Utils <api/utils>
-   GPU <api/gpu>
 
 .. toctree::
    :caption: Gallery

@@ -11,7 +11,7 @@
 import fastplotlib as fpl
 import imageio.v3 as iio
 
-figure = fpl.Figure(shape=(2, 2))
+figure = fpl.Figure(shape=(2, 2), size=(700, 560))
 
 im = iio.imread("imageio:clock.png")
 im2 = iio.imread("imageio:astronaut.png")
@@ -25,10 +25,6 @@
 
 figure.show()
 
-figure.canvas.set_logical_size(700, 560)
-
-for subplot in figure:
-    subplot.auto_scale()
 
 # NOTE: `if __name__ == "__main__"` is NOT how to use fastplotlib interactively
 # please see our docs for using fastplotlib interactively in ipython and jupyter

@@ -11,7 +11,7 @@
 import fastplotlib as fpl
 import imageio.v3 as iio
 
-figure = fpl.Figure(shape=(2, 2), controller_ids="sync")
+figure = fpl.Figure(shape=(2, 2), size=(700, 560))
 
 im = iio.imread("imageio:clock.png")
 im2 = iio.imread("imageio:astronaut.png")
@@ -23,10 +23,6 @@
 
 figure.show()
 
-figure.canvas.set_logical_size(700, 560)
-
-for subplot in figure:
-    subplot.auto_scale()
 
 # NOTE: `if __name__ == "__main__"` is NOT how to use fastplotlib interactively
 # please see our docs for using fastplotlib interactively in ipython and jupyter

@@ -14,7 +14,11 @@
 from itertools import product
 
 # define figure
-figure = fpl.Figure(shape=(2, 2), names=[["image-overlay", "circles"], ["line-stack", "scatter"]])
+figure = fpl.Figure(
+    shape=(2, 2),
+    names=[["image-overlay", "circles"], ["line-stack", "scatter"]],
+    size=(700, 560)
+)
 
 img = iio.imread("imageio:coffee.png")
 
@@ -106,8 +110,6 @@ def make_circle(center, radius: float, n_points: int = 75) -> np.ndarray:
 
 figure.show()
 
-figure.canvas.set_logical_size(700, 560)
-
 # NOTE: `if __name__ == "__main__"` is NOT how to use fastplotlib interactively
 # please see our docs for using fastplotlib interactively in ipython and jupyter
 if __name__ == "__main__":

@@ -10,22 +10,20 @@
 import fastplotlib as fpl
 import numpy as np
 
-figure = fpl.Figure()
+figure = fpl.Figure(size=(700, 560))
 
-xs = np.linspace(0, 1_000, 10_000, dtype=np.float32)
+xs = np.linspace(0, 1_000, 9_000, dtype=np.float32)
 
 sine = np.sin(np.sqrt(xs))
 
-data = np.vstack([sine * i for i in range(20_000)])
+data = np.vstack([sine * i for i in range(15_000)])
 
 # plot the image data
 img = figure[0, 0].add_image(data=data, name="heatmap")
+del data
 
 figure.show()
 
-figure.canvas.set_logical_size(700, 560)
-
-figure[0, 0].auto_scale()
 
 # NOTE: `if __name__ == "__main__"` is NOT how to use fastplotlib interactively
 # please see our docs for using fastplotlib interactively in ipython and jupyter

@@ -11,7 +11,7 @@
 import fastplotlib as fpl
 import numpy as np
 
-figure = fpl.Figure()
+figure = fpl.Figure(size=(700, 560))
 
 xs = np.linspace(0, 1_000, 10_000, dtype=np.float32)
 
@@ -24,10 +24,6 @@
 
 figure.show()
 
-figure.canvas.set_logical_size(700, 560)
-
-figure[0, 0].auto_scale()
-
 img.cmap = "viridis"
 
 # NOTE: `if __name__ == "__main__"` is NOT how to use fastplotlib interactively

@@ -10,7 +10,7 @@
 import fastplotlib as fpl
 import numpy as np
 
-figure = fpl.Figure()
+figure = fpl.Figure(size=(700, 560))
 
 xs = np.linspace(0, 1_000, 9_000, dtype=np.float32)
 
@@ -23,9 +23,6 @@
 
 figure.show()
 
-figure.canvas.set_logical_size(700, 560)
-
-figure[0, 0].auto_scale()
 cosine = np.cos(np.sqrt(xs)[:3000])
 
 # change first 2,000 rows and 3,000 columns

@@ -11,7 +11,7 @@
 import numpy as np
 
 
-figure = fpl.Figure()
+figure = fpl.Figure(size=(700, 560))
 
 xs = np.linspace(0, 1_000, 20_000, dtype=np.float32)
 
@@ -25,9 +25,6 @@
 del data  # data no longer needed after given to graphic
 figure.show()
 
-figure.canvas.set_logical_size(1500, 1500)
-
-figure[0, 0].auto_scale()
 
 if __name__ == "__main__":
     print(__doc__)