Skip to content

Schema

The schema module creates Zarr output templates from pipeline configuration. Column definitions, types, and fill values are read from the YAML config's aggregation section.

Zarr Template

zagg.schema.xdggs_spec 

xdggs_spec(
    parent_order: int, child_order: int, config: PipelineConfig | None = None
) -> GroupSpec

Return the full-sphere HEALPix GroupSpec (back-compat wrapper).

zagg.schema.xdggs_zarr_template 

xdggs_zarr_template(
    store: Store,
    parent_order: int,
    child_order: int,
    n_parent_cells: int | None = None,
    overwrite: bool = False,
    config: PipelineConfig | None = None,
) -> Store

Write a HEALPix Zarr template to store.

Layout is selected by n_parent_cells: when None the store gets a full-sphere array of shape (12 · 4^child_order,); when set the store gets a dense-pack array of shape (4^Δ · n_parent_cells,).

Parameters:

  • store (Store) –

    Zarr-compatible store.

  • parent_order (int) –

    Parent (shard) HEALPix order.

  • child_order (int) –

    Leaf HEALPix order. Must be >= parent_order.

  • n_parent_cells (int, default: None ) –

    Number of populated shards. Selects dense layout when provided.

  • overwrite (bool, default: False ) –

    Overwrite an existing array or group at the path.

  • config (PipelineConfig, default: None ) –

    Pipeline configuration. Falls back to default_config("atl06").

Types

zagg.schema.ProcessingMetadata

Bases: TypedDict

Constants

zagg.schema.HEALPIX_BASE_CELLS module-attribute 

HEALPIX_BASE_CELLS: int = 12