Cryosphere Community Datapool Tools (ccdtools) API Reference

DataCatalog

ccdtools is developed around a central DataCatalog class.

catalog.DataCatalog([yaml_path])

A catalog for managing and loading datasets with versioning and subdataset support.

Data discovery

There are various methods to explore the DataCatalog:

catalog.DataCatalog.available_resolutions(dataset)	Show available resolutions for a given dataset/version/subdataset.
catalog.DataCatalog.available_subdatasets(dataset)	Show available subdatasets for a given dataset and version.
catalog.DataCatalog.available_versions(dataset)	Show available versions for a given dataset.
catalog.DataCatalog.help([dataset, version])	Describe available datasets and their supported options without loading data.
catalog.DataCatalog.search(keyword)	Search datasets by keyword in dataset name, display name, or tags.

Loading data

Datasets are loaded using the load_dataset method.

catalog.DataCatalog.load_dataset(dataset[, ...])

Load any dataset by name/version/subdataset with optional directory filtering.

Under-the-hood, datasets are loaded using custom loaders.

loaders

Default and custom loader functions for datasets contained within the catalog