Installation
VRS-Python requires Python 3.11 or later. Install it in a virtual environment:
The base package supports model validation, serialization, and identifier computation.
Translation, local sequence access, and VCF annotation
Install extras for SeqRepo,
UTA,
HGVS support, and VCF annotation.
Prerequisites
Install the prerequisites for your platform:
macOS
With Homebrew installed, run:
Ubuntu
Install the extras
In your virtual environment, run:
Sequence and transcript datasets require separate setup:
- Set up SeqRepo for allele normalization, SPDI/gnomAD translation, and VCF annotation.
- Set up UTA for HGVS workflows that need transcript metadata or alignments.
- Model construction, serialization, and identifier computation can run without either service; reference sequence validation requires SeqRepo.
Follow Set up SeqRepo and UTA for configuration instructions.
Notebooks
The notebooks group includes dependencies for running the
example notebooks. Include extras for the translation and
sequence-access examples: