Ctrl+K

hipscat.catalog.dataset.dataset

hipscat.catalog.dataset.dataset#

Module Contents#

Classes#

Dataset

A base HiPSCat dataset that contains a catalog_info metadata file
class Dataset(catalog_info: CatalogInfoClass, catalog_path=None, storage_options: Dict[Any, Any] | None = None)[source]#

A base HiPSCat dataset that contains a catalog_info metadata file and the data contained in parquet files

CatalogInfoClass[source]#
classmethod read_from_hipscat(catalog_path: str, storage_options: Dict[Any, Any] | None = None) → typing_extensions.Self[source]#

Reads a HiPSCat Catalog from a HiPSCat directory

Parameters:

  • catalog_path – path to the root directory of the catalog

  • storage_options – dictionary that contains abstract filesystem credentials

Returns:

The initialized catalog object

classmethod _read_args(catalog_base_dir: hipscat.io.FilePointer, storage_options: Dict[Any, Any] | None = None) → Tuple[CatalogInfoClass][source]#
classmethod _read_kwargs(catalog_base_dir: hipscat.io.FilePointer, storage_options: Dict[Any, Any] | None = None) → dict[source]#
classmethod _check_files_exist(catalog_base_dir: hipscat.io.FilePointer, storage_options: Dict[Any, Any] | None = None)[source]#
Contents