ccdtools.catalog.DataCatalog.help

DataCatalog.help(dataset=None, version=None)

Describe available datasets and their supported options without loading data.

This method provides information about available datasets, versions, subdatasets, and supported loading options. When called without arguments, it lists all available datasets. When a dataset is specified, it lists available versions. When both dataset and version are specified, it provides detailed information about the dataset/version combination including available subdatasets and supported keywords.

Parameters:

  • dataset (str, optional) – Name of the dataset to describe. If not provided, lists all available datasets. Default is None.

  • version (str, optional) – Version of the dataset to describe. If not provided, lists available versions for the specified dataset. Default is None.

Returns:

This method prints information to stdout about datasets, versions, subdatasets, and supported catalog keywords. No value is returned.

Return type:

None

Raises:

  • KeyError – If the specified dataset does not exist.

  • KeyError – If the specified version does not exist for the given dataset.

Examples

List all available datasets:

>>> catalog.help()

List versions for a specific dataset:

>>> catalog.help(dataset='dataset_name')

Show detailed information for a dataset version:

>>> catalog.help(dataset='dataset_name', version='v1')

Notes

The method provides hints for further exploration and example usage based on the available metadata for the dataset/version combination.