Skip to main content

Phage bioinformatics utilities (seqclust runner and friends).

Project description


Combating Phage Genomes


phu - Phage Utilities

phu (phage utilities) or phutilities, is a modular toolkit for viral genomics workflows. It provides command-line tools to handle common steps in phage bioinformatics pipelines—wrapping complex utilities behind a consistent and intuitive interface.

Installation

You can install phu using mamba or conda from the bioconda channel:

mamba create -n phu bioconda::phu

Usage

As a command-line tool, phu follows a modular structure. You can access different functionalities through subcommands. The general syntax is:

phu <command> [options]

Commands

  • screen: Screen contigs for specific protein families using HMMER on predicted coding sequences.
  • jack: Iteratively screen contigs from one or more seed proteins with jackhmmer and combine hits across seeds.
  • cluster: Cluster viral sequences into species or other operational taxonomic units (OTUs).
  • simplify-taxa: Simplify vContact taxonomy prediction columns into compact lineage codes.

Contributing

We welcome contributions to phu! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and commit them.
  4. Submit a pull request describing your changes.

Developers

You can also install the development version of phu directly from GitHub:

git clone https://github.com/camilogarciabotero/phu.git
cd phu
pip install -e .

phu is also available on PyPI:

pip install phu

References

This program uses several key tools and libraries, make sure to acknowledge them when using phu:

  • vclust: A high-performance clustering tool for viral sequences:

Zielezinski A, Gudyś A, Barylski J, Siminski K, Rozwalak P, Dutilh BE, Deorowicz S. Ultrafast and accurate sequence alignment and clustering of viral genomes. Nat Methods. https://doi.org/10.1038/s41592-025-02701-7

  • seqkit: A toolkit for FASTA/Q file manipulation.

Wei Shen*, Botond Sipos, and Liuyang Zhao. 2024. SeqKit2: A Swiss Army Knife for Sequence and Alignment Processing. iMeta e191. doi:10.1002/imt2.191.

  • Prodigal: A gene prediction tool for prokaryotic genomes.

Hyatt, D., Chen, G. L., LoCascio, P. F., Land, M. L., Larimer, F. W., & Hauser, L. J. (2010). Prodigal: prokaryotic gene recognition and translation initiation site identification. BMC bioinformatics, 11(1), 119. https://doi.org/10.1186/1471-2105-11-119

  • pyrodigal: A tool for gene prediction in prokaryotic genomes.

Larralde, M., (2022). Pyrodigal: Python bindings and interface to Prodigal, an efficient method for gene prediction in prokaryotes. Journal of Open Source Software, 7(72), 4296, https://doi.org/10.21105/joss.04296

  • HMMER: A suite of tools for sequence analysis using profile hidden Markov models.

Eddy, S. R. (2011). Accelerated Profile HMM Searches. PLoS Computational Biology, 7(10), e1002195. https://doi.org/10.1371/journal.pcbi.1002195

  • pyHMMER: Python bindings for HMMER.

Larralde, M., & Zeller, G. (2023). PyHMMER: a Python library binding to HMMER for efficient sequence analysis. Bioinformatics, 39(5). https://doi.org/10.1093/bioinformatics/btad214

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phu-0.6.0.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

phu-0.6.0-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file phu-0.6.0.tar.gz.

File metadata

  • Download URL: phu-0.6.0.tar.gz
  • Upload date:
  • Size: 27.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for phu-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3140f769834bc0cd85edbbf384f00df81e982cc6c5030afaa7be15925ba4bd8c
MD5 f9ed96660d1c4e8bd9e041be0b15566a
BLAKE2b-256 7462d663a581ae6b3478b667528d0364efcdbc4ad0521613bcc0795874aab92b

See more details on using hashes here.

Provenance

The following attestation bundles were made for phu-0.6.0.tar.gz:

Publisher: python-publish.yml on camilogarciabotero/phu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file phu-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: phu-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 27.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for phu-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 755ac48d9965acee2a952e7d369dc4f454e271f7efa28255d61f8652f667f217
MD5 dbf29dfe0bd9ca99ec24793167e5927d
BLAKE2b-256 35d9607f12882d93035b869710434da5be890355620500cca08af481fb182e29

See more details on using hashes here.

Provenance

The following attestation bundles were made for phu-0.6.0-py3-none-any.whl:

Publisher: python-publish.yml on camilogarciabotero/phu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page