Skip to content

Commit 9022b62

Browse files
committed
apply suggestions
1 parent c6affe9 commit 9022b62

File tree

2 files changed

+49
-17
lines changed

2 files changed

+49
-17
lines changed

CHANGES.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
### Other change
44

5-
* Update `Access Data` page in documentation.
5+
* Added the following data stores to `Access Data` page in documentation:
6+
`https`, `ftp`, `reference`, `smos`, `stac`, `stac-cdse`, `stac-xcube`, `gedidb`,
7+
`eopf-zarr`, `esa-cci-kc`.
8+
69

710
## Changes in 1.11.0
811

docs/source/dataaccess.md

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@
88
[JSON Object Schema]: https://json-schema.org/understanding-json-schema/reference/object.html
99
[setuptools entry point]: https://setuptools.pypa.io/en/latest/userguide/entry_point.html
1010

11-
[ESA Climate Data Centre]: https://climate.esa.int/en/odp/
12-
[Sentinel Hub]: https://www.sentinel-hub.com/
11+
[CDSE STAC API]: https://browser.stac.dataspace.copernicus.eu
1312
[Copernicus Marine Service]: https://marine.copernicus.eu/
1413
[Copernicus Climate Data Store]: https://cds.climate.copernicus.eu/
15-
[ESA Soil Moisture and Ocean Salinity]: https://earth.esa.int/eogateway/missions/smos
16-
[Zenodo]: https://zenodo.org/
17-
[SpatioTemporal Asset Catalogs]: https://stacspec.org/en/
1814
[Copernicus Land Monitoring Service]: https://land.copernicus.eu/en
15+
[EOPF Sentinel Zarr Samples]: https://zarr.eopf.copernicus.eu/
16+
[ESA Climate Data Centre]: https://climate.esa.int/en/odp/
17+
[ESA Soil Moisture and Ocean Salinity]: https://earth.esa.int/eogateway/missions/smos
1918
[Global Ecosystem Dynamics Investigation]: https://gedi.umd.edu/
2019
[Open Data Portal]: https://climate.esa.int/en/data/#/dashboard
20+
[SpatioTemporal Asset Catalogs]: https://stacspec.org/en/
21+
[Sentinel Hub]: https://www.sentinel-hub.com/
22+
[Zenodo]: https://zenodo.org/
2123

2224
[xcube-cci]: https://github.com/dcs4cop/xcube-cci
2325
[xcube-cds]: https://github.com/dcs4cop/xcube-cds
@@ -38,6 +40,7 @@
3840
[DatasetDescriptor]: https://xcube.readthedocs.io/en/latest/api.html#xcube.core.store.DatasetDescriptor
3941
[GenericZarrStore]: https://xcube.readthedocs.io/en/latest/api.html#xcube.core.zarrstore.GenericZarrStore
4042
[MultiLevelDataset]: https://xcube.readthedocs.io/en/latest/api.html#xcube.core.mldataset.MultiLevelDataset
43+
[Server]: https://xcube.readthedocs.io/en/latest/cli/xcube_serve.html
4144

4245
# Data Access
4346

@@ -413,12 +416,30 @@ The preload parameters are:
413416
Its common dataset open parameters for opening [xarray.Dataset] instances are the same
414417
as for the filesystem-based data stores described above.
415418

416-
### EOPF Sample Service
419+
### EOPF Sample Service `eopf-zarr`
420+
421+
The data store `eopf-zarr` provides access to the [EOPF Sentinel Zarr Samples] as an
422+
analysis-ready datacube (ARDC).
423+
424+
This data store is provided by the xcube plugin `xcube-eopf`.
425+
You can install it using `conda install -c conda-forge xcube-eopf`.
417426

