Skip to main content

UHT Discovery

UHT Discovery is a protein discovery pipeline centered on three core steps:

  1. blaster: retrieve homologous sequences from NCBI
  2. trim: quality-control and length-filter FASTA sequences
  3. clust (PLMCLUSTV2): cluster sequences using ESM2 embeddings and NLL scoring

Installation

From Source

git clone <repository-url>
cd uht-discovery-package
pip install -e .

From PyPI

pip install uht-discovery

Quick Start

1. BLASTER

Put one or more query FASTA files in:

inputs/blaster/PROJECT/

Run:

uht-blast --project PROJECT --email your@email.com --hits 500

Key options:

  • --project: project directory name (required)
  • --email: email for NCBI API usage (required)
  • --hits: number of hits to retrieve (default: 100)
  • --db: nr, swissprot, or refseq_protein (default: nr)
  • --evalue: BLAST E-value cutoff (default: 1e-5)

Outputs:

  • results/blaster/PROJECT/ with combined FASTA and BLAST report

2. TRIM

Put FASTA files in:

inputs/trim/PROJECT/

Run (automatic thresholds):

uht-trim --project PROJECT --auto

Run (manual thresholds):

uht-trim --project PROJECT --low 100 --high 500

Key options:

  • --project: project directory name (required)
  • --auto: infer thresholds automatically
  • --low / --high: manual inclusive length thresholds

Outputs:

  • results/trim/PROJECT/ with filtered FASTA files, removed-sequence logs, and QC plots

3. PLMCLUSTV2

Put FASTA files in:

inputs/plmclustv2/PROJECT/

Run:

uht-clust --project PROJECT --clusters auto

Or fixed cluster count:

uht-clust --project PROJECT --clusters 6

Key options:

  • --project: project directory name (required)
  • --clusters: integer cluster count or auto
  • --sil-min / --sil-max: silhouette search bounds for auto mode
  • --keep-separate: process each FASTA file independently

Outputs:

  • results/plmclustv2/PROJECT/ including cluster FASTAs, metrics CSVs, representative sequences, and visualization files

Recommended Workflow

Run the pipeline in this order:

  1. uht-blast
  2. uht-trim
  3. uht-clust

Help

uht-blast --help
uht-trim --help
uht-clust --help

Metadata

Release files for uht-discovery 0.2.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for uht-discovery 0.2.11
File Size Uploaded
uht_discovery-0.2.11.tar.gz 138.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for uht-discovery 0.2.11
File Interpreter ABI Platform
uht_discovery-0.2.11-py3-none-any.whl Python 3 none any Details

Total release size: 288.7 kB

Release files / uht_discovery-0.2.11.tar.gz

Download URL uht_discovery-0.2.11.tar.gz
Size 138.5 kB
Tags Source
SHA-256 checksum
How to use checksums
646a512f830f6c928f1d5596b4bdc31a4f5b78ceba1823d0b7369505fdecc3d3
BLAKE2b-256 checksum
How to use checksums
98e56926baf182ea718ceef98f367dc226854376ce3866679fa36b70f48f4a0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.15

Release files / uht_discovery-0.2.11-py3-none-any.whl

Download URL uht_discovery-0.2.11-py3-none-any.whl
Size 150.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4fa3273d4d908490fed7f6db039eb78745d882fe97bb28684edb9f4c93398911
BLAKE2b-256 checksum
How to use checksums
149e98bb2b2a665d2020958f65782ebb5894bd68abdc207f9483448094f65911
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.15

Release history Release notifications | RSS feed

This release

0.2.11 This release

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.7

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page