Skip to content

Getting Started

Requirements

Operating system Linux. macOS and Windows are not supported (why →)
glibc 2.28 or newer: RHEL and Rocky 8, Debian 10, Ubuntu 18.10, or anything later. ldd --version prints what you have. CentOS 7 is the one common machine below it, and is end of life. Why →
Conda Conda or Miniconda
Git Optional, for cloning
Working directory mainDir: where you launch the pipeline. Holds your reads, the reference, this project's configuration and everything actively processed. It has to persist between runs; it is not scratch space
Permanent storage storageDir: where finished results are kept. Must be a different path from mainDir, and neither may be the installation itself. The pipeline will refuse to start otherwise
Disk mainDir needs room for your inputs and the files produced along the way; storageDir for the BAMs, VCFs and tables you keep

Everything else is installed for you. ./PoolSeqFlow install builds an isolated conda environment from install/environment.yml, which pins every tool to an exact build:

Tool Version Role
Nextflow 26.04.6 Workflow engine
FastQC 0.12.1 Read quality metrics
Trim Galore 2.3.0 Adapter and quality trimming
Cutadapt 5.2 Composition-aware clipping
BWA 0.7.19 Alignment
SAMtools 1.24 BAM processing and filtering
BAMtools 2.5.3 Alignment statistics
BCFtools 1.24 Variant calling and VCF manipulation
VCFtools 0.1.17 VCF filtering and splitting
SnpEff 5.4.0c Variant annotation (optional)
OpenJDK 25 Runtime for FastQC, SnpEff and Nextflow

Pinning is deliberate. Pool-seq results depend on the exact behavior of the pileup and filtering tools, and an unpinned environment would make two runs of the same config non-comparable.


Ready

Check out these two pages:

  • Install gets the tool onto your machine and verifies it, which is two steps and a wait.
  • Quick Start is everything to do with your own data: making the project, filling in the three files that describe it, and starting the run.

Install PoolSeqFlow Quick Start

Already have it installed and upgrading from an earlier version? Read Upgrading first. Your parameters.config is never touched by an update and can be missing parameters the new code expects.