Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ab/request stac metadata #712

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Ab/request stac metadata #712

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9540fa9
Update data_request.md
abarciauskas-bgse Apr 28, 2023
f3f826a
Update data_request.md
abarciauskas-bgse Apr 28, 2023
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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/data_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,36 @@ assignees: freitagb, wildintellect
**Intended science use case**
*Please describe how you intend to use the data, or the expected relevance to MAAP users.*

## Spatio-Temporal Asset Catalog (STAC)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be a separate section? Why does the user need to know that it's specifically for STAC?


This collection will be published as a Spatio-Temporal Asset Catalog (STAC) Collection. You can read the complete STAC collection spec here: (https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md).

If you need help with any of the fields below, please let us know.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fill in any fields you know. If you don't know the answer it can be updated later in consultation with the Data Team.


**id:** Identifier for the Collection that is unique across the provider. This is typically an abbreviated and hyphenated or camel-cased version of the dataset name, For example `gedi_l2a_v002` for "GEDI L2A Elevation and Height Metrics Data Global Footprint Level V002".
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure we should leave this up to users. So maybe it should be clear this is a suggestion.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree w/ Alex here. As the ID needs to be unique, we have to manage it within the catalog and unless we have a feedback loop of which IDs are valid, it will be difficult to have a scientist set the ID.
Is it unique for a "provider" ? Most recent provider (as Provider is a list)? Or is it unique within the catalog?


_We can create an id from the Dataset Name from the first section if not otherwise indicated._

**title:** A short descriptive one-line title for the collection. Technically, this is not requried by the STAC Spec but it is used by the STAC browser.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Title/Description - why don't we just use what's above like the statement and skip asking again?


_We will use the Dataset Name from the first section if not otherwise indicated._

**description:** Detailed multi-line description to fully explain the collection.

_We will reuse the Dataset Description from the first section if not otherwise indicated._

**spatial extent:** A bounding box for the potential spatial extents covered by the collection. Read more in the [spatial-extent-object section of the spec](https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md#spatial-extent-object).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Spatial Extent and Temporal Extent are the most important can we move these to to the top of list?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also the "additional information" section at the bottom mentions spatial and temporal info again


_Please provide the spatial extent as a bounding box._

**temporal extent:** Describes the temporal extents of the collection as an interval. Read more in the [temporal-extent-object section of the spec](https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md#temporal-extent-object).

_Please provide the temporal extent as an interval. If the dataset has a single date time or is currently ongoing, a single date is appropriate._

**links:** A list of references to other documents. There must be a at least one link and we highly recommend and may require in the future link to documentation which includes details about how to access and open the data.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this different from
URL or DOI to dataset description in the top section?


**Again, this is the minimum set of information to publish to STAC. If there is other information to include about the dataset which might be relevant to other users in finding or using the dataset, please let us know and we can help determine how to include that information in the STAC collection.**

## Optional

**Approximate size of data**
Expand Down