hats.loaders.read_hats

Attributes

DATASET_TYPE_TO_CLASS

Functions

read_hats(...)

Reads a HATS Catalog from a HATS directory

Module Contents

DATASET_TYPE_TO_CLASS

read_hats(catalog_path: str | pathlib.Path | upath.UPath, *, single_catalog: bool | None = None, read_moc: bool = True) → hats.catalog.catalog_collection.CatalogCollection | hats.catalog.Dataset

Reads a HATS Catalog from a HATS directory

Parameters:

catalog_pathstr | Path | UPath

path to the root directory of the catalog

single_catalog: bool

If you happen to already know that the catalog_path points to a single catalog, instead of a catalog collection, this flag can save a few file read operations.

read_moc: bool

If you happen to know that your catalog does not have a MOC (or if you know that your use case will not utilize a MOC), then you can skip the file read and memory load of the MOC.

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))