hipscat.loaders#
Submodules#
Package Contents#
Functions#
- read_from_hipscat(catalog_path: str, catalog_type: hipscat.catalog.CatalogType | None = None, storage_options: dict | None = None) hipscat.catalog.Dataset#
Reads a HiPSCat Catalog from a HiPSCat directory
- Parameters:
catalog_path (str) – path to the root directory of the catalog
catalog_type (CatalogType) – Default None. By default, the type of the catalog is loaded from the catalog info and the corresponding object type is returned. Python’s type hints cannot allow a return type specified by a loaded value, so to use the correct return type for type checking, the type of the catalog can be specified here. Use by specifying the hipscat class for that catalog.
storage_options (dict) – dictionary that contains abstract filesystem credentials
- Returns:
The initialized catalog object