Skip to content

Commit 921e831

Browse files
authored
Merge pull request #1181 from xcube-dev/konstntokas-xxx-update_data_access_doc_stac
Docs for STAC stores in Data Access updated
2 parents 43a2f6c + 012f73b commit 921e831

File tree

1 file changed

+52
-34
lines changed

1 file changed

+52
-34
lines changed

docs/source/dataaccess.md

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
[Global Ecosystem Dynamics Investigation]: https://gedi.umd.edu/
1919
[gedidb]: https://gedidb.readthedocs.io/en/latest/
2020
[Open Data Portal]: https://climate.esa.int/en/data/#/dashboard
21+
[Planetary Computer STAC API]: https://planetarycomputer.microsoft.com/dataset
2122
[SpatioTemporal Asset Catalogs]: https://stacspec.org/en/
2223
[Sentinel Hub]: https://www.sentinel-hub.com/
2324
[Zenodo]: https://zenodo.org/
@@ -606,22 +607,21 @@ Common parameters for opening [xarray.Dataset] instances:
606607
catalogue query.
607608
* `max_cache_size: int` - Maximum chunk cache size in bytes.
608609

609-
### SpatioTemporal Asset Catalogs `stac`, `stac-xcube`, `stac-cdse`
610+
### SpatioTemporal Asset Catalogs
610611

611-
The data stores `stac`, `stac-xcube`, and `stac-cdse` provide access to datasets of
612-
the [SpatioTemporal Asset Catalogs].
612+
Several data stores provide access to datasets from different
613+
[SpatioTemporal Asset Catalogs].
613614

614-
The three data stores are provided by the xcube plugin [xcube-stac].
615-
You can install it using `conda install -c conda-forge xcube-stac.`
615+
These stores are provided by the xcube plugin [xcube-stac]. You can install it using `conda install -c conda-forge xcube-stac.`
616616

617617

618618
#### `stac`
619-
The data store `stac` provides datasets from a user-defined STAC API.
619+
The `stac` data store retrieves datasets from a user-defined STAC API. It provides
620+
access to items within a STAC catalog and exposes the data sources referenced by each
621+
STAC item as an `xr.Dataset`.
620622

621623
Specific parameters for this store are:
622624
* `url: str` - URL to STAC catalog. Required.
623-
* `stack_mode: bool` - Stacking of STAC items. Transforms data into analysis-ready
624-
format. Defaults to `False`.
625625
* `**store_params`: Store parameters to configure the store used to access the data,
626626
which are the same as those used for `https` and `s3` stores. The hrefs in the
627627
STAC assets determines whether data is accessed via `https` or `s3`.
@@ -631,42 +631,60 @@ The data store `stac-xcube` connects to STAC catalogs published on a xcube [Serv
631631

632632
Specific parameters for this store are:
633633
* `url: str` - URL to STAC catalog. Required.
634-
* `stack_mode: bool` - Stacking of STAC items. Transforms data into analysis-ready
635-
format. Defaults to `False`.
636634
* `**store_params`: Store parameters to configure the `s3` store used to access
637635
the data.
638636

639-
#### `stac-cdse`
640-
The data store `stac-cdse` provides direct access datasets published by the
641-
[CDSE STAC API].
637+
#### `stac-cdse` and `stac-cdse-ardc`
642638

643-
* `stack_mode: bool` - Stacking of STAC items. Transforms data into analysis-ready
644-
format. Defaults to `False`. Available for `data_id="sentinel-2-l2"`, which allows to
645-
build 3D spatiotemporal data cubes from multiple Sentinel-2 Level-2A tiles.
646-
Commen opening parameter:
647-
648-
* `float, float, float, float)` - Bounding box ["west", "south", "est", "north"]
649-
in CRS coordinates.
650-
* `time_range: [str, str]`: Temporal extent ["YYYY-MM-DD", "YYYY-MM-DD"].
651-
* `spatial_res: int | float` - Spatial resolution in meter of degree (depending on the CRS).
652-
* `crs: str` - Coordinate reference system (e.g. `"EPSG:4326"`).
639+
The `stac-cdse` and `stac-cdse-ardc` data stores provide direct access to datasets
640+
published by the [CDSE STAC API].
653641

642+
To [access EO data via S3 from CDSE](https://documentation.dataspace.copernicus.eu/APIs/S3.html),
643+
you must [generate S3 credentials](https://documentation.dataspace.copernicus.eu/APIs/S3.html#generate-secrets).
644+
These credentials are required during store initialization:
654645
* `key: str`- S3 key credential for CDSE data access
655-
* `secret: str`- S3 secret credential for CDSE data access. In order to access [EO data via S3 from CDSE](https://documentation.dataspace.copernicus.eu/APIs/S3.html)
656-
one needs to [generate S3 credentials](https://documentation.dataspace.copernicus.eu/APIs/S3.html#generate-secrets).
646+
* `secret: str`- S3 secret credential for CDSE data access.
657647

648+
Differences between the two stores:
649+
* `stac-cdse`: Generates a unified dataset from a single CDSE STAC item
650+
(observational tile) with tailored data processing. Only items from the
651+
collections listed below are supported.
652+
* `stac-cdse-ardc`: Generates **3D spatiotemporal analysis-ready data cubes
653+
(ARDCs)** from multiple STAC items for the supported CDSE collections listed below.
658654

659-
There are no common parameters for opening datasets with the three stores.
660-
As the available datasets are varying across a wide spectrum of datatypes
661-
no specific opening parameters can be named here. The stores delegate to the
662-
general xcube DataOpener which offers a variety of parameters depending on the
663-
datatype of the dataset.
664655

665-
Use the following function to access the parameters fitting for the dataset of interest:
656+
Supported CDSE STAC collections:
657+
* [`sentinel-2-l1c`](https://browser.stac.dataspace.copernicus.eu/collections/sentinel-2-l1c)
658+
* [`sentinel-2-l2a`](https://browser.stac.dataspace.copernicus.eu/collections/sentinel-2-l2a)
659+
* [`sentinel-3-syn-2-syn-ntc`](https://browser.stac.dataspace.copernicus.eu/collections/sentinel-3-syn-2-syn-ntc)
666660

667-
```python
668-
open_schema = store.get_open_data_params_schema("data_id")
669-
```
661+
662+
#### `stac-pc` and `stac-pc-ardc`
663+
664+
The `stac-pc` and `stac-pc-ardc` stores function similarly to `stac-cdse` and
665+
`stac-cdse-ardc`, but provide direct access to datasets published by the
666+
[Planetary Computer STAC API].
667+
668+
No parameters are required for initialization.
669+
670+
Currently supported collections:
671+
672+
* [`sentinel-2-l2a`](https://planetarycomputer.microsoft.com/dataset/sentinel-2-l2a)
673+
674+
675+
> **Note**
676+
>
677+
> There are no common parameters for opening datasets with the stac data stores.
678+
> As the available datasets are varying across a wide spectrum of datatypes
679+
> no specific opening parameters can be named here. The stores delegate to the
680+
> general xcube DataOpener which offers a variety of parameters depending on the
681+
> datatype of the dataset.
682+
>
683+
> Use the following function to access the parameters fitting for the dataset of interest:
684+
>
685+
> ```python
686+
> open_schema = store.get_open_data_params_schema("data_id")
687+
> ```
670688
671689
### Zenodo `zenodo`
672690

0 commit comments

Comments
 (0)