Skip to main content

No project description provided

Project description

ZipStrain

Fast strain-level metagenomics in three commands: map reads to BAMs, profile them into per-position nucleotide-count tables, and compare samples by ANI to tell whether they share a strain.

Documentation:

Install

Conda is the easiest path — it brings in samtools and the map aligners too:

conda create -n zipstrain -c conda-forge -c bioconda \
  python=3.12 zipstrain bowtie2 samtools sylph

Or with pip (into a fresh virtual environment):

pip install zipstrain

Matrix-store comparison dependencies (compare --method matrix):

pip install "zipstrain[matrix]"

Notes:

  • With pip, install samtools separately (profiling needs it); zipstrain map additionally needs bowtie2 and sylph (and prodigal for --predict-genes).

  • On Apple Silicon, use a native osx-arm64 Conda so dependencies install natively; the standard torch wheel uses the MPS backend.

  • Linux CUDA installs should replace Torch with the matching CUDA wheel from PyTorch:

    pip install "zipstrain[matrix]"
    pip install --upgrade torch --index-url https://download.pytorch.org/whl/cu124
    

See the installation guide for full details.

Verify

zipstrain --version
zipstrain test

Cite

If you use ZipStrain in your research, please cite the preprint:

Ghadermazi P, Emerson JB, Olm MR. 2026. ZipStrain Enables Rapid and Precise Strain-Resolved Metagenomics. bioRxiv. DOI: 10.64898/2026.05.20.726564

GitHub citation metadata is provided in CITATION.cff:

License

ZipStrain is distributed under the MIT License.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

zipstrain-1.0.1.tar.gz (157.4 kB view details)

Uploaded Source

Built Distribution

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

zipstrain-1.0.1-py3-none-any.whl (165.3 kB view details)

Uploaded Python 3

File details

Details for the file zipstrain-1.0.1.tar.gz.

File metadata

  • Download URL: zipstrain-1.0.1.tar.gz
  • Upload date:
  • Size: 157.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for zipstrain-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5b424d68e112e2adbde166653f20785d158d902f6e4d40a970c85eddd912d2a2
MD5 b446074da88d18bce0dff3975228f975
BLAKE2b-256 9a1d9f350f188d1f207e50c21fb0a1ac9d9c2cb951e9e6bd2f3f7fb729ac2a10

See more details on using hashes here.

Provenance

The following attestation bundles were made for zipstrain-1.0.1.tar.gz:

Publisher: pypi-publish.yml on OlmLab/ZipStrain

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

File details

Details for the file zipstrain-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: zipstrain-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 165.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for zipstrain-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a5519ecd0ddc412341125ac8fe3cc7258644424fecbfacf130c2f9ed5f61fd15
MD5 4a2895139a562cbf4c05900cd26cd966
BLAKE2b-256 24aad4ae5ecba52eaaa565cfc6bcb287956c6c8f43efc5331e4b5b955d06f945

See more details on using hashes here.

Provenance

The following attestation bundles were made for zipstrain-1.0.1-py3-none-any.whl:

Publisher: pypi-publish.yml on OlmLab/ZipStrain

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