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

Add data store parameters and data ID to the assets in the STAC published by xcube server #1029

Merged
merged 6 commits into from
Jul 10, 2024
Merged

Add data store parameters and data ID to the assets in the STAC published by xcube server #1029

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
872c4af
STAC implementation adjusted
konstntokas Jun 28, 2024
b52de1c
tests and CHANGES.md adjusted
konstntokas Jun 28, 2024
d05b72e
black8
konstntokas Jul 4, 2024
f7ae1b2
mldataset publication added to STAC assets
konstntokas Jul 8, 2024
c806c6d
update CHANGES.md
konstntokas Jul 8, 2024
be95304
Normans review addressed
konstntokas Jul 10, 2024
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
5 changes: 5 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@
* The `xcube.core.store.DataDescriptor` class now supports specifying time ranges
using both `datetime.date` and `datetime.datetime` objects. Previously,
only `datetime.date` objects were supported.
* The xcube server STAC publication has been adjusted so that the data store
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* The xcube server STAC publication has been adjusted so that the data store
* The xcube server STAC API has been adjusted so that the data store

parameters and data ID, which are needed to open the data,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
parameters and data ID, which are needed to open the data,
parameters and data ID, which are needed to open the data referred to by a STAC item,

are now included with the asset; furthermore, a second assert called
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
are now included with the asset; furthermore, a second assert called
are now included with the item's `analytic` asset.
Furthermore, a second assert called

