Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document available features #38

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Loading