Data catalog#

General#

DataCatalog([data_libs, fallback_lib, ...])

Base class for the data catalog object.

DataCatalog.get_source(source[, provider, ...])

Return a data source.

DataCatalog.sources

Returns dictionary of DataSources.

DataCatalog.predefined_catalogs

Return all predefined catalogs.

DataCatalog.to_dict([source_names, root, ...])

Export the data catalog to a dictionary.

DataCatalog.to_yml(path[, root, ...])

Write data catalog to yaml format.

DataCatalog.export_data(new_root[, bbox, ...])

Export a data slice of each dataset and a data_catalog.yml file to disk.

DataCatalog.get_source_bbox(source[, ...])

Retrieve the bounding box and crs of the source.

DataCatalog.get_source_time_range(source[, ...])

Detect the temporal range of the dataset.

Add data sources#

DataCatalog.add_source(name, source)

Add a new data source to the data catalog.

DataCatalog.update(**kwargs)

Add data sources to library or update them.

DataCatalog.from_predefined_catalogs(name[, ...])

Add data sources from a predefined data catalog.

DataCatalog.from_yml(urlpath[, root, ...])

Add data sources based on yaml file.

DataCatalog.from_dict(data_dict[, ...])

Add data sources based on dictionary.

Get data#

DataCatalog.get_rasterdataset(data_like[, ...])

Return a clipped, sliced and unified RasterDataset.

DataCatalog.get_geodataset(data_like[, ...])

Return a clipped, sliced and unified GeoDataset.

DataCatalog.get_geodataframe(data_like[, ...])

Return a clipped and unified GeoDataFrame (vector).

DataCatalog.get_dataframe(data_like[, ...])

Return a clipped, sliced and unified DataFrame.

DataCatalog.get_dataset(data_like[, ...])

Return a clipped, sliced and unified Dataset.

Predefined data catalog#

PredefinedCatalog([format_version, cache_dir])

Predefined data catalog.

PredefinedCatalog.get_catalog_file([version])

Get the cached catalog file path for a specific version.

predefined_catalog.create_registry_file(root)

Create a registry file for all catalog files in the root directory.