`analytic_multires` will be published referring to the multi-resolution data format
levels (#1020).

## Changes in 1.6.0

Expand Down
78 changes: 77 additions & 1 deletion test/webapi/ows/stac/demo-collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/datasets/demo.zarr",
"xcube:store_kwargs": {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"xcube:store_kwargs": {
"xcube:data_store_params": {

to align it with keyword argument data_store_params of the data store API function new_data_store().

"data_store_id": "s3",
Copy link
Member

Choose a reason for hiding this comment

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

Use separate asset xcube:data_store_id to align it with the positional argument data_store_id of the data store API function new_data_store().

"root": "datasets",
"storage_options": {
"anon": true,
"client_kwargs": {
"endpoint_url": "http://localhost:8080/s3"
}
}
},
"xcube:open_kwargs": {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"xcube:open_kwargs": {
"xcube:open_data_params": {

to align it with data store API method DataStore.open_data() (-> open_data) that takes all the given parameters (-> params). And align it API method DataStore.get_open_data_params_schema() .

"data_id": "demo.zarr"
},
"xcube:analytic": {
"c2rcc_flags": {
"title": "c2rcc_flags data access",
Expand Down Expand Up @@ -50,6 +63,69 @@
}
}
},
"analytic_multires": {
"title": "demo multi-resolution data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo.levels",
"xcube:store_kwargs": {
Copy link
Member

Choose a reason for hiding this comment

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

See above.

"data_store_id": "s3",
"root": "pyramids",
"storage_options": {
"anon": true,
"client_kwargs": {
"endpoint_url": "http://localhost:8080/s3"
}
}
},
"xcube:open_kwargs": {
Copy link
Member

Choose a reason for hiding this comment

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

See above.

"data_id": "demo.levels"
},
"xcube:analytic_multires": {
"c2rcc_flags": {
"title": "c2rcc_flags data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo.levels/0.zarr/c2rcc_flags"
},
"conc_chl": {
"title": "conc_chl data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo.levels/0.zarr/conc_chl"
},
"conc_tsm": {
"title": "conc_tsm data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo.levels/0.zarr/conc_tsm"
},
"kd489": {
"title": "kd489 data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo.levels/0.zarr/kd489"
},
"quality_flags": {
"title": "quality_flags data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo.levels/0.zarr/quality_flags"
}
}
},
"visual": {
"title": "demo visualisation",
"roles": [
Expand Down Expand Up @@ -807,4 +883,4 @@
"datetime": null,
"start_datetime": "2017-01-16T10:09:21Z",
"end_datetime": "2017-01-30T10:46:33Z"
}
}
118 changes: 117 additions & 1 deletion test/webapi/ows/stac/stac-datacubes-item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -970,6 +970,19 @@
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/datasets/demo-1w.zarr",
"xcube:store_kwargs": {
"data_store_id": "s3",
"root": "datasets",
"storage_options": {
"anon": true,
"client_kwargs": {
"endpoint_url": "http://localhost:8080/s3"
}
}
},
"xcube:open_kwargs": {
"data_id": "demo-1w.zarr"
},
"xcube:analytic": {
"c2rcc_flags": {
"title": "c2rcc_flags data access",
Expand Down Expand Up @@ -1053,6 +1066,109 @@
}
}
},
"analytic_multires": {
"title": "demo-1w multi-resolution data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels",
"xcube:store_kwargs": {
"data_store_id": "s3",
"root": "pyramids",
"storage_options": {
"anon": true,
"client_kwargs": {
"endpoint_url": "http://localhost:8080/s3"
}
}
},
"xcube:open_kwargs": {
"data_id": "demo-1w.levels"
},
"xcube:analytic_multires": {
"c2rcc_flags": {
"title": "c2rcc_flags data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/c2rcc_flags"
},
"conc_chl": {
"title": "conc_chl data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_chl"
},
"conc_tsm": {
"title": "conc_tsm data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_tsm"
},
"kd489": {
"title": "kd489 data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/kd489"
},
"quality_flags": {
"title": "quality_flags data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/quality_flags"
},
"c2rcc_flags_stdev": {
"title": "c2rcc_flags_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/c2rcc_flags_stdev"
},
"conc_chl_stdev": {
"title": "conc_chl_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_chl_stdev"
},
"conc_tsm_stdev": {
"title": "conc_tsm_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_tsm_stdev"
},
"kd489_stdev": {
"title": "kd489_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/kd489_stdev"
},
"quality_flags_stdev": {
"title": "quality_flags_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/quality_flags_stdev"
}
}
},
"visual": {
"title": "demo-1w visualisation",
"roles": [
Expand Down Expand Up @@ -1152,4 +1268,4 @@
"href": "http://localhost:8080/tiles/demo-1w/c2rcc_flags/0/0/0?time=2017-01-22T00:00:00.000000000"
}
}
}
}
118 changes: 117 additions & 1 deletion test/webapi/ows/stac/stac-single-item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -970,6 +970,19 @@
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/datasets/demo-1w.zarr",
"xcube:store_kwargs": {
"data_store_id": "s3",
"root": "datasets",
"storage_options": {
"anon": true,
"client_kwargs": {
"endpoint_url": "http://localhost:8080/s3"
}
}
},
"xcube:open_kwargs": {
"data_id": "demo-1w.zarr"
},
"xcube:analytic": {
"c2rcc_flags": {
"title": "c2rcc_flags data access",
Expand Down Expand Up @@ -1053,6 +1066,109 @@
}
}
},
"analytic_multires": {
"title": "demo-1w multi-resolution data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels",
"xcube:store_kwargs": {
"data_store_id": "s3",
"root": "pyramids",
"storage_options": {
"anon": true,
"client_kwargs": {
"endpoint_url": "http://localhost:8080/s3"
}
}
},
"xcube:open_kwargs": {
"data_id": "demo-1w.levels"
},
"xcube:analytic_multires": {
"c2rcc_flags": {
"title": "c2rcc_flags data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/c2rcc_flags"
},
"conc_chl": {
"title": "conc_chl data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_chl"
},
"conc_tsm": {
"title": "conc_tsm data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_tsm"
},
"kd489": {
"title": "kd489 data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/kd489"
},
"quality_flags": {
"title": "quality_flags data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/quality_flags"
},
"c2rcc_flags_stdev": {
"title": "c2rcc_flags_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/c2rcc_flags_stdev"
},
"conc_chl_stdev": {
"title": "conc_chl_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_chl_stdev"
},
"conc_tsm_stdev": {
"title": "conc_tsm_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/conc_tsm_stdev"
},
"kd489_stdev": {
"title": "kd489_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/kd489_stdev"
},
"quality_flags_stdev": {
"title": "quality_flags_stdev data access",
"roles": [
"data"
],
"type": "application/zarr",
"href": "http://localhost:8080/s3/pyramids/demo-1w.levels/0.zarr/quality_flags_stdev"
}
}
},
"visual": {
"title": "demo-1w visualisation",
"roles": [
Expand Down Expand Up @@ -1152,4 +1268,4 @@
"href": "http://localhost:8080/tiles/demo-1w/c2rcc_flags/0/0/0?time=2017-01-22T00:00:00.000000000"
}
}
}
}
Loading
Loading