fastplotlib · kushalkolar · Jun 14, 2023 · Apr 19, 2023 · Apr 19, 2023 · Apr 19, 2023
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+*.png filter=lfs diff=lfs merge=lfs -text
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+
+  test-build:
+    name: Test examples
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Test py39
+            pyversion: '3.9'
+          - name: Test py310
+            pyversion: '3.10'
+          - name: Test py311
+            pyversion: '3.11'
+    steps:
+    - name: Install git-lfs
+      run: |
+        sudo apt install --no-install-recommends -y  git-lfs
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.pyversion }}
+    - name: Install llvmpipe and lavapipe for offscreen canvas
+      run: |
+        sudo apt-get update -y -qq
+        sudo apt-get install --no-install-recommends -y libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers git-lfs
+    - name: Install dev dependencies
+      run: |
+        python -m pip install --upgrade pip
+        # remove pygfx from requirements, we install a specific commit of pygfx since both fpl and pygfx are fast evolving
+        sed -i "/pygfx/d" ./setup.py
+        pip install git+https://github.com/pygfx/pygfx.git@b63f22a1aa61993c32cd96895316cb8248a81e4d
+        pip install -e ".["tests"]"
+    - name: Show wgpu backend
+      run:
+        python -c "from examples.tests.testutils import wgpu_backend; print(wgpu_backend)"
+    - name: fetch git lfs files
+      run: |
+        git lfs fetch --all
+        git lfs pull
+    - name: Test examples
+      env:
+        PYGFX_EXPECT_LAVAPIPE: true
+      run: |
+        pytest -v examples
+        pytest --nbmake notebooks/
+    - uses: actions/upload-artifact@v3
+      if: ${{ failure() }}
+      with:
+        name: screenshot-diffs
+        path: examples/diffs
diff --git a/.github/workflows/screenshots.yml b/.github/workflows/screenshots.yml
@@ -0,0 +1,45 @@
+name: Screenshots
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  screenshots:
+    name: Regenerate
+    runs-on: 'ubuntu-latest'
+    steps:
+      - name: Install git-lfs
+        run: |
+          sudo apt install --no-install-recommends -y  git-lfs
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install llvmpipe and lavapipe for offscreen canvas
+        run: |
+          sudo apt-get update -y -qq
+          sudo apt-get install --no-install-recommends -y libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers
+      - name: Install dev dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # remove pygfx from requirements, we install a specific commit of pygfx since both fpl and pygfx are fast evolving
+          sed -i "/pygfx/d" ./setup.py
+          pip install git+https://github.com/pygfx/pygfx.git@b63f22a1aa61993c32cd96895316cb8248a81e4d
+          pip install -e ".["tests"]"
+      - name: Show wgpu backend
+        run:
+          python -c "from examples.tests.testutils import wgpu_backend; print(wgpu_backend)"
+      - name: Test examples
+        env:
+          PYGFX_EXPECT_LAVAPIPE: true
+        run: |
+          # regenerate screenshots
+          REGENERATE_SCREENSHOTS=1 pytest -v examples
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: screenshots
+          path: examples/screenshots/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,25 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  apt_packages:
+    - libegl1-mesa
+    - libgl1-mesa-dri
+    - libxcb-xfixes0-dev
+    - mesa-vulkan-drivers
+    - libglfw3
+  jobs:
+    pre_install:
+      - pip install git+https://github.com/pygfx/pygfx.git@main
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
diff --git a/README.md b/README.md
@@ -21,6 +21,9 @@ Questions, ideas? Post an issue or [chat on gitter](https://gitter.im/fastplotli
 
 **See the examples directory. Start out with `simple.ipynb`.**
 
+**IMPORTANT NOTE: If you install `fastplotlib` and `pygfx` from `pypi` (i.e. pip install pygfx), you will need to use the examples from this commit until `pygfx` publishes a new release to `pypi`: https://github.com/kushalkolar/fastplotlib/tree/f872155eb687b18e3cc9b3b720eb9e241a9f974c/examples .** 
+The current examples will work if you installed `fastplotlib` and `pygfx` directly from github.
+
 ### Neuroscience usecase demonstrating some of fastplotlib's capabilities
 
 https://user-images.githubusercontent.com/9403332/210304485-e554b648-50b4-4243-b292-a9ed30514a2d.mp4

diff --git a/docs/source/api/graphic_features.rst b/docs/source/api/graphic_features.rst
@@ -0,0 +1,81 @@
+.. _api_graphic_features:
+
+Graphic Features
+****************
+
+Image
+#####
+
+.. autoclass:: fastplotlib.graphics.features.ImageDataFeature
+    :members:
+    :inherited-members: 
+    :exclude-members: __init__
+    :no-undoc-members:
+
+.. autoclass:: fastplotlib.graphics.features.ImageCmapFeature
+    :members:
+    :inherited-members: 
+    :exclude-members: __init__
+    :no-undoc-members:
+
+Heatmap
+#######
+
+.. autoclass:: fastplotlib.graphics.features.HeatmapDataFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+.. autoclass:: fastplotlib.graphics.features.HeatmapCmapFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+Line
+####
+
+.. autoclass:: fastplotlib.graphics.features.PositionsDataFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+.. autoclass:: fastplotlib.graphics.features.ColorsFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+.. autoclass:: fastplotlib.graphics.features.ThicknessFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+Scatter
+#######
+
+.. autoclass:: fastplotlib.graphics.features.PositionsDataFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+.. autoclass:: fastplotlib.graphics.features.ColorsFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
+
+Common
+######
+
+Features common to all graphics
+
+.. autoclass:: fastplotlib.graphics.features.PresentFeature
+    :members:
+    :inherited-members:
+    :exclude-members: __init__
+    :no-undoc-members:
diff --git a/docs/source/api/graphics.rst b/docs/source/api/graphics.rst
@@ -30,18 +30,11 @@ Line Stack
 .. autoclass:: fastplotlib.graphics.line_collection.LineStack
     :members:
     :inherited-members:
-
-Line Slider
-###########
-
-.. autoclass:: fastplotlib.graphics.line_slider.LineSlider
-    :members:
-    :inherited-members:
 
 Heatmap
 #######
 
-.. autoclass:: fastplotlib.graphics.heatmap.HeatmapGraphic
+.. autoclass:: fastplotlib.graphics.image.HeatmapGraphic
     :members:
     :inherited-members:
 

diff --git a/docs/source/api/selectors.rst b/docs/source/api/selectors.rst
@@ -0,0 +1,15 @@
+.. _api_selectors:
+
+Selectors
+*********
+
+Linear
+######
+
+.. autoclass:: fastplotlib.graphics.selectors.LinearSelector
+    :members:
+    :inherited-members:
+
+.. autoclass:: fastplotlib.graphics.selectors.LinearRegionSelector
+    :members:
+    :inherited-members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,12 +17,11 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = ["sphinx.ext.napoleon", "sphinx.ext.autodoc"]
-autodoc_typehints = "description"
 
 templates_path = ['_templates']
 exclude_patterns = []
 
-
+napoleon_custom_sections = ['Features']
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -32,9 +31,12 @@
 
 html_static_path = ['_static']
 
-autodoc_member_order = 'bysource'
+autodoc_member_order = 'groupwise'
 autoclass_content = "both"
 
+autodoc_typehints = "description"
+autodoc_typehints_description_target = "documented_params"
+
 def _setup_navbar_side_toctree(app: Any):
 
     def add_class_toctree_function(app: Any, pagename: Any, templatename: Any, context: Any, doctree: Any):

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,6 +14,8 @@ Welcome to fastplotlib's documentation!
    Subplot <api/subplot>
    Gridplot <api/gridplot>
    Graphics <api/graphics>
+   Graphic Features <api/graphic_features>
+   Selectors <api/selectors>
    Widgets <api/widgets>
 
 Summary

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,6 @@
+# Examples
+
+**IMPORTANT NOTE: If you install `fastplotlib` and `pygfx` from `pypi`, i.e. `pip install pygfx`, you will need to use the examples from the following commit until `pygfx` publishes a new release to `pypi`: https://github.com/kushalkolar/fastplotlib/tree/f872155eb687b18e3cc9b3b720eb9e241a9f974c/examples . 
+The current examples will work if you installed `fastplotlib` and `pygfx` directly from github**
+
+Both `fastplotlib` and `pygfx` are rapidly evolving libraries, and we try to closely track `pygfx`.