Skip to content

Commit cf13e9c

Browse files
committed
add information on gedidb to dataaccess.md
1 parent 9022b62 commit cf13e9c

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

docs/source/dataaccess.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
[ESA Climate Data Centre]: https://climate.esa.int/en/odp/
1717
[ESA Soil Moisture and Ocean Salinity]: https://earth.esa.int/eogateway/missions/smos
1818
[Global Ecosystem Dynamics Investigation]: https://gedi.umd.edu/
19+
[gedidb]: https://gedidb.readthedocs.io/en/latest/
1920
[Open Data Portal]: https://climate.esa.int/en/data/#/dashboard
2021
[SpatioTemporal Asset Catalogs]: https://stacspec.org/en/
2122
[Sentinel Hub]: https://www.sentinel-hub.com/
@@ -520,11 +521,39 @@ Common parameters for opening [xarray.Dataset] instances:
520521

521522
### Global Ecosystem Dynamics Investigation `gedidb`
522523

523-
A data store for [Global Ecosystem Dynamics Investigation] (GEDI) data is currently
524-
under development and will be released soon.
524+
The data store `gedidb` provides access to [Global Ecosystem Dynamics Investigation]
525+
(GEDI) data. The store is developed using the API from [gedidb] which is licensed under
526+
[European Union Public License 1.2](https://github.com/simonbesnard1/gedidb/blob/main/LICENSE).
525527

526-
This data store is provided by the xcube plugin [xcube-gedidb]. Once available, you will
527-
be able to install it using `conda install -c conda-forge xcube-gedidb`.
528+
This data store is provided by the xcube plugin [xcube-gedidb]. Due to the
529+
unavailability of `gedidb` as a conda package, `xcube-gedidb` is packaged via PyPi.
530+
To install it, please make sure you have an activated conda environment created from the
531+
[environment.yml](https://github.com/xcube-dev/xcube-gedidb/blob/main/environment.yml),
532+
and then do `pip install xcube-gedi`.
533+
534+
It has no dedicated data store parameters.
535+
536+
This data store can be requested to open the datasets in one of two ways:
537+
538+
- request all available data within a **bounding box** by specifying a `bbox` in
539+
the `open_data` method.
540+
- request all available data around a given **point** by specifying a `point` in
541+
the `open_data` method.
542+
543+
Parameters for opening [xarray.Dataset] instances:
544+
545+
Either
546+
* `bbox: (float, float, float, float)` - A bounding box in the form of
547+
`(xmin, ymin, xmax, ymax)`. Required.
548+
549+
Or
550+
* `point: (float, float)` - Reference point for nearest query. Required
551+
* `num_shots: int` - Number of shots to retrieve. Defaults to `10`.
552+
* `radius: float` - Radius in degrees around the point Defaults to`0.1`.
553+
554+
Common:
555+
* `time_range: (str, str)` - Time range. Required.
556+
* `variables: list[str]` - List of variables to retrieve from the database.
528557

529558
### Sentinel Hub API
530559

@@ -678,7 +707,6 @@ Use the following function to access the parameters fitting for the dataset of i
678707
open_schema = store.get_open_data_params_schema("data_id")
679708
```
680709

681-
682710
## Developing new data stores
683711

684712
### Implementing the data store

0 commit comments

Comments
 (0)