Overview
Alvoc is a tool for estimating the abundace of variants of concern from wastewater sequencing data. Its predecessor is Alcov, an abundance learning tool for SARS-CoV-2 variants.
In addition alvoc can also be used for:
- Determining the frequency of mutations of interest in BAM files
- Converting nucleotide and amino acid mutations for a particular virus
- Comparing amplicon GC content with its read depth (as a measure of degredation)
Installation
With Pip
Pip is the default package installer for Python.
-
Install Python. We recommend using pyenv for python version management.
-
Install the latest version from pypi.
pip install alvoc
With UV
UV is a fast, all-in-one Python tool for dependency, version, and project management, replacing pip, poetry, and more.
- Install UV.
- Install the latest version from pypi.
uv add alvoc
Yes, including a Docker image under the installation section makes sense, especially for users who prefer containerized environments or need to integrate your tool into CI/CD pipelines. Here's how you can include it:
With Docker
For users who prefer containerized environments, an official Docker image is available on GitHub Container Registry (GHCR).
- Ensure you have Docker installed and running.
- Pull the latest Docker image:
docker pull ghcr.io/alvoc/alvoc:latest
- Run the container:
docker run --rm -it ghcr.io/alvoc/alvoc:latest
What is Alvoc?
Alvoc is a command-line tool designed to analyze viral sequencing data with a focus on identifying variants of concern and their defining mutations. With the ongoing rise of infectious diseases like SARS-CoV-2, monitoring and understanding viral evolution has become critical for researchers, public health officials, and laboratories.
Why Use Alvoc?
-
Lineage Identification
- Alvoc helps determine which viral lineages are present in your sequencing data. For example, it can identify emerging lineages like B.1.1.7 (Alpha) or P.1 (Gamma) for SARS-CoV-2.
- Use Alvoc when you need to:
- Compare samples to known lineage-defining mutations.
- Detect specific lineages in samples from an outbreak.
- Include or exclude specific lineages (whitelisting/blacklisting).
-
Mutation Detection
- Alvoc allows you to detect mutations in sequencing data with customizable depth thresholds.
- Use this feature to:
- Find known or novel mutations in viral samples.
- Focus on specific mutations like S:N501Y or E484K that are critical for vaccine efficacy or transmissibility.
-
Amplicon Quality Assessment
- Viral sequencing often relies on amplicon-based approaches. Alvoc provides tools to assess amplicon metrics like coverage and GC content.
- This helps ensure high-quality sequencing data for downstream analyses.
When to Use Alvoc?
You should use Alvoc if you are:
- A researcher analyzing viral sequencing data to study genetic variation and evolution.
- A public health analyst monitoring variants of concern during outbreaks.
- A bioinformatician processing large-scale sequencing data to identify mutations and lineages.
- A laboratory scientist validating amplicon-based sequencing data for accuracy.
Alvoc simplifies these workflows into a set of streamlined commands, saving time and improving consistency across analyses.
License
This project is licensed under the terms of the MIT license.
Metadata
Release files for alvoc 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| alvoc-0.5.0.tar.gz | 163.5 kB | Without provenance | Details for alvoc-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| alvoc-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for alvoc-0.5.0-py3-none-any.whl |
Total release size: 202.5 kB
Release files / alvoc-0.5.0.tar.gz
| Download URL | alvoc-0.5.0.tar.gz |
|---|---|
| Size | 163.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
115f11feaf9737a27864295abd2819137dc354e2bc4cad3b2c82e41f07a2c7b6
|
|
BLAKE2b-256 checksum How to use checksums |
445b822f59d1d768934d4bd2a9968a746155e12e27d7e4be6f3ac1f891b2ebab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.5.9
|
Release files / alvoc-0.5.0-py3-none-any.whl
| Download URL | alvoc-0.5.0-py3-none-any.whl |
|---|---|
| Size | 39.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b02df685f54d954c8197733c9c1cfaf5591edcd6ca5c2f80b99572bbadfdc8c
|
|
BLAKE2b-256 checksum How to use checksums |
530a776cb905feeeb92f8da2476b0c875f41e14ee7778a82ed2c8f9c54be48a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.5.9
|
Security for alvoc 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.