Skip to main content

Phage bioinformatics utilities (seqclust runner and friends).

Project description


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

  • 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.

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.3.0.tar.gz (13.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.3.0-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: phu-0.3.0.tar.gz
  • Upload date:
  • Size: 13.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.3.0.tar.gz
Algorithm Hash digest
SHA256 634472e213b6ee97a3dc51699bfd6da94849c198833f790dbf4f8af835f742a9
MD5 bfe8c443335fa25b902702c25a360bb3
BLAKE2b-256 a72d81666bb2184df07cd577c4dca4064693292cc4486bb8b4cacd160d2c99c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for phu-0.3.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: phu-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 13.7 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bad5a74ef569cd3d213209a8df9cd068e04c7ab5cc11c74732c734b56b1e5fd6
MD5 91c1b2b0c3434d2fd6fa1e48ee648e3f
BLAKE2b-256 5412bf434170bfbc57c1ec70c8298d119cda8db06d3ccb57ff6f3d4e846d104c

See more details on using hashes here.

Provenance

The following attestation bundles were made for phu-0.3.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