-
Notifications
You must be signed in to change notification settings - Fork 0
Dataset Enrichment
Eric Hackathorn edited this page Sep 13, 2025
·
1 revision
Zyra can enrich search results or standalone item lists with additional metadata (variables, time bounds, spatial hints, size info, license defaults). Use this to quickly assess datasets before building pipelines.
-
shallow
: heuristics from names/descriptions; cheap and offline‑friendly. -
capabilities
: parse remote descriptors (e.g., WMS GetCapabilities, OGC Records); respects offline/HTTPS/allow/deny guards. -
probe
: cautiously inspect referenced data (e.g., NetCDF/GeoTIFF) within size/time limits. Requires relevant extras.
- GET
/v1/search?...&enrich=shallow|capabilities|probe
(see Search-API-and-Profiles.md) - POST
/v1/search
withenrich
keys mirrors GET.
Common options (query params or POST keys)
-
enrich_timeout
(seconds),enrich_workers
(concurrency),cache_ttl
(seconds) - Guards:
offline
,https_only
,allow_hosts
,deny_hosts
,max_probe_bytes
- Profile‑scoped defaults/policies are applied when a
profile
orprofile_file
is provided.
Enrich a saved items JSON (either a bare list or { "items": [...] }
).
zyra transform enrich-datasets \
--items-file items.json \
--enrich shallow \
--profile sos \
--offline \
--output enriched.json
Each item should include: id
, name
, description
, source
, format
, uri
.
When using files in catalog_file
or profile_file
contexts:
- Catalogs must be under
ZYRA_CATALOG_DIR
orDATA_DIR
. - Profiles must be under
ZYRA_PROFILE_DIR
orDATA_DIR
. - Packaged references are allowed with
pkg:module/resource
.
- Extras: install
processing
andvisualization
as needed for certain probes. - Network: disable with
offline
or require TLS withhttps_only
.
- Search-API-and-Profiles.md
- Workflow-Stages.md (import/process/visualize/export)
- Connectors (docs): https://noaa-gsl.github.io/zyra/api/zyra.connectors.html
- Processing (docs): https://noaa-gsl.github.io/zyra/api/zyra.processing.html
- Visualization (docs): https://noaa-gsl.github.io/zyra/api/zyra.visualization.html
- Transform (docs): https://noaa-gsl.github.io/zyra/api/zyra.transform.html
- Utils (docs): https://noaa-gsl.github.io/zyra/api/zyra.utils.html