This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch branch-0.1.0
in repository https://gitbox.apache.org/repos/asf/sedona-db.git
The following commit(s) were added to refs/heads/branch-0.1.0 by this push:
new 76851c1 docs: add benchmark results and fix typos (#142)
76851c1 is described below
commit 76851c1f4862ca0f5752cff6a485ca9e1fa83621
Author: Jia Yu <[email protected]>
AuthorDate: Tue Sep 23 18:21:10 2025 -0700
docs: add benchmark results and fix typos (#142)
---
README.md | 37 +++++++++++++++++++++++--------------
docs/crs-examples.md | 2 +-
docs/image/sf1.png | Bin 0 -> 133443 bytes
docs/image/sf10.png | Bin 0 -> 189589 bytes
docs/index.md | 9 +++++++++
docs/overture-examples.md | 2 +-
docs/programming-guide.md | 2 +-
7 files changed, 35 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 3a1a0a4..d1f15f6 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,28 @@ SedonaDB is perfect for processing smaller to medium
datasets on local machines
Raster functions are coming soon. We expect SedonaDB Raster will match all
raster functions provided in
[SedonaSpark](https://sedona.apache.org/latest/api/sql/Raster-operators/).
+## Features of SedonaDB
+
+SedonaDB has several advantages:
+
+* **π High Performance:** Built in Rust for exceptional speed and memory
efficiency
+* **πΊοΈ Comprehensive Spatial Toolkit:** Supports both vector and raster
functions in a single library
+* **π CRS Propagation:** Always maintains coordinate reference system
information
+* **π Format Flexibility:** Supports legacy and modern file formats including
GeoParquet, Shapefile, GeoJSON
+* **β‘ Dual APIs:** Python and SQL interfaces for seamless workflow integration
+* **π§ Extensible:** Easily customizable and extensible architecture
+* **π Ecosystem Integration:** Interoperable with PyArrow-compatible libraries
like GeoPandas, DuckDB, and Polars
+* **π₯ Active Community:** Great maintainers and contributors who encourage
external contributions
+
+## Performance Benchmarks
+
+This is a performance benchmark comparing SedonaDB 0.1.0, DuckDB 1.4.0, and
GeoPandas 1.1.1 using SpatialBench Queries 1-12 at Scale Factors 1 and 10.
Details can be found at [Apache Sedona
SpatialBench](https://sedona.apache.org/spatialbench/).
+
+<div align="center">
+ <img src="docs/image/sf1.png" alt="SF1 Benchmark Results" width="45%" />
+ <img src="docs/image/sf10.png" alt="SF10 Benchmark Results" width="45%" />
+</div>
+
## Install
You can install Python SedonaDB with PyPI:
@@ -146,19 +168,6 @@ Here's the query output:
βββββββββββββββββββββββββββ΄βββββββββββββββββββββ΄βββββββββββββ΄βββββββββββββ΄ββββββββββββββββββββββββββ
```
-## Features of SedonaDB
-
-SedonaDB has several advantages:
-
-* **π High Performance:** Built in Rust for exceptional speed and memory
efficiency
-* **πΊοΈ Comprehensive Spatial Toolkit:** Supports both vector and raster
functions in a single library
-* **π CRS Propagation:** Always maintains coordinate reference system
information
-* **π Format Flexibility:** Supports legacy and modern file formats including
GeoParquet, Shapefile, GeoJSON
-* **β‘ Dual APIs:** Python and SQL interfaces for seamless workflow integration
-* **π§ Extensible:** Easily customizable and extensible architecture
-* **π Ecosystem Integration:** Interoperable with PyArrow-compatible libraries
like GeoPandas, DuckDB, and Polars
-* **π₯ Active Community:** Great maintainers and contributors who encourage
external contributions
-
## Community & Support
### Get Help
@@ -179,7 +188,7 @@ We welcome contributions! Here's how you can get involved:
### About SedonaDB
-SedonaDB is a subproject of **Apache Sedona**, an Apache Software Foundation
project. The project is governed by the Apache Software Foundation and subject
to all the rules and oversight requirements.
+SedonaDB is a subproject of **Apache Sedona**, an Apache Software Foundation
project. The project is governed by the Apache Software Foundation and subject
to all the rules and oversight requirements. SedonaDB is built on top of
**Apache Arrow** and **Apache DataFusion** for fast query processing.
### Related Projects
diff --git a/docs/crs-examples.md b/docs/crs-examples.md
index a5fbd02..a35103e 100644
--- a/docs/crs-examples.md
+++ b/docs/crs-examples.md
@@ -19,7 +19,7 @@
# Joining Spatial Data with Different Coordinate Systems
-> Note: Before running this notebook, ensure that you have installed SedonaDB:
`pip install "sedona[db]"`
+> Note: Before running this notebook, ensure that you have installed SedonaDB:
`pip install "apache-sedona[db]"`
This example demonstrates how one table with an EPSG 4326 CRS cannot be joined
with another table that uses EPSG 3857.
diff --git a/docs/image/sf1.png b/docs/image/sf1.png
new file mode 100644
index 0000000..2218a2d
Binary files /dev/null and b/docs/image/sf1.png differ
diff --git a/docs/image/sf10.png b/docs/image/sf10.png
new file mode 100644
index 0000000..9c932ea
Binary files /dev/null and b/docs/image/sf10.png differ
diff --git a/docs/index.md b/docs/index.md
index 3d13916..593a67b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -58,6 +58,15 @@ SedonaDB has several advantages:
* **π§ Extensible:** Easily customizable and extensible architecture
* **π Ecosystem Integration:** Interoperable with PyArrow-compatible libraries
like GeoPandas, DuckDB, and Polars
+## Performance Benchmarks
+
+This is a performance benchmark comparing SedonaDB 0.1.0, DuckDB 1.4.0, and
GeoPandas 1.1.1 using SpatialBench Queries 1-12 at Scale Factors 1 and 10.
Details can be found at [Apache Sedona
SpatialBench](https://sedona.apache.org/spatialbench/).
+
+<div align="center">
+ <img src="image/sf1.png" alt="SF1 Benchmark Results" width="45%" />
+ <img src="image/sf10.png" alt="SF10 Benchmark Results" width="45%" />
+</div>
+
## Install SedonaDB
Here's how to install SedonaDB with various build tools:
diff --git a/docs/overture-examples.md b/docs/overture-examples.md
index a904b5e..c073f49 100644
--- a/docs/overture-examples.md
+++ b/docs/overture-examples.md
@@ -19,7 +19,7 @@
# SedonaDB Overture Examples
-> Note: Before running this notebook, ensure that you have installed SedonaDB:
`pip install "sedona[db]"`
+> Note: Before running this notebook, ensure that you have installed SedonaDB:
`pip install "apache-sedona[db]"`
This notebook demonstrates how to query and analyze the [Overture
Maps](https://overturemaps.org/) dataset using SedonaDB.
diff --git a/docs/programming-guide.md b/docs/programming-guide.md
index 85e1ac6..a59e7ce 100644
--- a/docs/programming-guide.md
+++ b/docs/programming-guide.md
@@ -19,7 +19,7 @@
# Working with Vector Data
-> Note: Before running this notebook, ensure that you have installed SedonaDB:
`pip install "sedona[db]"`
+> Note: Before running this notebook, ensure that you have installed SedonaDB:
`pip install "apache-sedona[db]"`
Process vector data using sedona.db. You will learn to create DataFrames, run
spatial queries, and manage file I/O. Let's begin by connecting to sedona.db.
