Installation¶
What to install besides the package itself: reference annotation, the PDF backends and compatible companion releases. Read this before a first real run.
Vaxrank requires Python 3.11 or newer.
Hitlist is included in the ordinary installation. Its evidence datasets are installed separately. CTA expression inputs automatically use a current local MS index when available; missing data leave the evidence unknown and never trigger a download. See Hitlist evidence for data setup, explicit bundles and saved-run replay.
Common CTA evidence¶
The ordinary installation supports OncoRef 1.23.1 through 1.27.0 (installs resolve to 1.24.0 while PirlyGenes, which Topiary requires, caps it; pirl-unc/pirlygenes#665) and requires ORFdata 0.42.6 or newer, which support the common RNA restriction policy. CTA dependencies are included in the ordinary installation; no extra is required.
Common CTA evidence and patient-background comparisons use one environment with Topiary 5.109.0 or newer. PirlyGenes also constrains the supported OncoRef range, so resolve related upgrades together:
The resolver may retain an older supported OncoRef release until a compatible
PirlyGenes release is available. Do not bypass these constraints with --no-deps.
The common policy remains opt-in: supply restriction_policy, its RNA evidence
and the complete host reference. Installing a newer reference package does not
admit a target, change historical CTA defaults or reinterpret saved decisions.
OncoRef 1.24's TCR-T evidence
retains its peptide, HLA and product limits; it is not an automatic admission
override for vaccine windows.
Reference annotation¶
Vaxrank uses PyEnsembl for reference genome annotation. Install an Ensembl release matching the reference genome your variants were called against:
# GRCh38
pyensembl install --release 113 --species human
# GRCh37 (legacy)
pyensembl install --release 75 --species human
PDF reports¶
PDF generation uses wkhtmltopdf by
default. Install a compatible executable and make it available on PATH.
Alternatively, pass --pdf-backend=weasyprint to use
WeasyPrint
(experimental). WeasyPrint is installed with Vaxrank but needs system
libraries such as Pango:
On Apple Silicon, WeasyPrint loads Pango through dyld, which does not search
Homebrew's /opt/homebrew/lib by default. Add this to your shell profile:
Intel macOS already includes Homebrew's /usr/local/lib in dyld's default
fallback path.
Isovar version window¶
RNA reconstruction requires a compatible Isovar release; see Isovar support compatibility for the tested range and the measurements Vaxrank retains from it.