Skip to content
Open
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 _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ website:
- section: user-guide/content-curation/dashboard-configuration/index.qmd
contents:
- user-guide/content-curation/dashboard-configuration/dataset-configuration.qmd
- user-guide/content-curation/dashboard-configuration/colormaps.qmd
- user-guide/content-curation/dashboard-configuration/story-configuration.qmd
- section: user-guide/content-curation/docs-and-notebooks.qmd
contents:
Expand Down
25 changes: 25 additions & 0 deletions user-guide/content-curation/dashboard-configuration/colormaps.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Choosing a colormap"
subtitle: "Which VEDA tile service to change when a layer needs a new colormap"
---

VEDA draws map tiles with three separate services. A new colormap only works in the service it was added to. So the first question is: **what kind of data is your layer?**

| If your layer is | Add the colormap to | For developers |
|---|---|---|
| **Image files in the VEDA catalog.** Most Disasters and GHG layers (COGs). | **veda-backend** (the raster API) | [NASA-IMPACT/veda-backend](https://github.com/NASA-IMPACT/veda-backend), `raster_api/runtime/src/cmap_data/` |
| **A data cube with time and variables.** Zarr, NetCDF or GRIB, such as TEMPO or model output. | **titiler-multidim** | [developmentseed/titiler-multidim](https://github.com/developmentseed/titiler-multidim), `src/titiler/multidim/main.py` |
| **NASA archive data found through CMR.** Data read straight from a NASA data center, such as HLS. See [titiler-cmr](../external-collection-indexing/titiler-cmr.qmd). | **titiler-cmr** | [developmentseed/titiler-cmr](https://github.com/developmentseed/titiler-cmr), `titiler/cmr/main.py` |

::: {.callout-tip}
Standard colormaps such as `viridis` and `turbo` already work in every service. If one fits your layer, set `colormap_name` in the layer's configuration and nothing else needs to change.
:::

## Good to know

- If several kinds of data need the same custom colormap, it has to be added to each of those services.
- A layer that fails with "unknown colormap" usually means the colormap was added to a different service.
- Vector layers (boundaries, points) aren't tiled, so their colors are set in the dashboard configuration ([veda-config](https://github.com/NASA-IMPACT/veda-config) and [veda-ui](https://github.com/NASA-IMPACT/veda-ui)).
- There is a [proposal for a shared colormaps library in the earthaccess organization](https://github.com/earthaccess-dev/earthaccess/discussions/1507).

Once the colormap is available, pick it in your layer's `sourceParams` as described in [Dataset Configuration](./dataset-configuration.qmd).
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Once a dataset is available in your VEDA STAC through VEDA Data Services (follow

Please note that the VEDA Dashboard relies on its own set of metadata about datasets. No information from STAC is loaded initially, so some metadata may require copying information from the STAC records, such as title, description, and dataset providers.

::: {.callout-tip}
To choose a colormap for a layer, or to find out which service needs a new one, see [Choosing a colormap](./colormaps.qmd).
:::

### Key Steps

The key steps for configuring a dataset overview page (which is required to reference a dataset in any stories) are similar to configuring a story. The steps are outlined below.
Expand Down
1 change: 1 addition & 0 deletions user-guide/data-services/apis/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Maintenance on the staging environment will be announced internally and selected
* Features API (vector data): [firenrt.delta-backend.com](https://firenrt.delta-backend.com) - see also the [usage tutorial](../user-guide/notebooks/tutorials/mapping-fires.html)
* STAC viewer (experimental): [staging.openveda.cloud/api/stac/index.html](https://staging.openveda.cloud/api/stac/index.html)

For which service draws which kind of layer, and where to add a colormap, see [Choosing a colormap](../../content-curation/dashboard-configuration/colormaps.qmd).

## Using tile layers in external services

Expand Down
Loading