fastquadtree 0.8.1__tar.gz → 0.9.1__tar.gz

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/.github/workflows/release.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Install Python test deps into .venv
         run: |
           . .venv/bin/activate
-          pip install -U pip pytest pytest-cov
+          pip install -e '.[dev]'
 
       - name: Run Python tests
         run: |

fastquadtree-0.9.1/Cargo.lock

@@ -0,0 +1,170 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "fastquadtree"
+version = "0.9.1"
+dependencies = [
+ "pyo3",
+ "smallvec",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f4c7245a08504955605670dbf141fceab975f15ca21570696aebe9d2e71576bd"
+
+[[package]]
+name = "libc"
+version = "0.2.175"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a82ae493e598baaea5209805c49bbf2ea7de956d50d7da0da1164f9c6d28543"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
+
+[[package]]
+name = "portable-atomic"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f84267b20a16ea918e43c6a88433c2d54fa145c92a811b5b047ccbe153674483"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.101"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.26.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ba0117f4212101ee6544044dae45abe1083d30ce7b29c4b5cbdfa2354e07383"
+dependencies = [
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.26.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4fc6ddaf24947d12a9aa31ac65431fb1b851b8f4365426e182901eabfb87df5f"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.26.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "025474d3928738efb38ac36d4744a74a400c901c7596199e20e45d98eb194105"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.26.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2e64eb489f22fe1c95911b77c44cc41e7c19f3082fc81cce90f657cdc42ffded"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.26.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "100246c0ecf400b475341b8455a9213344569af29a3c841d29270e53102e0fcf"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.40"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "smallvec"
+version = "1.15.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03"
+
+[[package]]
+name = "syn"
+version = "2.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ede7c438028d4436d71104916910f5bb611972c5cfd7f89b8300a8186e6fada6"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df7f62577c25e07834649fc3b39fafdc597c0a3527dc1c60129201ccfcbaa50c"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f63a545481291138910575129486daeaf8ac54aee4387fe7906919f7830c7d9d"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fastquadtree"
-version = "0.8.1"
+version = "0.9.1"
 edition = "2021"
 readme = "README.md"
 
@@ -8,7 +8,7 @@ readme = "README.md"
 crate-type = ["rlib", "cdylib"]
 
 [dependencies]
-pyo3 = { version = "0.21", features = ["extension-module", "abi3-py38"] }
+pyo3 = { version = "0.26", features = ["extension-module", "abi3-py38"] }
 smallvec = "1.15.1"
 
 [profile.release]

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastquadtree
-Version: 0.8.1
+Version: 0.9.1
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Rust
@@ -24,6 +24,7 @@ Requires-Dist: mkdocs-autorefs ; extra == 'dev'
 Requires-Dist: mkdocs-git-revision-date-localized-plugin ; extra == 'dev'
 Requires-Dist: mkdocs-minify-plugin ; extra == 'dev'
 Requires-Dist: maturin>=1.5 ; extra == 'dev'
+Requires-Dist: pyqtree==1.0.0 ; extra == 'dev'
 Provides-Extra: dev
 License-File: LICENSE
 Summary: Rust-accelerated quadtree for Python with fast inserts, range queries, and k-NN search.
@@ -38,33 +39,54 @@ Project-URL: Issues, https://github.com/Elan456/fastquadtree/issues
 
 # fastquadtree
 
-[![Docs](https://img.shields.io/badge/docs-online-brightgreen)](https://elan456.github.io/fastquadtree/)
-[![PyPI version](https://img.shields.io/pypi/v/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
-[![Python versions](https://img.shields.io/pypi/pyversions/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
-[![Wheels](https://img.shields.io/pypi/wheel/fastquadtree.svg)](https://pypi.org/project/fastquadtree/#files)
-[![License: MIT](https://img.shields.io/pypi/l/fastquadtree.svg)](LICENSE)
+<img src="https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/interactive_v2_screenshot.png"
+     alt="Interactive Screenshot" align="right" width="420">
 
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/fastquadtree?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=BLUE&left_text=Total+Downloads)](https://pepy.tech/projects/fastquadtree)
+Rust-optimized quadtree with a clean Python API
 
+[![PyPI](https://img.shields.io/pypi/v/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
+[![Python versions](https://img.shields.io/pypi/pyversions/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
+[![Downloads](https://static.pepy.tech/personalized-badge/fastquadtree?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=BLUE&left_text=Total%20Downloads)](https://pepy.tech/projects/fastquadtree)
 [![Build](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml/badge.svg)](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml)
-[![Codecov](https://codecov.io/gh/Elan456/fastquadtree/branch/main/graph/badge.svg)](https://codecov.io/gh/Elan456/fastquadtree)
 
-[![Rust core via PyO3](https://img.shields.io/badge/Rust-core%20via%20PyO3-orange)](https://pyo3.rs/)
-[![Built with maturin](https://img.shields.io/badge/Built%20with-maturin-1f6feb)](https://www.maturin.rs/)
+[![PyO3](https://img.shields.io/badge/Rust-core%20via%20PyO3-orange)](https://pyo3.rs/)
+[![maturin](https://img.shields.io/badge/Built%20with-maturin-1f6feb)](https://www.maturin.rs/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
+[![Docs](https://img.shields.io/badge/docs-online-brightgreen)](https://elan456.github.io/fastquadtree/)
+[![Wheels](https://img.shields.io/pypi/wheel/fastquadtree.svg)](https://pypi.org/project/fastquadtree/#files)
+[![Coverage](https://codecov.io/gh/Elan456/fastquadtree/branch/main/graph/badge.svg)](https://codecov.io/gh/Elan456/fastquadtree)
+[![License: MIT](https://img.shields.io/pypi/l/fastquadtree.svg)](LICENSE)
 
+<br clear="right"/>
 
-![Interactive_V2_Screenshot](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/interactive_v2_screenshot.png)
+## Why use fastquadtree
 
+- Clean [Python API](https://elan456.github.io/fastquadtree/api/quadtree/) with modern typing hints
+- The fastest quadtree Python package ([>10x faster](https://elan456.github.io/fastquadtree/benchmark/) than pyqtree)
+- Prebuilt wheels for Windows, macOS, and Linux
+- Support for [inserting bounding boxes](https://elan456.github.io/fastquadtree/api/rect_quadtree/) or points
+- Fast KNN and range queries
+- Optional object tracking for id ↔ object mapping
+- [100% test coverage](https://codecov.io/gh/Elan456/fastquadtree) and CI on GitHub Actions
 
-Rust-optimized quadtree with a simple Python API.
+----
 
 👉 **Docs:** https://elan456.github.io/fastquadtree/
 
-- Python package: **`fastquadtree`**
-- Python ≥ 3.8
-- Import path: `from fastquadtree import QuadTree`
+## Examples
+See examples of how fastquadtree can be used in the [runnables](https://elan456.github.io/fastquadtree/runnables/) section.
+
+
+## Install
+```bash
+pip install fastquadtree
+```
+
+```python
+from fastquadtree import QuadTree  # Point handling
+from fastquadtree import RectQuadTree  # Bounding box handling
+```
 
 ## Benchmarks
 
@@ -89,28 +111,7 @@ fastquadtree **outperforms** all other quadtree Python packages, including the R
 | PyQtree      | 1.492 | 0.263 | 1.755 | 1.00× |
 | quads        | 1.407 | 0.484 | 1.890 | 0.93× |
 
-### Benchmark Configuration
-| Parameter | Value |
-|---|---:|
-| Bounds | (0, 0, 1000, 1000) |
-| Max points per node | 128 |
-| Max depth | 16 |
-| Queries per experiment | 500 |
-
-See the [benchmark section](https://elan456.github.io/fastquadtree/benchmark/) for details.
-
-## Install
-
-```bash
-pip install fastquadtree
-```
-
-If you are developing locally:
-
-```bash
-# optimized dev install
-maturin develop --release
-```
+See the [benchmark section](https://elan456.github.io/fastquadtree/benchmark/) for details, including configurations, system info, and native vs shim benchmarks.
 
 ## Quickstart
 [See the quickstart guide](https://elan456.github.io/fastquadtree/quickstart/)

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/README.md

@@ -1,32 +1,53 @@
 # fastquadtree
 
-[![Docs](https://img.shields.io/badge/docs-online-brightgreen)](https://elan456.github.io/fastquadtree/)
-[![PyPI version](https://img.shields.io/pypi/v/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
-[![Python versions](https://img.shields.io/pypi/pyversions/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
-[![Wheels](https://img.shields.io/pypi/wheel/fastquadtree.svg)](https://pypi.org/project/fastquadtree/#files)
-[![License: MIT](https://img.shields.io/pypi/l/fastquadtree.svg)](LICENSE)
+<img src="https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/interactive_v2_screenshot.png"
+     alt="Interactive Screenshot" align="right" width="420">
 
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/fastquadtree?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=BLUE&left_text=Total+Downloads)](https://pepy.tech/projects/fastquadtree)
+Rust-optimized quadtree with a clean Python API
 
+[![PyPI](https://img.shields.io/pypi/v/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
+[![Python versions](https://img.shields.io/pypi/pyversions/fastquadtree.svg)](https://pypi.org/project/fastquadtree/)
+[![Downloads](https://static.pepy.tech/personalized-badge/fastquadtree?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=BLUE&left_text=Total%20Downloads)](https://pepy.tech/projects/fastquadtree)
 [![Build](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml/badge.svg)](https://github.com/Elan456/fastquadtree/actions/workflows/release.yml)
-[![Codecov](https://codecov.io/gh/Elan456/fastquadtree/branch/main/graph/badge.svg)](https://codecov.io/gh/Elan456/fastquadtree)
 
-[![Rust core via PyO3](https://img.shields.io/badge/Rust-core%20via%20PyO3-orange)](https://pyo3.rs/)
-[![Built with maturin](https://img.shields.io/badge/Built%20with-maturin-1f6feb)](https://www.maturin.rs/)
+[![PyO3](https://img.shields.io/badge/Rust-core%20via%20PyO3-orange)](https://pyo3.rs/)
+[![maturin](https://img.shields.io/badge/Built%20with-maturin-1f6feb)](https://www.maturin.rs/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
+[![Docs](https://img.shields.io/badge/docs-online-brightgreen)](https://elan456.github.io/fastquadtree/)
+[![Wheels](https://img.shields.io/pypi/wheel/fastquadtree.svg)](https://pypi.org/project/fastquadtree/#files)
+[![Coverage](https://codecov.io/gh/Elan456/fastquadtree/branch/main/graph/badge.svg)](https://codecov.io/gh/Elan456/fastquadtree)
+[![License: MIT](https://img.shields.io/pypi/l/fastquadtree.svg)](LICENSE)
 
+<br clear="right"/>
 
-![Interactive_V2_Screenshot](https://raw.githubusercontent.com/Elan456/fastquadtree/main/assets/interactive_v2_screenshot.png)
+## Why use fastquadtree
 
+- Clean [Python API](https://elan456.github.io/fastquadtree/api/quadtree/) with modern typing hints
+- The fastest quadtree Python package ([>10x faster](https://elan456.github.io/fastquadtree/benchmark/) than pyqtree)
+- Prebuilt wheels for Windows, macOS, and Linux
+- Support for [inserting bounding boxes](https://elan456.github.io/fastquadtree/api/rect_quadtree/) or points
+- Fast KNN and range queries
+- Optional object tracking for id ↔ object mapping
+- [100% test coverage](https://codecov.io/gh/Elan456/fastquadtree) and CI on GitHub Actions
 
-Rust-optimized quadtree with a simple Python API.
+----
 
 👉 **Docs:** https://elan456.github.io/fastquadtree/
 
-- Python package: **`fastquadtree`**
-- Python ≥ 3.8
-- Import path: `from fastquadtree import QuadTree`
+## Examples
+See examples of how fastquadtree can be used in the [runnables](https://elan456.github.io/fastquadtree/runnables/) section.
+
+
+## Install
+```bash
+pip install fastquadtree
+```
+
+```python
+from fastquadtree import QuadTree  # Point handling
+from fastquadtree import RectQuadTree  # Bounding box handling
+```
 
 ## Benchmarks
 
@@ -51,28 +72,7 @@ fastquadtree **outperforms** all other quadtree Python packages, including the R
 | PyQtree      | 1.492 | 0.263 | 1.755 | 1.00× |
 | quads        | 1.407 | 0.484 | 1.890 | 0.93× |
 
-### Benchmark Configuration
-| Parameter | Value |
-|---|---:|
-| Bounds | (0, 0, 1000, 1000) |
-| Max points per node | 128 |
-| Max depth | 16 |
-| Queries per experiment | 500 |
-
-See the [benchmark section](https://elan456.github.io/fastquadtree/benchmark/) for details.
-
-## Install
-
-```bash
-pip install fastquadtree
-```
-
-If you are developing locally:
-
-```bash
-# optimized dev install
-maturin develop --release
-```
+See the [benchmark section](https://elan456.github.io/fastquadtree/benchmark/) for details, including configurations, system info, and native vs shim benchmarks.
 
 ## Quickstart
 [See the quickstart guide](https://elan456.github.io/fastquadtree/quickstart/)

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/benchmarks/benchmark_native_vs_shim.py

@@ -7,14 +7,16 @@ import random
 import statistics as stats
 from time import perf_counter as now
 
+from pyqtree import Index as PyQTreeIndex
 from system_info_collector import collect_system_info, format_system_info_markdown_lite
 from tqdm import tqdm
 
 from fastquadtree import QuadTree as ShimQuadTree
 from fastquadtree._native import QuadTree as NativeQuadTree
+from fastquadtree.pyqtree import Index as FQTIndex
 
 BOUNDS = (0.0, 0.0, 1000.0, 1000.0)
-CAPACITY = 20
+CAPACITY = 64
 MAX_DEPTH = 10
 SEED = 42
 
@@ -69,6 +71,30 @@ def bench_shim(points, queries, *, track_objects: bool, with_objs: bool):
     return t_build, t_query
 
 
+def bench_pyqtree(points, queries, fqt: bool):
+    """
+    Benchmarks the pyqtree compatibility shim vs the original pyqtree.
+
+    Set fqt to True to use the shim, False to use the original pyqtree.
+    """
+    t0 = now()
+    qt = (
+        FQTIndex(bbox=BOUNDS, max_items=CAPACITY, max_depth=MAX_DEPTH)
+        if fqt
+        else PyQTreeIndex(bbox=BOUNDS, max_items=CAPACITY, max_depth=MAX_DEPTH)
+    )
+    for i, p in enumerate(points):
+        box = (p[0], p[1], p[0], p[1])
+        qt.insert(i, box)
+    t_build = now() - t0
+
+    t0 = now()
+    for q in queries:
+        _ = qt.intersect(q)
+    t_query = now() - t0
+    return t_build, t_query
+
+
 def median_times(fn, points, queries, repeats: int, desc: str = "Running"):
     """Run benchmark multiple times and return median times."""
     builds, queries_t = [], []
@@ -119,14 +145,28 @@ def main():
         points,
         queries,
         args.repeats,
-        desc="Shim (no map)",
+        desc="Shim (no tracking)",
     )
     s_build_map, s_query_map = median_times(
         lambda pts, qs: bench_shim(pts, qs, track_objects=True, with_objs=True),
         points,
         queries,
         args.repeats,
-        desc="Shim (track+objs)",
+        desc="Shim (tracking)",
+    )
+    p_build, p_query = median_times(
+        lambda pts, qs: bench_pyqtree(pts, qs, fqt=False),
+        points,
+        queries,
+        args.repeats,
+        desc="pyqtree (original)",
+    )
+    fqt_build, fqt_query = median_times(
+        lambda pts, qs: bench_pyqtree(pts, qs, fqt=True),
+        points,
+        queries,
+        args.repeats,
+        desc="pyqtree (FQT shim)",
     )
     print()
 
@@ -146,14 +186,19 @@ def main():
 | Variant | Build | Query | Total |
 |---|---:|---:|---:|
 | Native | {fmt(n_build)} | {fmt(n_query)} | {fmt(n_build + n_query)} |
-| Shim (no map) | {fmt(s_build_no_map)} | {fmt(s_query_no_map)} | {fmt(s_build_no_map + s_query_no_map)} |
-| Shim (track+objs) | {fmt(s_build_map)} | {fmt(s_query_map)} | {fmt(s_build_map + s_query_map)} |
+| Shim (no tracking) | {fmt(s_build_no_map)} | {fmt(s_query_no_map)} | {fmt(s_build_no_map + s_query_no_map)} |
+| Shim (tracking) | {fmt(s_build_map)} | {fmt(s_query_map)} | {fmt(s_build_map + s_query_map)} |
+| pyqtree (fastquadtree) | {fmt(fqt_build)} | {fmt(fqt_query)} | {fmt(fqt_build + fqt_query)} |
+| pyqtree (original) | {fmt(p_build)} | {fmt(p_query)} | {fmt(p_build + p_query)} |
 
 ### Summary
 
 Using the shim with object tracking increases build time by {fmt(s_build_map / n_build)}x and query time by {fmt(s_query_map / n_query)}x.
 **Total slowdown = {fmt((s_build_map + s_query_map) / (n_build + n_query))}x.**
 
+If you directly replace pyqtree with the drop-in `fastquadtree.pyqtree.Index` shim, you get a build time of {fmt(fqt_build)}s and query time of {fmt(fqt_query)}s.
+This is a total speedup of {fmt((p_build + p_query) / (fqt_build + fqt_query))}x compared to the original pyqtree and requires no code changes.
+
 Adding the object map only impacts the build time, not the query time.
 """
     print(md.strip())

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/docs/benchmark.md

@@ -17,7 +17,7 @@ Quadtrees are the focus of the benchmark, but Rtrees are included for reference.
 
 | Library | Build (s) | Query (s) | Total (s) | Speed vs PyQtree |
 |---|---:|---:|---:|---:|
-| fastquadtree | 0.031 | 0.089 | 0.120 | 14.64× |
+| **fastquadtree** | 0.031 | 0.089 | 0.120 | **14.64×** |
 | Shapely STRtree | 0.179 | 0.100 | 0.279 | 6.29× |
 | nontree-QuadTree | 0.595 | 0.605 | 1.200 | 1.46× |
 | Rtree        | 0.961 | 0.300 | 1.261 | 1.39× |

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/docs/index.md

@@ -35,15 +35,25 @@
 
 ## Why use fastquadtree
 
-- Simple Python API you can teach in one review
-- Fast inserts and queries on hundreds of thousands of points
+- Clean [Python API](api/quadtree.md) with modern typing hints
+- The fastest quadtree Python package ([>10x faster](benchmark.md) than pyqtree)
+- Prebuilt wheels for Windows, macOS, and Linux
+- Support for [inserting bounding boxes](api/rect_quadtree.md) or points
+- Fast KNN and range queries
 - Optional object tracking for id ↔ object mapping
-- Clean integrations for range queries and nearest neighbors
-- Support for inserting bounding boxes or points
+- [100% test coverage](https://codecov.io/gh/Elan456/fastquadtree) and CI on GitHub Actions
+
+## Examples
+See examples of how fastquadtree can be used in the [runnables](runnables.md) section.
+
 
 ## Install
 ```bash
 pip install fastquadtree
 ```
 
-**Look at the nav panel for quick start guides and API docs**
+```python
+from fastquadtree import QuadTree  # Point handling
+from fastquadtree import RectQuadTree  # Bounding box handling
+from fastquadtree.pyqtree import Index # Drop-in replacement for pyqtree
+```

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/docs/runnables.md

@@ -5,6 +5,10 @@
 - Add and delete boids with mouse clicks
 - Visualize KNN and range queries
 
+The interactive demo is a great way to see how fastquadtree works in practice.
+You can see how the quadtree subdivides as you add points, and validate the accuracy of the queries visually.
+By pressing 1, you can visualize the KNN query for each boid. 
+
 ```bash
 pip install -r interactive/requirements.txt
 python interactive/interactive_v2.py
@@ -16,6 +20,9 @@ python interactive/interactive_v2.py
 - Similar to the above demo, but uses rectangles instead of points
 - If the rectangles intersect at all with the query area, they will be highlighted in red
 
+If you are creating a game or simulation environment where entities have bounding boxes, you can use the
+rectangular quadtree to quickly check which entities are intersecting with another. 
+
 ```bash
 pip install -r interactive/requirements.txt
 python interactive/interactive_v2_rect.py
@@ -27,6 +34,9 @@ python interactive/interactive_v2_rect.py
 - Spawn balls in a pit with physics-based collisions
 - Easily switch between brute force and quadtree collision detection to see the performance difference
 
+The ball pit demo shows how quadtrees offer massive performance improvements for collision detection.
+Rectangular queries are used to find potential collisions, and then precise circle-circle collision checks are performed.
+
 ```bash
 pip install -r interactive/requirements.txt
 python interactive/ball_pit.py

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/mkdocs.yml

@@ -18,7 +18,7 @@ theme:
   palette:
     - scheme: slate
       primary: indigo
-      accent: indigo
+      accent: deep orange
 
 plugins:
   - search

{fastquadtree-0.8.1 → fastquadtree-0.9.1}/pyproject.toml

@@ -77,6 +77,7 @@ dev = [
   "mkdocs-git-revision-date-localized-plugin",
   "mkdocs-minify-plugin",
   "maturin>=1.5",  # build Rust wheels
+  "pyqtree==1.0.0", # for comparison in tests
 ]
 
 [tool.ruff]