Skip to content

Doc updates #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sharkinsspatial merged 2 commits into from
Apr 29, 2026
+18 −3
Merged

Doc updates #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b0a8ba
Add note about chunk size and shape.
sharkinsspatial Apr 29, 2026
b2dc499
Add note about variable length decoding performance.
sharkinsspatial Apr 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/architecture/zarr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ current supported type mappings.
| `float16` | `Float16` | |
| `float32` | `Float32` | |
| `float64` | `Float64` | |
| `bytes` | `BinaryView` | When the field name is `bbox`, mapped to WKB with EPSG:4326 CRS via the GeoArrow extension type instead |
| `VariableLengthBytes` | `BinaryView` | When the field name is `bbox`, mapped to WKB with EPSG:4326 CRS via the GeoArrow extension type instead |
| `r<N>` (raw bits) | `BinaryView` | |
| `string` | `Utf8View` | |
| `VariableLengthUTF8` | `Utf8View` | |
| `numpy.datetime64[s]` | `Timestamp(Second, None)` | |
| `numpy.datetime64[ms]` | `Timestamp(Millisecond, None)` | |
| `numpy.datetime64[us]` | `Timestamp(Microsecond, None)` | |
Expand All @@ -53,3 +53,15 @@ group called `indexes` and search for an array of the same name as the
predicate array. Currently the only index type supported are R-tree indexes
generated by the [geo-index](https://github.com/georust/geo-index)
library but we will continue to expand index support.

### Decoding performance
Whenever possible it is worthwhile to avoid including VariableLengthBytes fields
in your query's projection. Variable length decoding incurs a significantly
higher cost than decoding fixed width types and can drastically affect query
performance. This is especially evident when an index is present and the actual
chunks don't need to be materialized for filter operations. See the results of
```
cargo bench --bench bbox_zarrs_raw
```
as an example.

1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ This can present problems as systems require complex, fragile orchestration to m

- **[User Guide](user-guide/installation.md)** — Installation, quickstart
- **[API Reference](api/zarr-table.md)** — `ZarrTable` class documentation
- **[Examples](examples/README.md)** - Notebook examples
- **[Developer Docs](DEVELOP.md)** — Contributing and running benchmarks
4 changes: 3 additions & 1 deletion docs/user-guide/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ bbox[:] = shapely.to_wkb([
shapely.box( 30.0, 30.0, 50.0, 50.0),
])
```

Note that the chunk size and shape must be the same for all of our `meta` arrays. See
[zarr structure](../architecture/zarr.md) for more details on why.
:
## 2. Register the store

Use `ZarrTable.from_obstore` to open the store through
Expand Down
Loading