Skip to main content

Deterministic pharmacogenomics infrastructure: CPIC-pinned phenotype engine, gene callers, and recommendation lookup.

Project description

anukriti-pgx-core

Deterministic pharmacogenomics infrastructure

Authoritative, CPIC-pinned, no LLMs, no randomness. Same inputs → same outputs.

License: Apache 2.0 Python 3.11+ Status: Alpha


Platform and docs

This repo is the library at the core of the three-repo Anukriti platform (anukriti-pgx-core + anukriti + anukriti-swarm).

  • 🧭 PLATFORM.md — canonical three-repo map. Start here if you're new to the platform.
  • 📚 anukriti_docs — 14-module progressive learning course covering what the platform is, how it works, why deterministic, and the tech choices behind it.
  • 🧾 PROJECT_CONTEXT.md — the "why" doc for this library: D1–D11 locked founder decisions, forward-work items, regression contract.
  • 🏛️ docs/adr/ — platform-wide Architecture Decision Records with "Revisit when" triggers.

What this is

The deterministic core extracted from anukriti (PGx product) and anukriti-swarm (research platform), now shippable as a standalone library and (optionally) HTTP service.

Three stacked layers:

    VCF variants (rsid → ref,alt,gt)
            │
            ▼  Layer 1: calling/       ← VCFCaller.call(gene, variants)
    Star alleles (*1, *17, *2/*17 …)
            │
            ▼  Layer 2: phenotype/     ← PhenotypeEngine.infer(gene, a1, a2)  ← PHASE 1
    Phenotype (PM / IM / NM / RM / UM)
            │
            ▼  Layer 3: recommendations/  ← RecommendationLookup.lookup(...)
    CPIC recommendation

Each layer is independently usable. A consumer that already has star alleles (e.g. a swarm agent) uses Layer 2 directly. A consumer with VCF input (e.g. a clinical pipeline) uses Layer 1, which calls into Layer 2 internally.

Why this exists

Before the extraction, the same phenotype logic lived in two places:

  • anukriti-swarm/rules/phenotype_rules.py — star-allele level, 3 genes
  • anukriti/src/*_caller.py (16 files) — VCF level, 16 genes, inconsistent signatures

That meant two truth sources for the same CPIC tables, and no way for a third party to consume just the deterministic core without pulling in a FastAPI product or a multi-agent research framework.

This package is the deterministic core. It has:

  • Zero runtime dependencies (Phase 1)
  • No LLMs, no randomness, no I/O side effects
  • CPIC table versions pinned by filename (e.g. CYP2C19_named_diplotypes_v2022.1.json)
  • An explicit upgrade rhythm: CPIC updates → new file → new test pin → review → bump

Phase status

Phase Scope Status
1 Layer 2: PhenotypeEngine for CYP2D6 + CYP2C19 this release
2 Layer 1: VCFCaller + 16 gene callers (normalized signatures) planned
3 Layer 3: RecommendationLookup + optional HTTP service planned
4 Swarm expansion to the 13 non-CYP2D6/2C19/HLA-B genes planned

Install

pip install anukriti-pgx-core==0.5.0

# Or locally while iterating:
pip install -e /path/to/anukriti-pgx-core

Quick use (Layer 2 — what Swarm consumes)

from anukriti_pgx_core import PhenotypeEngine

engine = PhenotypeEngine()

result = engine.infer("CYP2C19", "*1", "*17")
# -> PhenotypeInference(
#        gene="CYP2C19",
#        diplotype="*1/*17",
#        activity_score=2.5,
#        phenotype="Rapid Metabolizer",           # per CPIC 2022 Table 2
#        confidence=1.0,
#        rule_version="cpic_activity_score_v2",
#        source="CPIC named-diplotype table (CYP2C19)",
#        cpic_table_version="CYP2C19_named_diplotypes_v2022.1",
#        ...
#    )

engine.supported_genes()
# -> ["CYP2C19", "CYP2D6"]

engine.cpic_table_version("CYP2C19")
# -> "CYP2C19_named_diplotypes_v2022.1"

Authoritative sources (pinned)

Gene Layer Table file Citation
CYP2D6 activity-score → phenotype CYP2D6_activity_v2019.10.json CPIC 2019 standardization (Caudle et al., PMID:31647186)
CYP2C19 named diplotype → phenotype CYP2C19_named_diplotypes_v2022.1.json CPIC 2022 clopidogrel guideline Table 2 (Lee et al., PMID:35034351; NCBI NBK84114)
CYP2C19 allele function (activity score) CYP2C19_activity_v2022.1.json CPIC 2022 allele functionality table

Updating a pinned table = adding a new file + bumping the pin + adding/updating the regression case. Silent in-place edits are not allowed.

Tests

cd anukriti-pgx-core
pip install -e ".[dev]"
pytest

# Or standalone:
python -m tests.test_pinned_star_alleles

Integration with existing Anukriti projects

From anukriti-swarm

Swarm's rules/phenotype_rules.py is a thin re-export shim that delegates here. All existing swarm code (agents/pharmacogene/base.py, core/verification/safety.py, core/runtime/runtime.py) continues to work unchanged. Migration to direct anukriti_pgx_core imports is opt-in per call site.

From anukriti (FastAPI product)

Phase 2 will migrate the 16 gene callers in anukriti/src/ into anukriti_pgx_core.calling. Until then, anukriti continues to use its existing caller modules unchanged.

License

Apache 2.0. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anukriti_pgx_core-0.6.0.tar.gz (86.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anukriti_pgx_core-0.6.0-py3-none-any.whl (89.1 kB view details)

Uploaded Python 3

File details

Details for the file anukriti_pgx_core-0.6.0.tar.gz.

File metadata

  • Download URL: anukriti_pgx_core-0.6.0.tar.gz
  • Upload date:
  • Size: 86.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for anukriti_pgx_core-0.6.0.tar.gz
Algorithm Hash digest
SHA256 437944103b44ed47354b6425b9e485d3a09ed952fc9eb6c0996e0575050193c6
MD5 cbba19c1f56fde3acde5896bc24c1825
BLAKE2b-256 2bc0f4efbd3adf80f2433e4ec0bf3da0f4cfe7674a71acf07c086bb88348a332

See more details on using hashes here.

Provenance

The following attestation bundles were made for anukriti_pgx_core-0.6.0.tar.gz:

Publisher: release.yml on AnukritiAi-hq/anukriti-pgx-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file anukriti_pgx_core-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for anukriti_pgx_core-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 852c0e201b237db9f4b7c67bc6bba54baf377b3343dfa5be44fd4cb13b8005a0
MD5 bcb35789052e8149993e687a4ea506f3
BLAKE2b-256 4d21d99b7622f658e35bba563f24a548978a6377aa879d5ae90ebe977292dec4

See more details on using hashes here.

Provenance

The following attestation bundles were made for anukriti_pgx_core-0.6.0-py3-none-any.whl:

Publisher: release.yml on AnukritiAi-hq/anukriti-pgx-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page