Ctrl+K

lsdb.io

lsdb.io#

Submodules#

Package Contents#

Functions#

to_hipscat(catalog, base_catalog_path[, catalog_name, ...])

Writes a catalog to disk, in HiPSCat format. The output catalog comprises
to_hipscat(catalog: lsdb.catalog.dataset.healpix_dataset.HealpixDataset, base_catalog_path: str, catalog_name: str | None = None, overwrite: bool = False, storage_options: dict | None = None, **kwargs)[source]#

Writes a catalog to disk, in HiPSCat format. The output catalog comprises partition parquet files and respective metadata, as well as JSON files detailing partition, catalog and provenance info.

Parameters:

  • catalog (HealpixDataset) – A catalog to export

  • base_catalog_path (str) – Location where catalog is saved to

  • catalog_name (str) – The name of the output catalog

  • overwrite (bool) – If True existing catalog is overwritten

  • storage_options (dict) – Dictionary that contains abstract filesystem credentials

  • **kwargs – Arguments to pass to the parquet write operations

Contents