atavide lite documentation
atavide_lite is a modular metagenomics workflow for quality control, optional host-read removal, read-based taxonomic and functional profiling, assembly, and recovery of metagenome-assembled genomes (MAGs). It supports paired-end short reads and single-end or long reads on Slurm- and PBS-managed high-performance computing (HPC) systems.
The project deliberately uses visible, independently submitted batch scripts instead of hiding the entire analysis inside one workflow invocation. That makes failures easier to locate, individual stages easier to repeat, and CPU, memory, wall-time, storage, and GPU requests easier to tune for each cluster.
Where to begin
New users should follow this path:
Read Overview to decide whether the workflow fits the analysis.
Follow Installation to clone the repository, build its utilities, and create the software environments.
Use Choosing a profile to select scripts for the read type and HPC system.
Complete Quick start with a small, non-sensitive dataset.
Refer to Configuration and Pipeline stages while scaling up.
Cluster maintainers and contributors can start with Contributing and Adding a cluster.
Introduction
- Overview
- Design and rationale
- Explicit stages instead of one opaque run
- Failure containment and restartability
- Separate profiles instead of universal scheduler abstraction
- A small analysis contract
- Similar processing across sequencing technologies
- Read-based and assembly-based branches
- Resource-aware data movement
- Conservative use of automation and AI
User guide
- Installation
- Choosing a profile
- Quick start
- Configuration and input preparation
- Pipeline stages
- Dependency model
- 1. Quality control with fastp
- 2. Optional host-read separation
- 3. FASTQ-to-FASTA conversion
- 4. Read-based taxonomy with MMseqs2
- 5. Taxonomy completion and summaries
- 6. Functional annotation with BV-BRC Subsystems
- 7. Optional PHROG annotation
- 8. Assembly with MEGAHIT
- 9. Preparing contigs for VAMB
- 10. Binning with VAMB
- 11. MAG quality with CheckM
- 12. Optional grouped VAMB
- 13. Read-fate and Sankey summaries
- Outputs and interpretation
- Troubleshooting
- A practical diagnosis order
- Unbound variables
- No samples or wrong array indices
- Missing paired reads
- Conda activation fails in a batch job
- Tool not found or wrong version
- Job exceeded wall time
- Out of memory
- Files disappeared from scratch
- MMseqs2 database not found
- TaxonKit errors or incomplete taxonomy
- Empty output after fastp
- Dependency will never run
- Asking for help
Project links
The documentation describes the repository as shipped. Cluster policies and third-party software change independently, so confirm scheduler limits and software versions with the relevant HPC provider before submitting expensive jobs.