Skip to content

developmentseed/titiler-covjson

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

titiler-covjson

CoverageJSON output format and API extension for TiTiler.

Overview

titiler-covjson adds CoverageJSON (OGC Community Standard) as a new output format to TiTiler, enabling any TiTiler deployment to serve geospatial raster and time series data in a standards-compliant, interoperable JSON format.

Features

  • Point query - coverage values at a coordinate
  • Bounding box query - full raster grid or aggregated statistics over an extent
  • Transect / line profile - values sampled along a polyline
  • Tile query - map tiles as CovJSON (alternative to image tiles)
  • Time series - temporal extraction from STAC collections
  • Coverage metadata - domain and parameter info without data
  • Overview - low-resolution downsampled grids via COG overviews

Installation

pip install titiler-covjson

Dependencies

Quick Start

from fastapi import FastAPI
from titiler_covjson.router import covjson_router

app = FastAPI()
app.include_router(covjson_router, prefix="/covjson")

Documentation

See the docs/ directory:

  1. Design Overview - Architecture and key decisions
  2. API Definition - Endpoint specifications with examples
  3. Data Model Reference - CovJSON models via covjson-pydantic
  4. Modeler/Converter Design - Raster to CovJSON conversion
  5. Implementation Roadmap - EPIC with 13 stories
  6. Libraries Analysis - covjson-pydantic & covjson-validator

Project Structure

titiler-covjson/
├── src/titiler_covjson/
│   ├── __init__.py       # Package init
│   ├── helpers.py        # CRS, unit, dtype mapping utilities
│   ├── input.py          # CoverageInput intermediate representation
│   ├── modeler.py        # RasterCovJSONModeler (data -> CovJSON)
│   ├── routes.py         # FastAPI endpoint definitions
│   └── router.py         # TiTiler router extension
├── tests/
├── docs/
├── pyproject.toml
├── LICENSE               # MIT
└── README.md

License

MIT

About

[Work In Progress] CoverageJSON API for Titiler

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages