# How do I ...
## access data
| How do I ... | Use API | Comments |
|----------------------------------------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| get a data store instance | [new_data_store(store_id, **data_store_params)](api.html#xcube.core.store.new_data_store) | Supported `store_id` can be found in the section [Available data store](dataaccess.html#available-data-stores);
`data_store_params` can be extracted for a specific `store_id`, shown in the next row. |
| get the data store parameters | [get_data_store_params_schema(store_id)](api.html#xcube.core.store.DataStore.get_data_store_params_schema) | |
| list available data stores | [list_data_store_ids()](api.html#xcube.core.store.list_data_store_ids) | This function lists all data stores available in the environment;
note that xcube data store plugins will be automatically recognized when installed. |
| get a data store for local filesystem | [new_data_store("file", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#filesystem-based-data-stores); example notebook [1_getting_started.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/1_getting_started.ipynb) |
| get a data store for S3 filesystem | [new_data_store("s3", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#filesystem-based-data-stores); example notebook [1_getting_started.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/1_getting_started.ipynb) |
| list the datasets in a data store | [store.list_data_ids()](api.html#xcube.core.store.DataStore.list_data_ids) | |
| open a dataset from a data store | [store.open_data(data_id, **open_params)](api.html#xcube.core.store.DataStore.open_data) | `open_params` can be extracted from the store, shown in the next row. |
| get the parameters for
opening a dataset | [store.get_open_data_params_schema()](api.html#xcube.core.store.DataStore.get_open_data_params_schema) | |
## get a data store xcube plug-in
| How do I ... | Use API | Comments |
|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| get a data store for Sentinel Hub | [new_data_store("sentinelhub", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#sentinel-hub-api); example notebook [2_sentinel_hub.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/2_sentinel_hub.ipynb) |
| get a data store for ESA Climate Data Centre | [new_data_store("cciodp", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#esa-climate-data-centre-cciodp); example notebook [3_esa_climate_change_initiative.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/3_esa_climate_change_initiative.ipynb) |
| get a data store for ESA Climate Data Centre (Zarr format) | [new_data_store("ccizarr", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#esa-climate-data-centre-ccizarr); example notebook [3_esa_climate_change_initiative.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/3_esa_climate_change_initiative.ipynb) |
| get a data store for ESA SMOS | [new_data_store("smos", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#esa-smos); example notebook [demo-store.ipynb](https://github.com/xcube-dev/xcube-smos/blob/main/notebooks/demo-store.ipynb) |
| get a data store for Copernicus Climate Data Store | [new_data_store("cds", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#copernicus-climate-data-store-cds); example notebook [4_c3s_climate_data_store.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/4_c3s_climate_data_store.ipynb) |
| get a data store for Copernicus Marine Service | [new_data_store("cmems", **data_store_params)](api.html#xcube.core.store.new_data_store) | [Further documentation](dataaccess.html#copernicus-marine-service-cmems); example notebook [7_cmems_data_store.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/datastores/7_cmems_data_store.ipynb) |
| get a data store for data organized by
a SpatioTemporal Asset Catalog (STAC) (**under development**) | [new_data_store("stac", **data_store_params)](api.html#xcube.core.store.new_data_store) | |
## process data
| How do I ... | Use API | Comments |
|-------------------------------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| spatially resample a datacube | [resample_in_space(ds, ref_ds=ref_ds, ...)](api.html#xcube.core.resampling.resample_in_space) | Example notebook [resample_in_space.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/resampling/resample_in_space.ipynb) |
| temporarily resample a datacube | [resample_in_time(ds, frequency, method, ...)](api.html#xcube.core.resampling.resample_in_time) | Example notebook [nns_chl_analysis.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/sns_chl_analysis/nns_chl_analysis.ipynb) |
| rectify a dataset in satellite projection | [rectify_dataset(ds, ref_ds=ref_ds, ...)](api.html#xcube.core.resampling.rectify_dataset) | Example notebook [rectify_dataset.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/resampling/rectify_dataset.ipynb) |
| spatially subset a dataset for a given geometry | [clip_dataset_by_geometry(ds, geometry, ...)](api.html#xcube.core.geom.clip_dataset_by_geometry) | Example notebook [make_subset_cube.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/general/make_subset_cube.ipynb) |
| spatially mask a dataset for a given geometry | [mask_dataset_by_geometry(ds, geometry, ...)](api.html#xcube.core.geom.mask_dataset_by_geometry) | Example notebook [rasterize_features.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/general/rasterize_features.ipynb) |
## publish and visualize xcube datasets
| How do I ... | Use CLI/API | Comments |
|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| run the xcube server from the CLI | [xcube serve --verbose -c config.yml](examples/xcube_serve.html#running-the-server) | An example can be found in the [xcube github](https://github.com/xcube-dev/xcube/blob/main/examples/serve/demo/README.md);
a detailed documentation on `xcube serve` can be found [here](cli/xcube_serve.html) and [here](webapi.html#web-api-and-server). |
| open the xcube viewer web-application | [xcube serve --open-viewer](examples/xcube_serve.html#id1) | Detailed documentation on xcube Viewer can be found [here](viewer.html). |
| start the xcube viewer via Python API
in Jupyter Notebooks | [viewer = Viewer()](api.html#xcube.webapi.viewer.Viewer)
[viewer.add_dataset(ds)](api.html#xcube.webapi.viewer.Viewer.add_dataset)
[viewer.show()](api.html#xcube.webapi.viewer.Viewer.show) | An example can be found in the notebook [xcube-viewer-in-jl.ipynb](https://github.com/xcube-dev/xcube/blob/main/examples/notebooks/viewer/xcube-viewer-in-jl.ipynb);
detailed documentation on xcube Viewer can be found [here](viewer.html). |