Skip to content

Commit

Permalink
document available features
Browse files Browse the repository at this point in the history
  • Loading branch information
nicokant committed Sep 11, 2024
1 parent b00b870 commit bd7b3d4
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Summary

- [Features](./features.md)
- [Architecture](./architecture.md)

# Modules
Expand Down
50 changes: 50 additions & 0 deletions docs/src/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Software features
Here is a list of the features available in the metadata catalogue

## Metadata module
- Automatic ingestion of DWCA datasets published on IPT
- CSW support to explore/query datasets metadata
- Metadata exposed in ISO 19139


## Dataset module
Current:
- Expose vector datasets with OGC API - Features (via PyGEOAPI)
- Different GDAL providers supported (gpkg, shp, parquet, postgresql, csv)
- Support DWCA dataset
- Support on-the-fly operation on vectors

Not supported:
- Other OGC API standards (Coverage, Maps, Tiles, Processes, Records, Environmental Data Retrieval, STAC)


## Maps module
**NOTE**: The software is intended as a solution for displaying datasets on the web using cloud-optimized formats that don't require GIS servers.

Current:
- Display vector datasets (via PMTiles)
- Display raster datasets (via Cloud-Optimized GeoTIFF)
- Organize layers in hierarchy/groups
- Layer legends
- Download of the original dataset
- Style rendering of raster (via TiTiler)
- Style rendering of vectors (via Maplibre JS)
- Zoom to bounding box
- Description of each layer
- Description of each group
- Description of the map
- Custom logo, title
- Basemaps
- APIs for create, edit the map
- Limited UI for simple edit
- Basic info popup

Not supported:
- Query/filter datasets features
- Dynamic style change
- Dynamic datasets that change frequently
- Clusters
- Analysis


It's possible to (re)use the Maps module as a base and to customize it or to develop features based for projects with different requirements.

0 comments on commit bd7b3d4

Please sign in to comment.