Skip to content

API Reference

Welcome to the GigaSpatial API reference documentation. This section provides detailed information about all public modules, classes, and functions in GigaSpatial.

API Structure

GigaSpatial's API is organized into several main components:

Core Module

Handlers Module

Processing Module

Grid Module

Utils Module

Using the API

Installation

Since GigaSpatial is currently in development, you'll need to install it directly from the repository:

# Clone the repository
git clone https://github.com/unicef/giga-spatial
cd giga-spatial

# Create and activate a virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate

pip install -r requirements.txt

Import Convention

Once installed, you can import GigaSpatial components.

Version Compatibility

  • API stability is guaranteed for all releases following semantic versioning
  • Breaking changes are only introduced in major version updates
  • Deprecation warnings are issued at least one minor version before removal

Contributing

If you'd like to contribute to the GigaSpatial:

  1. Read our Contributing Guide
  2. Submit a pull request with your changes

Need Help?

If you need assistance with the GigaSpatial: