Skip to content

Release 1.0.0 - Space2StatsClient

Compare
Choose a tag to compare
@Gabe-Levin Gabe-Levin released this 13 Feb 11:38
· 5 commits to main since this release

Release 1.0.0 - Space2StatsClient

Release Date: February 14, 2025

This is the first release of the Space2Stats Client, a wrapper for the Space2Stats API. It offers essential features for data retrieval and aggregation, simplifying interactions with the S2S API.

Key Features

  • get_topics:

    • Retrieve a DataFrame containing available dataset themes/topics from the STAC catalog.
  • get_fields:

    • Obtain a list of all available fields that can be used with the API.
  • get_properties:

    • Fetch descriptions of variables for a specific dataset.
  • fetch_admin_boundaries :

    • Retrieve administrative boundaries from the GeoBoundaries API for a given country and admin level.
  • get_summary:

    • Extract H3 level data for areas of interest.
    • Parameters include a GeoDataFrame, spatial join method, fields, and optional geometry.
  • get_aggregate:

    • Extract summary statistics from H3 data.
    • Supports various aggregation types such as "sum", "avg", "count", "max", and "min".

Initial Setup

  • Documentation to guide users through installation and usage.
  • Example scripts to demonstrate the capabilities of the client.