diff --git a/README.md b/README.md index 341ffc6..50f5a62 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # icesat2-boreal-tile-benchmark + Benchmarks for tile rendering performance for the icesat2-boreal dataset + +To install the dependencies, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/) then: + +```bash +uv sync +``` + +To run the benchmark locally: + +```bash +uv run pytest --benchmark-json /tmp/benchmark.json +``` + +To run the benchmark and commit the result to the repository you can execute the `benchmark.yml` Github Action script in the Github UI or with the `gh` CLI: + +```bash +gh workflow run benchmark.yml +``` + +To preview the quarto website locally: + +```bash +uv run quarto preview +``` diff --git a/_quarto.yml b/_quarto.yml index 655f0f0..3990c5a 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -3,9 +3,9 @@ project: website: title: "icesat2-boreal tile benchmarking" - site-url: "https://developmentseed.org/icesat2-boreal-tile-benchmark" - repo-url: https://github.com/developmentseed/icesat2-boreal-tile-benchmark" - repo-actions: [edit, issue] + site-url: https://developmentseed.org/icesat2-boreal-tile-benchmark + repo-url: https://github.com/developmentseed/icesat2-boreal-tile-benchmark + repo-actions: [source] page-navigation: true page-footer: diff --git a/index.qmd b/index.qmd index 09fdb3f..43c98d5 100644 --- a/index.qmd +++ b/index.qmd @@ -22,6 +22,7 @@ We are testing two dynamic tile rendering services that use different methods to - Queries a `pgstac` database to determine which STAC items in the `icesat2-boreal` collection are required to render an image for an XYZ tile - Requires a Lambda and Postgresql database to be deployed - Struggles to render tiles at zoom levels 5 and below +- See deployment details in [maap-eoapi](https://github.com/MAAP-Project/maap-eoapi) ### titiler: `/mosaicjson/{mosaic_id}/tiles` endpoint - Queries a MosaicJSON document in a dynamodb table to get the pre-calculated list of assets required to render an image for an XYZ tile