Skip to content

VRS-Python

VRS-Python implements the GA4GH Variation Representation Specification (VRS) in Python. It helps you represent variants consistently and compare records across data sources using identifiers computed from their content.

Use VRS-Python to:

  • Build and validate VRS and GKM-Core objects with Pydantic (see VRS compatibility).
  • Normalize alleles and compute consistent GA4GH identifiers.
  • Translate supported HGVS, SPDI, and gnomAD expressions to VRS.
  • Annotate VCF files with VRS allele identifiers.
  • Store and exchange objects using inline or referenced components.

Start using VRS-Python

  • Install

    Choose the dependencies for your workflow.

  • Quick start

    Build your first allele and compute its identifier.

  • Explore with notebooks

    Work through models, sequence access, and translation examples.

  • API reference

    Find Python classes, functions, and their parameters.

  • Set up SeqRepo and UTA

    Connect sequence and transcript data for translation and normalization.

  • Contribute

    Improve the implementation, examples, and documentation.