API reference#

sddb.Catalog

The dataset catalog: fetched, cached and validated on construction.

sddb.Dataset

One catalog row: a published dataset.

sddb.SpatialDataCohort

An ordered, sliceable set of Dataset records from a query/search.

sddb.TaskAdapter

What a task repo implements.

sddb.TableAdapter

Per-table counterpart of TaskAdapter, used by to_anndata().

sddb.Manifest

What was downloaded, where, and from which catalog.

sddb.CohortManifest

Serializable cohort identity: filter, member snapshot (pinned full uids) and a deterministic hash.

sddb.SplitManifest

Per-uid fold assignment, pinned to the parent cohort hash, by key, seed and ratios.

sddb.CohortDriftError

A pinned cohort member no longer resolves; drifted maps uid -> reason.

sddb.CatalogChangedError

The pinned catalog's bytes differ from the sha256 recorded when the cohort was frozen.

sddb.CatalogUnavailableError

The catalog a cohort was frozen from could not be fetched, so its recorded sha256 could not be verified.

sddb.ManifestVersionMismatch

The catalog version differs from the one recorded in an existing manifest.

sddb.open_sdata

Open a SpatialData zarr from a URL or local path, anonymously.

sddb.resolve

Resolve each role to exactly one element path.

sddb.table_centroids

Centroid of each table row in an image's scale-0 pixel space.

sddb.citations.citation_entries

Return (BibTeX text, n_published, n_fallback) that cite every study in results.