Metadata-Version: 2.4
Name: giga-spatial
Version: 0.10.0
Summary: Acquires published geospatial datasets into a data store you control, loads them for a source, and processes them.
Author-email: Utku Can Ozturk <utkucanozturk@gmail.com>
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://github.com/unicef/giga-spatial
Project-URL: Documentation, https://unicef.github.io/giga-spatial/
Project-URL: Source, https://github.com/unicef/giga-spatial
Project-URL: Issue Tracker, https://github.com/unicef/giga-spatial/issues
Project-URL: Discussions, https://github.com/unicef/giga-spatial/discussions
Project-URL: Changelog, https://unicef.github.io/giga-spatial/latest/changelog
Keywords: gigaspatial,spatial,geospatial,gis,remote sensing,data processing,download,openstreetmap,osm,ghsl,grid,h3,worldpop,buildings,point of interest,POI,raster,vector,school connectivity,unicef,giga,mapping,analysis,python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.2.2
Requires-Dist: pandas>=2.2.3
Requires-Dist: geopandas>=1.0.1
Requires-Dist: pycountry>=24.6.1
Requires-Dist: pydantic>=2.10.6
Requires-Dist: rasterio>=1.3.10
Requires-Dist: requests>=2.32.4
Requires-Dist: scipy>=1.15.1
Requires-Dist: shapely>=2.0.7
Requires-Dist: networkx>=3.2.1
Requires-Dist: tqdm>=4.65.0
Requires-Dist: pydantic-settings>=2.7.1
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: s3fs>=2024.12.0
Requires-Dist: psutil>=6.0.0
Requires-Dist: httpx>=0.27
Requires-Dist: pyarrow>=17.0.0
Requires-Dist: plotly>=5.24.0
Requires-Dist: mercantile>=1.2.1
Requires-Dist: h3>=4.2.0
Requires-Dist: s2sphere>=0.2.5
Provides-Extra: gee
Requires-Dist: earthengine-api>=1.7.0; extra == "gee"
Requires-Dist: geemap>=0.36.6; extra == "gee"
Provides-Extra: bq
Requires-Dist: google-cloud-bigquery>=3.0.0; extra == "bq"
Requires-Dist: google-cloud-bigquery-storage>=2.0.0; extra == "bq"
Requires-Dist: google-auth>=2.0.0; extra == "bq"
Requires-Dist: google-auth-oauthlib>=1.0.0; extra == "bq"
Requires-Dist: google-auth-httplib2>=0.2.0; extra == "bq"
Requires-Dist: db-dtypes>=1.0.0; extra == "bq"
Provides-Extra: azure
Requires-Dist: azure-storage-blob>=12.22.0; extra == "azure"
Provides-Extra: snowflake
Requires-Dist: snowflake-connector-python>=3.0.0; extra == "snowflake"
Provides-Extra: delta
Requires-Dist: delta-sharing>=1.2.0; extra == "delta"
Provides-Extra: db
Requires-Dist: SQLAlchemy>=2.0.0; extra == "db"
Requires-Dist: trino[sqlalchemy]>=0.300.0; extra == "db"
Requires-Dist: dask>=2024.12.1; extra == "db"
Provides-Extra: duckdb
Requires-Dist: duckdb>=1.2.0; extra == "duckdb"
Provides-Extra: unicef
Requires-Dist: unicefdata>=2.4.0; extra == "unicef"
Provides-Extra: elevation
Requires-Dist: itur>=0.4.0; extra == "elevation"
Provides-Extra: maxar
Requires-Dist: OWSLib>=0.31.0; extra == "maxar"
Provides-Extra: hdx
Requires-Dist: hdx-python-api>=6.3.8; extra == "hdx"
Provides-Extra: all
Requires-Dist: giga-spatial[gee]; extra == "all"
Requires-Dist: giga-spatial[bq]; extra == "all"
Requires-Dist: giga-spatial[azure]; extra == "all"
Requires-Dist: giga-spatial[snowflake]; extra == "all"
Requires-Dist: giga-spatial[delta]; extra == "all"
Requires-Dist: giga-spatial[db]; extra == "all"
Requires-Dist: giga-spatial[duckdb]; extra == "all"
Requires-Dist: giga-spatial[unicef]; extra == "all"
Requires-Dist: giga-spatial[elevation]; extra == "all"
Requires-Dist: giga-spatial[maxar]; extra == "all"
Requires-Dist: giga-spatial[hdx]; extra == "all"
Dynamic: license-file

<p align="center">
  <a href="https://unicef.github.io/giga-spatial/">
    <img src="https://raw.githubusercontent.com/unicef/giga-spatial/main/docs/assets/gigaspatial-logo.png" alt="GigaSpatial" width="420">
  </a>
</p>

