hats.loaders

hats.loaders#

Submodules#

Functions#

read_hats(...)

Reads a HATS Catalog from a HATS directory

Package Contents#

read_hats(catalog_path: str | pathlib.Path | upath.UPath) → hats.catalog.catalog_collection.CatalogCollection | hats.catalog.Dataset[source]#

Reads a HATS Catalog from a HATS directory

Parameters:
catalog_pathstr | Path | UPath

path to the root directory of the catalog

Returns:
CatalogCollection | Dataset

HATS catalog found at directory

Examples

To read a catalog from a public S3 bucket, call it as follows:

from upath import UPath
catalog = hats.read_hats(UPath(..., anon=True))
Contents