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.0.tar.gz (155.6 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.0-py3-none-any.whl (163.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zipstrain-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1424ac24ed5816c96ca59762e22fb4ae857f4c975b3e64df975d525c9698d4a8
MD5 15c7aa23c0aa34681c59c470aeddc1c8
BLAKE2b-256 8f1fc1d546940279584b3727c25ab3ffe9f4fd8d2ff186e3a091e6defe1c2d24

See more details on using hashes here.

Provenance

The following attestation bundles were made for zipstrain-1.0.0.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.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for zipstrain-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e07a40dc0414a96f084bade99b2b7a7e951c1332e27f373cd8a9fcbcefaef6da
MD5 545df0be0da59a2f0f70407725648bc9
BLAKE2b-256 82ffd0f8a9015878de7fcebca0d44a6b84538c69e95048a20f732dbd7930770b

See more details on using hashes here.

Provenance

The following attestation bundles were made for zipstrain-1.0.0-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