You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`eoAPI` combines several *state-of-the-art* projects to create a full Earth Observation API. Each service can be used and deployed independently, but `eoAPI` creates the interconnections between each service:
-**STAC API** built on top of [https://github.com/stac-utils/stac-fastapi](https://github.com/stac-utils/stac-fastapi)
22
+
`eoAPI` combines several state-of-the-art projects to create a full Earth Observation API. Each service can be used and deployed independently, but `eoAPI` creates the interconnections between each service:
27
23
28
-
-**STAC Items And Mosaic Raster Tiles**API built on top of [https://github.com/stac-utils/titiler-pgstac](https://github.com/stac-utils/titiler-pgstac)
29
-
30
-
-**OGC Features and Vector Tiles** API built on top of[https://github.com/developmentseed/tipg](https://github.com/developmentseed/tipg)
31
-
32
-
-**A STAC Catalog browsing UI** based on the radiant earth browser : [https://github.com/radiantearth/stac-browser](https://github.com/radiantearth/stac-browser)
-**STAC API** built on top of: https://github.com/stac-utils/stac-fastapi
26
+
-**STAC Items And Mosaic Raster Tiles** API built on top of: https://github.com/stac-utils/titiler-pgstac
27
+
-**OGC Features and Vector Tiles** API built on top of: https://github.com/developmentseed/tipg
28
+
-**A STAC Catalog browsing UI** based on the radiant earth browser: https://github.com/radiantearth/stac-browser
33
29
34
30
---
35
31
36
32
## 🌍 eoAPI: An Open-Source Community Project
37
33
38
34
`eoAPI` is proudly open-source and driven by a dedicated community of contributors. We believe in the power of open collaboration and welcome anyone to contribute, discuss, and grow this tool. Join the conversations on [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions) and make a difference in the Earth Observation realm.
39
35
40
-
41
36
---
42
37
43
38
## Getting started
44
39
45
-
The easiest way to start exploring the different eoAPI services is with *Docker*. Clone this repository and start the multi-container *Docker* applications using `Compose`:
40
+
The easiest way to explore the different eoAPI services is with **Docker**. Clone this repository and start the multi-container **Docker** applications using `Compose`:
Once the applications are *up*, you'll need to add STAC **Collections** and **Items** to the PgSTAC database. If you don't have these available, you can follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)).
48
+
Once the applications are **up**, you'll need to add STAC **Collections** and **Items** to the PgSTAC database. If you don't have these available, you can follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)).
54
49
55
50
Then you can start exploring your dataset with:
56
51
57
-
- the STAC Metadata service[http://localhost:8081](http://localhost:8081)
58
-
- the Raster service[http://localhost:8082](http://localhost:8082)
59
-
- the browser UI[http://localhost:8085](http://localhost:8085)
52
+
- the STAC Metadata service: http://localhost:8081
53
+
- the Raster service: http://localhost:8082
54
+
- the browser UI: http://localhost:8085
60
55
61
-
If you've added a vector dataset to the `public` schema in the Postgres database, they will be available through the **Vector** service at [http://localhost:8083](http://localhost:8083).
56
+
If you've added a vector dataset to the `public` schema in the Postgres database, they will be available through the **Vector** service at http://localhost:8083.
62
57
63
58
### Local deployment
64
59
@@ -72,16 +67,14 @@ Alternatively, you may install the libraries and launch the applications manuall
72
67
python -m pip install --upgrade virtualenv
73
68
virtualenv .venv
74
69
source .venv/bin/activate
75
-
76
70
export DATABASE_URL=postgresql://username:[email protected]:5439/postgis # Connect to the database of your choice
@@ -109,21 +102,21 @@ Note: Python libraries might have incompatible dependencies, which you can resol
109
102
110
103
#### AWS CDK
111
104
112
-
[eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) defines a set of AWS CDK constructs that can be used to deploy eoAPI services on AWS. An official example usage of these constructs can be found at [eoapi-template](https://github.com/developmentseed/eoapi-template).
113
-
105
+
[eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) defines a set of AWS CDK constructs that can be used to deploy eoAPI services on AWS. An official example of these constructs is at [eoapi-template](https://github.com/developmentseed/eoapi-template).
114
106
115
107
## Deployment with custom runtimes
116
108
117
109
An example of custom eoAPI runtimes and deployment can be found at [eoapi-devseed](https://github.com/developmentseed/eoapi-devseed).
118
110
119
111
## Contribution & Development
120
112
121
-
We highly value and rely on our community! You can make a difference whether you're an expert or just getting started. Here's how:
113
+
We highly value and rely on our community! Whether you're an expert or just getting started, you can make a difference. Here's how:
122
114
123
115
-**Engage in Discussions**: Share your ideas, ask questions, or provide feedback through [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions). This is where most of our project conversations take place.
124
116
-**Report Issues**: Found a bug or have a feature request? Raise it on our [issues page](https://github.com/developmentseed/eoAPI/issues).
125
117
126
118
---
119
+
127
120
## License
128
121
129
122
At Development Seed, we believe in open collaboration and making tools and data more accessible. In line with this ethos, we've explicitly chosen a MIT license for `eoAPI`.
@@ -132,6 +125,6 @@ For full license details, see [LICENSE](https://github.com/developmentseed/eoAPI
132
125
133
126
## Authors
134
127
135
-
Nurtured by [Development Seed](<http://developmentseed.org>)
128
+
Nurtured by [Development Seed](http://developmentseed.org)
136
129
137
-
See [contributors](https://github.com/developmentseed/eoAPI/graphs/contributors) for a listing of individual contributors.
130
+
See [contributors](https://github.com/developmentseed/eoAPI/graphs/contributors) for a listing of individual contributors.
The **eoapi-devseed** repository (https://github.com/developmentseed/eoapi-devseed) hosts customized versions of each base service. The documentation below demonstrates how each service can be customized. The eoAPI services can work in parallel or in combination with each other.
2
1
3
-
---
2
+
The **eoapi-devseed**[repository](https://github.com/developmentseed/eoapi-devseed) hosts customized versions of each base service. The documentation below demonstrates how each service can be customized. The eoAPI services can work in parallel or combination with each other.
3
+
4
4
## eoapi.stac
5
5
6
6
Built on [stac-fastapi.pgstac](https://github.com/stac-utils/stac-fastapi-pgstac) application, adding a **`TiTilerExtension`** and a simple **`Search Viewer`**.
7
7
8
8
The service includes:
9
9
10
-
-Full **stac-fastapi** implementation - see [docs](http://localhost:8081/docs)if using the `docker-compose` configuration.
11
-
- Simple STAC Search **viewer** - see [viewer](http://localhost:8081/index.html) if using the `docker-compose` configuration.
10
+
-If you use the `docker-compose` configuration, see [docs](http://localhost:8081/docs)for the full `stac-fastapi` implementation.
11
+
- Simple STAC Search viewer—see [viewer](http://localhost:8081/index.html) if you are using the `docker-compose` configuration.
12
12
-**Proxy** to the tiler endpoint for STAC Items.
13
13
14
14
When the `TITILER_ENDPOINT` environment variable is set (pointing to the `raster` application), additional endpoints will be added to the stac-fastapi application (see: [stac/extension.py](https://github.com/developmentseed/eoapi-devseed/blob/main/runtimes/eoapi/stac/eoapi/stac/extension.py)):
@@ -17,55 +17,54 @@ When the `TITILER_ENDPOINT` environment variable is set (pointing to the `raster
17
17
-`/collections/{collectionId}/items/{itemId}/viewer`: Redirect to the `raster` viewer
The dynamic tiler deployed within `eoapi-devseed` is built on top of [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) and [pgstac](https://github.com/stac-utils/pgstac). It enables large-scale mosaic based on the results of STAC search queries.
30
31
31
32
The service includes all the default endpoints from **titiler-pgstac** application and:
32
33
33
34
-`/`: a custom landing page with links to the different endpoints
34
-
35
-
-`/mosaic/builder`: a virtual mosaic builder UI, which helps create and register STAC Search queries
36
-
37
-
-`/collections`: a *secret* (not in OpenAPI documentation) endpoint used in the mosaic-builder page
38
-
35
+
-`/mosaic/builder`: a virtual mosaic builder UI that helps create and register STAC Search queries
36
+
-`/collections`: a secret (not in OpenAPI documentation) endpoint used in the mosaic-builder page
39
37
-`/collections/{collection_id}/items/{item_id}/viewer`: a simple STAC Item viewer
The custom browser configuration can be modified using the config located in [/dockerfiles/browser_config.js](https://github.com/developmentseed/eoapi-devseed/blob/main/dockerfiles/browser_config.js). For more information about available configurations, see the [Radiant Earth repository](https://github.com/radiantearth/stac-browser).
0 commit comments