Metadata-Version: 2.4
Name: h3_turbo_sm89
Version: 1.0.6
Summary: SYCL-accelerated H3 geospatial library
Home-page: https://github.com/example/h3-sycl-bridge
Author: Craig
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: h3>=4.0.0
Requires-Dist: nbformat
Provides-Extra: spark
Requires-Dist: pyspark; extra == "spark"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# H3 SYCL Bridge

## Docker Prerequisites

To run the Docker images with GPU acceleration enabled (`h3-turbo`), you must ensure your host machine is correctly configured with NVIDIA drivers and Docker support.

Specifically, the following must be installed:

1.  **NVIDIA Drivers**: Ensure you have the NVIDIA GPU drivers installed on your host (compatible with CUDA 12.0+).
2.  **nvidia-container-toolkit**: This toolkit enables the Docker engine to access the GPU.

### Installation Guide

For the **NVIDIA Container Toolkit**, please follow the official installation guide.

After installing the toolkit, remember to restart the Docker daemon:
```bash
sudo systemctl restart docker
```

You can then verify your setup by running:
```bash
docker run --rm --gpus all nvidia/cuda:12.0.0-base-ubuntu22.04 nvidia-smi
```

## Running Automated Benchmarks via Docker

To run the automated benchmarks using Docker, you can use the provided `docker-compose.benchmark.yml` file. This setup automatically builds the necessary environment and executes `benchmark_runner.py` with GPU support enabled.

Make sure you have your `H3_TURBO_LICENSE` environment variable set, or pass it directly. Run the following command:

```bash
H3_TURBO_LICENSE=your_license_here docker compose -f docker-compose.benchmark.yml up --build
```

**Note:** Generated 1-month licenses are available within the Docker images published at [https://hub.docker.com/repositories/cflockhart](https://hub.docker.com/repositories/cflockhart).
