Skip to content

parabricks-benchmark 🔬

Benchmarking Parabrick's GPU-accelerated tools
tests docs GitHub issues GitHub license

This is the home of the pipeline, parabricks-benchmark. Its long-term goals: to benchmarking Parabricks GPU-accelerated tools for GATK and beyond!

Overview

Welcome to parabricks-benchmark's documentation! This guide is the main source of documentation for users that are getting started with the long pipeline name.

The ./parabricks-benchmark pipeline is composed several inter-related sub commands to setup and run the pipeline across different systems. Each of the available sub commands perform different functions:

parabricks-benchmark run
Run the parabricks-benchmark pipeline with your input files.

parabricks-benchmark unlock
Unlocks a previous runs output directory.

parabricks-benchmark install
Download remote reference files locally.

parabricks-benchmark cache
Cache remote software containers locally.

parabricks-benchmark is pipeline to test and compare different GPU-accelerated parabricks tools against the tools they were inspired from. It relies on technologies like Singularity1 to maintain the highest-level of reproducibility. The pipeline consists of a series of data processing steps orchestrated by Snakemake2, a flexible and scalable workflow management system, to submit jobs to a cluster.

The pipeline is compatible with data generated from Illumina short-read sequencing technologies. The GATK germline pipeline was tested using NIST's GIAB HG002, HG003, HG004 samples.

Before getting started, we highly recommend reading through the usage section of each available sub command.

For more information about issues or trouble-shooting a problem, please checkout our FAQ prior to opening an issue on Github.

Contribute

This site is a living document, created for and by members like you. parabricks-benchmark is maintained by the members of NCBR and is improved by continous feedback! We encourage you to contribute new content and make improvements to existing content via pull request to our GitHub repository .

Citation

If you use this software, please cite it as below:

Citation coming soon!
Citation coming soon!

References

1. Kurtzer GM, Sochat V, Bauer MW (2017). Singularity: Scientific containers for mobility of compute. PLoS ONE 12(5): e0177459.
2. Koster, J. and S. Rahmann (2018). "Snakemake-a scalable bioinformatics workflow engine." Bioinformatics 34(20): 3600.


Last update: 2024-06-25
Back to top