|
16 | 16 | [ESA Climate Data Centre]: https://climate.esa.int/en/odp/ |
17 | 17 | [ESA Soil Moisture and Ocean Salinity]: https://earth.esa.int/eogateway/missions/smos |
18 | 18 | [Global Ecosystem Dynamics Investigation]: https://gedi.umd.edu/ |
| 19 | +[gedidb]: https://gedidb.readthedocs.io/en/latest/ |
19 | 20 | [Open Data Portal]: https://climate.esa.int/en/data/#/dashboard |
20 | 21 | [SpatioTemporal Asset Catalogs]: https://stacspec.org/en/ |
21 | 22 | [Sentinel Hub]: https://www.sentinel-hub.com/ |
@@ -520,11 +521,39 @@ Common parameters for opening [xarray.Dataset] instances: |
520 | 521 |
|
521 | 522 | ### Global Ecosystem Dynamics Investigation `gedidb` |
522 | 523 |
|
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). |
525 | 527 |
|
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. |
528 | 557 |
|
529 | 558 | ### Sentinel Hub API |
530 | 559 |
|
@@ -678,7 +707,6 @@ Use the following function to access the parameters fitting for the dataset of i |
678 | 707 | open_schema = store.get_open_data_params_schema("data_id") |
679 | 708 | ``` |
680 | 709 |
|
681 | | - |
682 | 710 | ## Developing new data stores |
683 | 711 |
|
684 | 712 | ### Implementing the data store |
|
0 commit comments