API reference#

All the objects below are importable from the top-level healpix_convert package.

Conversion#

create_healpix_dataset() runs the whole conversion in one call. The other functions run it in separate stages, e.g., to convert the data in parallel jobs (see Quickstart).

Note

create_healpix_dataset() is meant for quick conversions of small inputs and for test cases. For production conversions of large datasets, prefer the staged functions below and run them with a workflow orchestration tool (Prefect, Airflow, Argo Workflows, etc.), which handles resource management, task failures and retries. The multi-stage API is designed for defining the tasks of such a workflow.

healpix_convert.create_healpix_dataset(...)

Create a new Zarr dataset with data resampled on the HEALPix grid.

healpix_convert.create_staging_cache(...[, ...])

Create a temporary (staging) conversion data cache by parsing input dataset(s) and conversion settings.

healpix_convert.prepare_healpix_dataset(...)

Create a new Zarr dataset without any data resampled on the HEALPix grid (yet).

healpix_convert.convert_group_to_healpix(...)

Convert data in one group to HEALPix and write the output resampled data to the output zarr dataset.

healpix_convert.generate_pyramids(cache, ...)

Aggregate the converted data onto the coarser HEALPix refinement levels of the pyramids.

healpix_convert.finalize_healpix_dataset(...)

Finalize the converted output dataset.

generate_pyramids() is run after the data has been converted; it does nothing if no group has pyramid settings (see HEALPix pyramids).

finalize_healpix_dataset() is the last stage, run once every group of the output dataset has been written: it consolidates the Zarr metadata of the output dataset (see Output metadata).

Settings#

healpix_convert.ConvertSettings(*[, ...])

General settings for converting input Zarr dataset(s) onto HEALPix.

healpix_convert.PyramidSettings(*, ...[, ...])

Settings for generating a pyramid of coarser HEALPix refinement levels in a multiscale group.

healpix_convert.get_settings(name)

Get default conversion settings.

Staging cache#

healpix_convert.ConvertStagingCache(*[, ...])

Stores temporary data and objects reused during the conversion.