Skip to content

API reference

These pages document Altar's public Python modules. They are generated from the modules' signatures and docstrings when the site is built. Import from these modules, not from altar.plugins.* or other implementation paths.

Module Purpose Maturity
altar.models model bindings, requests, plans and layouts Stable
altar.run the altar run driver: run specs, validation and run summaries Stable
altar.scoring batch preparation and scoring Stable
altar.interpretation interpretation operations and their store Provisional
altar.execution tasks, execution backends, storage and task state Stable
altar.results score, detail and artifact stores, and result assembly Stable
altar.sources annotation sources and variant–gene link sources Stable
altar.predicates portable three-valued expressions Stable
altar.registry the generic plugin registry Stable
altar.variants canonical variant ingestion and validation Stable
altar_identity variant keys, the container variant file and SHA-256 file identity Stable
altar.access authentication providers and the environment secret resolver Provisional
altar.connections named connections to object storage and warehouses Provisional
altar.registries registries of models and reference genomes, and the cache a fetch fills Provisional
altar.testing conformance suites and test doubles for extensions Stable

A module marked Stable can still export some provisional names. Provisional names lists them. Maturity labels also says what each label means and which namespaces are private. The package root, altar, exports only __version__.