Sunbeam: a robust, extensible metagenomic sequencing pipeline
Sunbeam is a pipeline written in snakemake that simplifies and automates many of the steps in metagenomic sequencing analysis. It can be installed through PyPi (pip), Bioconda (conda), DockerHub (docker), or GitHub (git). Sunbeam was designed to be modular and extensible, allowing anyone to build off the core functionality. To read more, check out our paper in Microbiome.
Sunbeam currently automates the following tasks:
- Quality control, including adapter trimming, host read removal, and quality filtering;
- Taxonomic assignment of reads to databases using Kraken (sbx_kraken);
- Assembly of reads into contigs using Megahit (sbx_assembly);
- Contig annotation using BLAST[n/p/x] and Diamond (sbx_assembly);
- Mapping to reference genomes (sbx_mapping)
- ORF prediction using Prodigal (sbx_assembly).
More extensions can be found at https://github.com/sunbeam-labs.
To get started, see our documentation!
If you use the Sunbeam pipeline in your research, please cite:
EL Clarke, LJ Taylor, C Zhao, A Connell, J Lee, FD Bushman, K Bittinger. Sunbeam: an extensible pipeline for analyzing metagenomic sequencing experiments. Microbiome 7:46 (2019)
See how people are using Sunbeam:
- Shi, Z et al. Segmented Filamentous Bacteria Prevent and Cure Rotavirus Infection. Cell 179, 644-658.e13 (2019).
- Abbas, AA et al. Redondoviridae, a Family of Small, Circular DNA Viruses of the Human Oro-Respiratory Tract Associated with Periodontitis and Critical Illness. Cell Host Microbe 25, 719–729 (2019).
- Leiby, JS et al. Lack of detection of a human placenta microbiome in samples from preterm and term deliveries. Microbiome 6, 1–11 (2018).
Contributors
- Erik Clarke (@eclarke)
- Chunyu Zhao (@zhaoc1)
- Jesse Connell (@ressy)
- Louis Taylor (@louiejtaylor)
- Charlie Bushman (@ulthran)
- Kyle Bittinger (@kylebittinger)
Metadata
Release files for sunbeamlib 5.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sunbeamlib-5.2.2.tar.gz | 27.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sunbeamlib-5.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 66.5 kB
Release files / sunbeamlib-5.2.2.tar.gz
| Download URL | sunbeamlib-5.2.2.tar.gz |
|---|---|
| Size | 27.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
76de6cb9faf20008b32c74d0d17bb26e619b2d7fd83e173671ab86b700d4a0f7
|
|
BLAKE2b-256 checksum How to use checksums |
81fd4ba434ddec71b756b0a68697af4a212e121800d50cb1c427b5f44cc39604
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 16, 2025.
Transparency logRelease files / sunbeamlib-5.2.2-py3-none-any.whl
| Download URL | sunbeamlib-5.2.2-py3-none-any.whl |
|---|---|
| Size | 38.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5c7e549bac8379d01a3cf27548942eed0d012c6d3aa52743d4cbe4dd41413381
|
|
BLAKE2b-256 checksum How to use checksums |
04cf92fc63fc0efa73fec53b8e99fcc7470736d1ba43179caa79dd833d2fd0d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 16, 2025.
Transparency log