Skip to content

Commit

Permalink
Merge pull request #1 from stac-extensions/pv/initial
Browse files Browse the repository at this point in the history
initial commit of landsat definitions
  • Loading branch information
Phil Varner authored Nov 7, 2023
2 parents a83ce42 + c00d12b commit 51cc3cb
Show file tree
Hide file tree
Showing 6 changed files with 1,156 additions and 348 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [2.0.0]

### Added

- Initial creation of community extension from <https://landsat.usgs.gov/stac/landsat-extension/v1.1.1/schema.json>
- Added `landsat:product_generated` field

### Changed

### Deprecated
Expand All @@ -16,4 +20,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed

[Unreleased]: <https://github.com/stac-extensions/template/compare/v1.0.0...HEAD>
<!-- [Unreleased]: <https://github.com/stac-extensions/landsat/compare/v1.0.0...HEAD> -->
[2.0.0]: <https://github.com/stac-extensions/landsat/tag/v2.0.0>
68 changes: 31 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# Template Extension Specification
# Landsat Extension Specification

- **Title:** Template
- **Identifier:** <https://stac-extensions.github.io/template/v1.0.0/schema.json>
- **Field Name Prefix:** template
- **Scope:** Item, Collection
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
- **Owner**: @your-gh-handles @person2
- **Title:** Landsat
- **Identifier:** <https://stac-extensions.github.io/landsat/v2.0.0/schema.json>
- **Field Name Prefix:** landsat
- **Scope:** Item
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Stable
- **Owner**: @philvarner

This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
This is the place to add a short introduction.
This document explains the Landsat Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.

- Examples:
- [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item
- [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection
- [JSON Schema](json-schema/schema.json)
- [Changelog](./CHANGELOG.md)

Expand All @@ -21,41 +19,34 @@ This is the place to add a short introduction.
The fields in the table below can be used in these parts of STAC documents:

- [ ] Catalogs
- [x] Collections
- [ ] Collections
- [x] Item Properties (incl. Summaries in Collections)
- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- [ ] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- [ ] Links

| Field Name | Type | Description |
| -------------------- | ------------------------- | -------------------------------------------- |
| template:new_field | string | **REQUIRED**. Describe the required field... |
| template:xyz | [XYZ Object](#xyz-object) | Describe the field... |
| template:another_one | \[number] | Describe the field... |
| Field Name | Type | Description |
| --------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| landsat:scene_id | string | Landsat Scene Identifier |
| landsat:collection_category | string | Collection Category |
| landsat:collection_number | string | Collection Number |
| landsat:wrs_type | string | WRS Type |
| landsat:wrs_path | string | WRS Path |
| landsat:wrs_row | string | WRS Row |
| landsat:cloud_cover_land | number | Land Cloud Cover |
| landsat:correction | string | Product Correction Level |
| landsat:product_generated | string | The dateime that the product (data) was generated, formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6). |

### Additional Field Information

#### template:new_field
#### landsat:product_generated

This is a much more detailed description of the field `template:new_field`...

### XYZ Object

This is the introduction for the purpose and the content of the XYZ Object...

| Field Name | Type | Description |
| ---------- | ------ | -------------------------------------------- |
| x | number | **REQUIRED**. Describe the required field... |
| y | number | **REQUIRED**. Describe the required field... |
| z | number | **REQUIRED**. Describe the required field... |
The datetime associated with the generation of the product. This will typically be
the metadata field at the path `LEVEL1_PROCESSING_RECORD/DATE_PRODUCT_GENERATED` or
`LEVEL2_PROCESSING_RECORD/DATE_PRODUCT_GENERATED`.

## Relation types

The following types should be used as applicable `rel` types in the
[Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object).

| Type | Description |
| -------------- | ------------------------------------- |
| fancy-rel-type | This link points to a fancy resource. |
None.

## Contributing

Expand All @@ -67,23 +58,26 @@ for running tests are copied here for convenience.

### Running tests

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.
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](https://nodejs.org/en/download/).

First you'll need to install everything with npm once. Just navigate to the root of this repository and on
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
your command line run:

```bash
npm install
```

Then to check markdown formatting and test the examples against the JSON schema, you can run:

```bash
npm test
```

This 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:

```bash
npm run format-examples
```
73 changes: 0 additions & 73 deletions examples/collection.json

This file was deleted.

Loading

0 comments on commit 51cc3cb

Please sign in to comment.