From 66c18b00a676e2222b16c79a781617ba2da174a1 Mon Sep 17 00:00:00 2001 From: clarasb Date: Wed, 11 Feb 2026 15:05:46 +0100 Subject: [PATCH 1/2] adjust formatting --- docs/source/cli/xcube_serve.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/source/cli/xcube_serve.rst b/docs/source/cli/xcube_serve.rst index a83edfbf1..f97fe63eb 100644 --- a/docs/source/cli/xcube_serve.rst +++ b/docs/source/cli/xcube_serve.rst @@ -236,7 +236,9 @@ respect to ``base_dir`` and to normalize it. For example Viewer Configuration [optional] ------------------------------- -### Viewer Branding +Viewer Branding +~~~~~~~~~~~~~~~ + The xcube server endpoint ``/viewer/config/{*path}`` allows for configuring the viewer accessible via endpoint ``/viewer``. @@ -255,15 +257,16 @@ must be an absolute filesystem path or a S3 path as in the example above. It points to a directory that is expected to contain the the viewer configuration file `config.json` among other configuration resources, such as custom ``favicon.ico`` or ``logo.png``. The file ``config.json`` should conform to the -[configuration JSON Schema](https://github.com/dcs4cop/xcube-viewer/blob/main/src/resources/config.schema.json). +`configuration JSON Schema `_. All its values are optional, if not provided, -[default values](https://github.com/dcs4cop/xcube-viewer/blob/main/src/resources/config.json) +`default values `_ are used instead. .. _datasets: -### Viewer State Persistence +Viewer State Persistence +~~~~~~~~~~~~~~~~~~~~~~~~ The xcube server endpoint ``/viewer/state`` allows for persisting viewer state if configured via the ``Viewer/Persistence`` setting. It requires a ``Path`` From ba402358eb6c3e952e610b7037be99653903fbca Mon Sep 17 00:00:00 2001 From: clarasb Date: Wed, 11 Feb 2026 15:42:47 +0100 Subject: [PATCH 2/2] add xcube-icosdp --- docs/source/dataaccess.md | 43 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/source/dataaccess.md b/docs/source/dataaccess.md index 366dd6532..661a94430 100644 --- a/docs/source/dataaccess.md +++ b/docs/source/dataaccess.md @@ -17,6 +17,7 @@ [ESA Soil Moisture and Ocean Salinity]: https://earth.esa.int/eogateway/missions/smos [Global Ecosystem Dynamics Investigation]: https://gedi.umd.edu/ [gedidb]: https://gedidb.readthedocs.io/en/latest/ +[ICOS Data Portal]: https://data.icos-cp.eu/portal/ [Open Data Portal]: https://climate.esa.int/en/data/#/dashboard [Planetary Computer STAC API]: https://planetarycomputer.microsoft.com/dataset [SpatioTemporal Asset Catalogs]: https://stacspec.org/en/ @@ -28,6 +29,7 @@ [xcube-clms]: https://github.com/xcube-dev/xcube-clms [xcube-cmems]: https://github.com/dcs4cop/xcube-cmems [xcube-gedidb]: https://github.com/xcube-dev/xcube-gedidb +[xcube-icosdp]: https://github.com/xcube-dev/xcube-icosdp [xcube-sh]: https://github.com/dcs4cop/xcube-sh [xcube-smos]: https://github.com/dcs4cop/xcube-smos [xcube-stac]: https://github.com/xcube-dev/xcube-stac @@ -556,6 +558,47 @@ Common: * `time_range: (str, str)` - Time range. Required. * `variables: list[str]` - List of variables to retrieve from the database. +### ICOS Data Portal `icosdp` + +The data store `icosdp` provides datasets of the [ICOS Data Portal]. + +This data store is provided by the xcube plugin [xcube-icosdp]. +You can install it using `pip install xcube-icosdp`. + +The plugin currently supports the **FLUXCOM-X-BASE** products for carbon and water fluxes. +To improve usability, the data is available through: + +* Native resolution via cloud-optimized access (spatial/temporal subsetting) via `open_data` +* Pre-computed spatial & temporal aggregations via `preload_data` + +Data store parameters: + +* `email: str` - E-mail used when signing in at https://cpauth.icos-cp.eu/login/. + This is only needed if the aggregated datasets want to be accessed via `preload_data`. +* `password: str` - Password used when signing in at https://cpauth.icos-cp.eu/login/. + This is only needed if the aggregated datasets want to be accessed via `preload_data`. +* `cache_store_id: str` - The cache data store is a filesystem-based data store + implemented in xcube, which is used to store the preloaded data. +* `cache_store_params: dict` - The available parameters can be viewed using + `get_data_store_params_schema(cache_store_id)`. + +Common parameters for opening [xarray.Dataset] instances: + +* `flatten_time: bool` - If enabled, combines the 'time' and 'hour' dimensions into a + single datetime axis. + +Common parameters for preloading [xarray.Dataset] instances: + +* `agg_mode: str` - Four aggregation modes are published in the + [ICOS FLUXCOM-X-BASE collection](https://meta.icos-cp.eu/collections/vvQKmP2OJRY-B-vIl-YXIHFs"). + One of `"050_monthly"`, `"025_monthlycycle"`, `"025_daily"`, `"005_monthly"`. +* `flatten_time: bool` - If enabled, combines the 'time' and 'hour' dimensions into a + single datetime axis. This option is available only when `agg_mode='025_monthlycycle'`. +* `target_format: str` - Format of the preloaded dataset in the cache. + One of `"zarr"` or `"netcdf"`. +* `chunks: tuple[int]` - Chunk sizes for each dimension of the preloaded datasets; + an iterable with length same as number of dimensions. + ### Sentinel Hub API The data store `sentinelhub` provides the datasets of the