<p align="center">
  <a href="https://pypi.org/project/giga-spatial/"><img src="https://img.shields.io/pypi/v/giga-spatial.svg?color=277aff" alt="PyPI version"></a>
  <a href="https://pypi.org/project/giga-spatial/"><img src="https://img.shields.io/pypi/pyversions/giga-spatial.svg?color=277aff" alt="Python versions"></a>
  <a href="https://github.com/unicef/giga-spatial/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0-277aff.svg" alt="License: AGPL-3.0"></a>
  <a href="https://pepy.tech/projects/giga-spatial"><img src="https://static.pepy.tech/badge/giga-spatial/month" alt="Downloads"></a>
  <a href="https://unicef.github.io/giga-spatial/"><img src="https://img.shields.io/badge/docs-unicef.github.io-277aff.svg" alt="Documentation"></a>
</p>

GigaSpatial acquires published geospatial datasets into a data store you control, loads them for a source, and processes them. A generator maps a dataset onto points of interest or zones, and the result is a view: those places with attributes from the datasets attached. It started in UNICEF's [Giga](https://giga.global/) initiative.

## What it covers

- **[Handlers](https://unicef.github.io/giga-spatial/latest/api/handlers/)** acquire datasets published as files, such as population, built-up area, and buildings.
- **[Fetchers](https://unicef.github.io/giga-spatial/latest/api/fetchers/)** query datasets served by an API, such as OpenStreetMap and Giga school data.
- **[Generators](https://unicef.github.io/giga-spatial/latest/api/generators/)** map datasets onto points of interest or zones and return a view.
- **[Processing](https://unicef.github.io/giga-spatial/latest/user-guide/processing/)** provides raster and vector tools for the stored files.

Files live in a [data store](https://unicef.github.io/giga-spatial/latest/api/data-stores/): local disk, Azure Data Lake Storage, or Snowflake. Handlers only depend on the abstract `DataStore`, so other stores can be added by implementing it.

The full list of datasets is on the [Datasets](https://unicef.github.io/giga-spatial/latest/getting-started/datasets/) page.

## Installation

GigaSpatial requires Python 3.10 or above.

```console
pip install giga-spatial
```

To install every optional integration (Earth Engine, BigQuery, Azure, Snowflake, and others):

```console
pip install "giga-spatial[all]"
```

The individual extras are listed on the [Installation](https://unicef.github.io/giga-spatial/latest/getting-started/installation/) page.

## Example

Map WorldPop population onto H3 cells for Rwanda. The first run downloads the population raster into the data store, and later runs read the stored file.

```python
from gigaspatial import H3ViewGenerator

zones = H3ViewGenerator(source="RWA", resolution=6)
view = zones.map_wp_pop(country="RWA")
print(view.head())
```

`view` is the H3 cells with population attached. The same pattern works with `S2ViewGenerator` and `MercatorViewGenerator`.

<p align="center">
  <img src="https://raw.githubusercontent.com/unicef/giga-spatial/main/docs/assets/readme-rwanda-h3-population.png" alt="Rwanda H3 cells at resolution 6 colored by WorldPop population" width="720">
</p>

## Documentation

- [Installation](https://unicef.github.io/giga-spatial/latest/getting-started/installation/)
- [Tutorial](https://unicef.github.io/giga-spatial/latest/getting-started/quickstart/)
- [Datasets](https://unicef.github.io/giga-spatial/latest/getting-started/datasets/)
- [Configuration](https://unicef.github.io/giga-spatial/latest/getting-started/configuration/)
- [User guide](https://unicef.github.io/giga-spatial/latest/user-guide/)
- [API reference](https://unicef.github.io/giga-spatial/latest/api/)

## Why open source?

At Giga, we believe in the power of open-source technologies to accelerate progress and innovation. By keeping our tools and systems open, we:

- Encourage collaboration and contributions from a global community.
- Ensure transparency and trust in our methodologies.
- Empower others to adopt, adapt, and extend our tools to meet their needs.

## Contributing

Contributions are welcome, from bug reports to new datasets. See the [contribution guidelines](https://github.com/unicef/giga-spatial/blob/main/CONTRIBUTING.md) to get started.

Everyone taking part is expected to follow the [Code of Conduct](https://github.com/unicef/giga-spatial/blob/main/CODE_OF_CONDUCT.md).

## Get in touch

- Report bugs and ask questions in [GitHub Issues](https://github.com/unicef/giga-spatial/issues).
- Follow Giga on [X](https://x.com/Gigaglobal) and [LinkedIn](https://www.linkedin.com/company/gigaglobal/).
- Learn more about Giga at [giga.global](https://giga.global/).

## About Giga

[Giga](https://giga.global/) is a UNICEF-ITU initiative to connect every school to the Internet and every young person to information, opportunity and choice. Giga maps schools' Internet access in real time, creates models for innovative financing, and supports governments contracting for connectivity.

GigaSpatial is developed by Giga's applied science team at UNICEF.

Licensed under [AGPL-3.0-or-later](https://github.com/unicef/giga-spatial/blob/main/LICENSE).