418-
A data store for [EOPF Sentinel Zarr Samples](https://zarr.eopf.copernicus.eu/) is currently under development and will be released
419-
soon.
427+
No data store parameters needed.
428+
429+
Common parameters for opening [xarray.Dataset] instances:
420430

421-
### ESA Climate Data Centre `cciodp`, `ccizarr`, `esa-cci-kc`
431+
* `bbox: ?[float|int, float|int, float|int, float|int]?`- Bounding box
432+
["west", "south", "est", "north"] in CRS coordinates.
433+
* `time_range: [str, str]` - Temporal extent ["YYYY-MM-DD", "YYYY-MM-DD"].
434+
* `spatial_res: int|float` - Spatial resolution in meter of degree (depending on the CRS).
435+
* `crs: str` - Coordinate reference system (e.g. `"EPSG:4326"`).
436+
* `variables: ?str | list[str]?` - Variables to include in the dataset. Can be a name
437+
or regex pattern or iterable of the latter.
438+
* `query: Any (not specified)` - Additional query options for filtering STAC Items by
439+
properties. See [STAC Query Extension](https://github.com/stac-api-extensions/query)
440+
for details.
441+
442+
### ESA Climate Data Centre (ESA CCI) `cciodp`, `ccizarr`, `esa-cci-kc`
422443

423444
Three data stores are provided by the xcube plugin [xcube-cci].
424445
You can install the plugin using `conda install -c conda-forge xcube-cci`.
@@ -577,7 +598,7 @@ Specific parameters for this store are:
577598
STAC assets determines whether data is accessed via `https` or `s3`.
578599

579600
#### `stac-xcube`
580-
The data store `stac-xcube` connects to STAC catalogs published on a `xcube` Server.
601+
The data store `stac-xcube` connects to STAC catalogs published on a xcube [Server].
581602

582603
Specific parameters for this store are:
583604
* `url: str` - URL to STAC catalog. Required.
@@ -588,20 +609,28 @@ Specific parameters for this store are:
588609

589610
#### `stac-cdse`
590611
The data store `stac-cdse` provides direct access datasets published by the
591-
CSDE STAC API.
612+
[CDSE STAC API].
592613

593614
* `stack_mode: bool` - Stacking of STAC items. Transforms data into analysis-ready
594-
format. Defaults to `False`.
615+
format. Defaults to `False`. Available for `data_id="sentinel-2-l2"`, which allows to
616+
build 3D spatiotemporal data cubes from multiple Sentinel-2 Level-2A tiles.
617+
Commen opening parameter:
618+
619+
* `float, float, float, float)` - Bounding box ["west", "south", "est", "north"]
620+
in CRS coordinates.
621+
* `time_range: [str, str]`: Temporal extent ["YYYY-MM-DD", "YYYY-MM-DD"].
622+
* `spatial_res: int | float` - Spatial resolution in meter of degree (depending on the CRS).
623+
* `crs: str` - Coordinate reference system (e.g. `"EPSG:4326"`).
624+
595625
* `key: str`- S3 key credential for CDSE data access
596-
* `secret: str`- S3 secret credential for CDSE data access
597-
In order to access [EO data via S3 from CDSE](https://documentation.dataspace.copernicus.eu/APIs/S3.html)
626+
* `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)
598627
one needs to [generate S3 credentials](https://documentation.dataspace.copernicus.eu/APIs/S3.html#generate-secrets).
599628

600629

601630
There are no common parameters for opening datasets with the three stores.
602631
As the available datasets are varying across a wide spectrum of datatypes
603632
no specific opening parameters can be named here. The stores delegate to the
604-
general xcube Data Opener which offers a variety of parameters depending on the
633+
general xcube DataOpener which offers a variety of parameters depending on the
605634
datatype of the dataset.
606635

607636
Use the following function to access the parameters fitting for the dataset of interest:
@@ -640,7 +669,7 @@ The preload parameters are:
640669
There are no common parameters for opening datasets with the `xcube-zenodo` store.
641670
As the datasets uploaded on Zenodo are varying across a wide spectrum of datatypes
642671
no specific opening parameters can be named here. `xcube-zenodo` delegates to the
643-
general xcube Data Opener which offers a variety of open parameters depending on the
672+
general xcube DataOpener which offers a variety of open parameters depending on the
644673
datatype of the dataset.
645674

646675
Use the following function to access the parameters fitting for the dataset of interest:

0 commit comments

Comments
 (0)