Skip to content

Release v1.1.0 - Space2StatsClient

Compare
Choose a tag to compare
@Gabe-Levin Gabe-Levin released this 14 Feb 16:33
· 0 commits to main since this release

Release 1.1.0 - Space2StatsClient

Release Date: February 14, 2025

This release introduces new functionality to the Space2StatsClient, enhancing its capabilities with the addition of hex ID-based endpoints. These updates are designed to improve data retrieval and aggregation processes using H3 hexagon IDs.

New Features

  • get_summary_by_hexids Method:

    • Added support for retrieving statistics for specific H3 hexagon IDs.
    • Example:
      summary_df = client.get_summary_by_hexids(
          hex_ids=["862a1070fffffff", "862a10767ffffff"],
          fields=["sum_pop_2020", "sum_pop_f_10_2020"],
          geometry="polygon"
      )
  • get_aggregate_by_hexids Method:

    • Introduced functionality to aggregate statistics for specific H3 hexagon IDs.
    • Supports aggregation types: "sum", "avg", "count", "max", "min".
    • Example:
      aggregate_df = client.get_aggregate_by_hexids(
          hex_ids=["862a1070fffffff", "862a10767ffffff"],
          fields=["sum_pop_2020", "sum_pop_f_10_2020"],
          aggregation_type="sum"
      )

Improvements

  • Documentation updates providing detailed instructions for the development workflow.
  • Improved Readme Formatting

Contributors

For more details, refer to the updated documentation