h3-toolkit documentation

Welcome to h3-toolkit

h3-toolkit is a Python library designed to streamline the process of working with Uber’s H3 spatial indexing system and Polars for high-performance data manipulation. This toolkit focuses on making data transformations between different H3 resolutions faster and more convenient.

With h3-toolkit, you can efficiently convert and aggregate geospatial data using H3 indexes, leveraging the power of Polars for swift data processing. Whether you are working with point, line, polygon, or raster data, this library simplifies the integration and manipulation of H3 spatial data, enhancing your workflow and productivity.

Key features include:

• Seamless Resolution Conversion: Easily transform data across different H3 resolutions.

• Optimized Performance: Utilize Polars and h3ronpy for fast and efficient data handling.

• Flexible Aggregation: Apply various aggregation functions to your geospatial data.

Get started with h3-toolkit to enhance your geospatial data processing and make working with H3 indexes more effective and efficient.

Documentation

• Concepts & Design Patterns
  • Method Chaining & Return Values
    • Design Philosophy
    • Method Return Values
    • Usage Patterns
    • Return Value Summary Table
    • Benefits of This Design
• API Documentation
  • h3_toolkit package
    • h3_toolkit.core module
    • h3_toolkit.aggregation module
    • h3_toolkit.hbase module
    • h3_toolkit.utils module
    • h3_toolkit.exceptions module
• Usage Examples
  • vector data
    • 1. Import geometry data
    • 2. Geometry to h3
    • 3. Scale current h3 resolution to the target resolution
    • 4. Visualization
    • 5. Customize the aggregation function
  • raster data
    • 1. Fetch raster data
    • 2. Convert raster to h3
    • 3. Scale current h3 resolution to the target resolution
    • 4. Visualization
  • hbase data
    • 1. set hbase client
    • 2. Select boundary of the data
    • 3. Chain all steps together
    • 4. fetch data from hbase and aggregate new data back to hbase
    • 5. Visualization