Skip to content

Commit

Permalink
Update README.md (#97)
Browse files Browse the repository at this point in the history
Thanks @marklit for suggesting adding some headers
  • Loading branch information
isaacbrodsky committed Mar 21, 2024
1 parent f7556d9 commit 972bcfa
Showing 1 changed file with 65 additions and 53 deletions.
118 changes: 65 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
[![Extension Test](https://github.com/isaacbrodsky/h3-duckdb/actions/workflows/test.yml/badge.svg)](https://github.com/isaacbrodsky/h3-duckdb/actions/workflows/test.yml)
[![Extension Deployment](https://github.com/isaacbrodsky/h3-duckdb/actions/workflows/_extension_deploy.yml/badge.svg)](https://github.com/isaacbrodsky/h3-duckdb/actions/workflows/_extension_deploy.yml)
[![DuckDB Version](https://img.shields.io/static/v1?label=duckdb&message=v0.10.1&color=blue)](https://github.com/duckdb/duckdb/releases/tag/v0.10.1)
[![H3 Version](https://img.shields.io/static/v1?label=h3&message=v4.1.0&color=blue)](https://github.com/uber/h3/releases/tag/v4.1.0)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)

This is a [DuckDB](https://duckdb.org) extension that adds support for the [H3 discrete global grid system](https://github.com/uber/h3/).

# Download

Download the latest version of the extension: [Linux AMD64](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/linux_amd64/h3ext.duckdb_extension.gz) [Linux AMD64 GCC4](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/linux_amd64_gcc4/h3ext.duckdb_extension.gz) [Linux Arm64](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/linux_arm64/h3ext.duckdb_extension.gz) [OSX AMD64](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/osx_amd64/h3ext.duckdb_extension.gz) [OSX Arm64](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/osx_arm64/h3ext.duckdb_extension.gz) [wasm eh](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/wasm_eh/h3ext.duckdb_extension.wasm) [wasm mvp](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/wasm_mvp/h3ext.duckdb_extension.wasm) [wasm threads](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/wasm_threads/h3ext.duckdb_extension.wasm) [Windows AMD64](https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/windows_amd64/h3ext.duckdb_extension.gz)

For Linux x64:

```sh
wget https://pub-cc26a6fd5d8240078bd0c2e0623393a5.r2.dev/v0.10.1/linux_amd64/h3ext.duckdb_extension.gz
gunzip h3ext.duckdb_extension.gz
```

# Install

Run DuckDB with the unsigned option:
```sh
duckdb -unsigned
Expand Down Expand Up @@ -35,58 +45,60 @@ SELECT h3_cell_to_latlng(cast(586265647244115967 as ubigint));

This extension implements the entire [H3 API](https://h3geo.org/docs/api/indexing). The full list of functions is below:

- `h3_latlng_to_cell`
- `h3_cell_to_lat`
- `h3_cell_to_lng`
- `h3_cell_to_latlng`
- `h3_cell_to_boundary_wkt`
- `h3_get_resolution`
- `h3_get_base_cell_number`
- `h3_string_to_h3`
- `h3_h3_to_string`
- `h3_is_valid_cell`
- `h3_is_res_class_iii`
- `h3_is_pentagon`
- `h3_get_icosahedron_faces`
- `h3_cell_to_parent`
- `h3_cell_to_children`
- `h3_cell_to_center_child`
- `h3_cell_to_child_pos`
- `h3_child_pos_to_cell`
- `h3_compact_cells`
- `h3_uncompact_cells`
- `h3_grid_disk`
- `h3_grid_disk_distances`
- `h3_grid_disk_unsafe`
- `h3_grid_disk_distances_unsafe`
- `h3_grid_ring_unsafe`
- `h3_grid_path_cells`
- `h3_grid_distance`
- `h3_cell_to_local_ij`
- `h3_local_ij_to_cell`
- `h3_cell_to_vertex`
- `h3_cell_to_vertexes`
- `h3_vertex_to_lat`
- `h3_vertex_to_lng`
- `h3_vertex_to_latlng`
- `h3_is_valid_vertex`
- `h3_is_valid_directed_edge`
- `h3_origin_to_directed_edges`
- `h3_directed_edge_to_cells`
- `h3_get_directed_edge_origin`
- `h3_get_directed_edge_destination`
- `h3_cells_to_directed_edge`
- `h3_are_neighbor_cells`
- `h3_directed_edge_to_boundary_wkt`
- `h3_get_hexagon_area_avg`
- `h3_cell_area`
- `h3_edge_length`
- `h3_get_num_cells`
- `h3_get_res0_cells`
- `h3_get_pentagons`
- `h3_great_circle_distance`
- `h3_cells_to_multi_polygon_wkt`
- `h3_polygon_wkt_to_cells`
| Function |
| --- |
| `h3_latlng_to_cell`
| `h3_cell_to_lat`
| `h3_cell_to_lng`
| `h3_cell_to_latlng`
| `h3_cell_to_boundary_wkt`
| `h3_get_resolution`
| `h3_get_base_cell_number`
| `h3_string_to_h3`
| `h3_h3_to_string`
| `h3_is_valid_cell`
| `h3_is_res_class_iii`
| `h3_is_pentagon`
| `h3_get_icosahedron_faces`
| `h3_cell_to_parent`
| `h3_cell_to_children`
| `h3_cell_to_center_child`
| `h3_cell_to_child_pos`
| `h3_child_pos_to_cell`
| `h3_compact_cells`
| `h3_uncompact_cells`
| `h3_grid_disk`
| `h3_grid_disk_distances`
| `h3_grid_disk_unsafe`
| `h3_grid_disk_distances_unsafe`
| `h3_grid_ring_unsafe`
| `h3_grid_path_cells`
| `h3_grid_distance`
| `h3_cell_to_local_ij`
| `h3_local_ij_to_cell`
| `h3_cell_to_vertex`
| `h3_cell_to_vertexes`
| `h3_vertex_to_lat`
| `h3_vertex_to_lng`
| `h3_vertex_to_latlng`
| `h3_is_valid_vertex`
| `h3_is_valid_directed_edge`
| `h3_origin_to_directed_edges`
| `h3_directed_edge_to_cells`
| `h3_get_directed_edge_origin`
| `h3_get_directed_edge_destination`
| `h3_cells_to_directed_edge`
| `h3_are_neighbor_cells`
| `h3_directed_edge_to_boundary_wkt`
| `h3_get_hexagon_area_avg`
| `h3_cell_area`
| `h3_edge_length`
| `h3_get_num_cells`
| `h3_get_res0_cells`
| `h3_get_pentagons`
| `h3_great_circle_distance`
| `h3_cells_to_multi_polygon_wkt`
| `h3_polygon_wkt_to_cells`

# Development

Expand Down

0 comments on commit 972bcfa

Please sign in to comment.