- Title: Locale
- Identifier: https://stac-extensions.github.io/locale/v1.0.0/schema.json
- Field Name Prefix: locale
- Scope: Item, Collection
- Extension Maturity Classification: Proposal
- Owner: @jkeifer
This document explains the Locale Extension to the SpatioTemporal Asset Catalog (STAC) specification. Allows specifying properties specific to the local area represented in the item or collection.
- Examples:
- Item example: Shows the basic usage of the extension in a STAC Item
- Collection example: Shows the basic usage of the extension in a STAC Collection
- JSON Schema
- Changelog
The fields in the table below can be used in these parts of STAC documents:
- Catalogs
- Collections
- Item Properties (incl. Summaries in Collections)
- Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- Links
| Field Name | Type | Description |
|---|---|---|
| locale:datetime | string | datetime in the local timezone. |
| locale:start_datetime | string | start_datetime in the local timezone. |
| locale:end_datetime | string | end_datetime in the local timezone. |
| locale:tz_offset | float | Local timezone offset at datetime. |
| locale:solar_zenith | float | Sun angle relative to the horizon at datetime. |
| locale:start_solar_zenith | float | Sun angle relative to the horizon at start_datetime. |
| locale:end_solar_zenith | float | Sun angle relative to the horizon at end_datetime. |
All timestamps MUST be formatted according to RFC 3339, section 5.6.
The timestamps have different meaning depending on where they are used. If those fields are available in the Item properties, it's referencing to the timestamps valid for of the metadata. Having those fields in the Item assets refers to the timestamps valid for the actual data linked to in the Asset Object.
All values are assumed to be derived from the item's centroid unless otherwise documented.
All contributions are subject to the STAC Specification Code of Conduct. For contributions, please follow the STAC specification contributing guide Instructions for running tests are copied here for convenience.
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
To run tests locally, you'll need npm, which is a standard part of any node.js installation.
First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run:
npm installThen to check markdown formatting and test the examples against the JSON schema, you can run:
npm testThis will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
If the tests reveal formatting problems with the examples, you can fix them with:
npm run format-examples