diff --git a/CHANGELOG.md b/CHANGELOG.md index b4847865..ea4b5993 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added +- Added introduction section - What is stac-fastapi-elasticsearch-opensearch? - to README [#384](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/384) + ### Changed - Improved README documentation with consistent formatting and enhanced sections [#381](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/381): diff --git a/README.md b/README.md index a5cf0ccd..ada24e5d 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,10 @@

- +

-

Elasticsearch and Opensearch backends for the stac-fastapi project.

+ +**Jump to:** [Project Introduction](#project-introduction---what-is-sfeos) | [Quick Start](#quick-start) | [Table of Contents](#table-of-contents) [![Downloads](https://static.pepy.tech/badge/stac-fastapi-core?color=blue)](https://pepy.tech/project/stac-fastapi-core) [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-fastapi-elasticsearch-opensearch?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/graphs/contributors) @@ -17,29 +18,50 @@ [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0) [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-5.2.0-blue.svg)](https://github.com/stac-utils/stac-fastapi) - -
- - ## Sponsors & Supporters The following organizations have contributed time and/or funding to support the development of this project:

- Healy Hyperspatial - Atomic Maps + Healy Hyperspatial + Atomic Maps

+## Project Introduction - What is SFEOS? + +SFEOS (stac-fastapi-elasticsearch-opensearch) is a high-performance, scalable API implementation for serving SpatioTemporal Asset Catalog (STAC) data - an enhanced GeoJSON format designed specifically for geospatial assets like satellite imagery, aerial photography, and other Earth observation data. This project enables organizations to: + +- **Efficiently catalog and search geospatial data** such as satellite imagery, aerial photography, DEMs, and other geospatial assets using Elasticsearch or OpenSearch as the database backend +- **Implement standardized STAC APIs** that support complex spatial, temporal, and property-based queries across large collections of geospatial data +- **Scale to millions of geospatial assets** with fast search performance through optimized spatial indexing and query capabilities +- **Support OGC-compliant filtering** including spatial operations (intersects, contains, etc.) and temporal queries +- **Perform geospatial aggregations** to analyze data distribution across space and time + +This implementation builds on the STAC-FastAPI framework, providing a production-ready solution specifically optimized for Elasticsearch and OpenSearch databases. It's ideal for organizations managing large geospatial data catalogs who need efficient discovery and access capabilities through standardized APIs. + + + +## Common Deployment Patterns + +stac-fastapi-elasticsearch-opensearch can be deployed in several ways depending on your needs: + +- **Containerized Application**: Run as a Docker container with connections to Elasticsearch/OpenSearch databases +- **Serverless Function**: Deploy as AWS Lambda or similar serverless function with API Gateway +- **Traditional Server**: Run on virtual machines or bare metal servers in your infrastructure +- **Kubernetes**: Deploy as part of a larger microservices architecture with container orchestration + +The implementation is flexible and can scale from small local deployments to large production environments serving millions of geospatial assets. + ## Technologies This project is built on the following technologies: STAC, stac-fastapi, FastAPI, Elasticsearch, Python, OpenSearch

- STAC - Python - FastAPI - Elasticsearch - OpenSearch + STAC + Python + FastAPI + Elasticsearch + OpenSearch

## Table of Contents diff --git a/assets/sfeos.png b/assets/sfeos.png index c98a1e40..a816f16c 100644 Binary files a/assets/sfeos.png and b/assets/sfeos.png differ