Contact: Ruibang Luo, Junhao Su
Email: [email protected], [email protected]

ClusterV-Web is a powerful and user-friendly web application designed to accurately identify HIV quasispecies from ONT sequencing data using the ClusterV algorithm. By utilizing ClusterV-Web, users can input the alignment BAM file, reference FastA file, and target region BED file (which defines the specific regions of interest) for their HIV data. The application then generates comprehensive results, including the discovered quasispecies with their respective abundance, alignment information, variants (such as SNPs and INDELs), and detailed drug resistance reports.

ClusterV-Web is hosted by the BAL laboratory and can be accessed through the following website: https://www.bio8.cs.hku.hk/ClusterVW/. This user-friendly web application facilitates the analysis of HIV quasispecies and provides invaluable insights into the genetic diversity and drug resistance profiles of the virus.

• Introduction
• Installation
  • Option 1. Docker pre-built image
  • Option 2. Docker Dockerfile

A pre-built docker image is available here. With it you can run ClusterV-Web using a single command.

docker run --name clustervw -d -p 8000:5000 --rm hkubal/clustervw:latest

# the website should be available at your web browser via address of 127.0.0.1:8000, 
# or [YOUR IP]:8000, you can check your IP via `ifconfig`

# close the website by
docker ps
docker rm -f [DOCKER CONTAINER ID FOR CLUSTERVW]

Building a docker image.

# clone ClusterV-Web
git clone https://github.com/hku-bal/ClusterV-Web.git
cd ClusterV-Web

# build a docker image named hkubal/clustervw:latest
# might require docker authentication to build docker image 
docker build -f ./Dockerfile -t hkubal/clustervw:latest .

# run clustervw docker image like 
docker run --name clustervw -d -p 8000:5000 --rm hkubal/clustervw:latest

# the website should be available at your web browser via address of 127.0.0.1:8000, or YOUR IP:8000
# you can check your IP via `ifconfig`
# for security concerns, please change `this-is-a-long-secret-key` in ./app/config.py file when building the docker image before you expose your website to the public.