Skip to main content

a FracMinHash-based genome similarity estimator for bacteria

Project description

FracSim:fast bacterial genome similarity estimation using FracMinHash sketching

Latest Version PyPI version Python 3.8+ Platform License: MIT

FracSim is a fast and accurate tool for estimating bacterial genome similarity, based on the FracMinHash genome sketching algorithm. It compresses large genomes into compact hash sets to rapidly compute Jaccard similarity and ANI (Average Nucleotide Identity) between genomes.

Whether for species identification, strain typing, or large-scale genome comparison, FracSim significantly reduces memory usage and computation time while maintaining high accuracy.

Documents: https://zhuyu534.github.io/FracSim

✨ Features

  • Fast: Uses FracMinHash sketching to dramatically lower memory footprint and runtime.
  • Accurate: Provides Jaccard index and ANI (Average Nucleotide Identity) estimates.
  • Flexible: Supports FASTA/Q formats, configurable k‑mer size and sampling rate.
  • Easy to use: Clean command‑line interface with multi‑threading support.
  • Open source: MIT licensed – contributions and usage are welcome.

📦 Installation

Requirements

  • Python 3.8 or higher

Method 1: Download binaries

Check out the Download Page for pre-built binaries across all supported platforms.

Method 2: Install From PyPI

pip install FracSim

Method 3: Install from source

git clone https://github.com/zhuyu534/FracSim.git
cd FracSim
pip install -e .

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

fracsim-1.0.2.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

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

fracsim-1.0.2-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file fracsim-1.0.2.tar.gz.

File metadata

  • Download URL: fracsim-1.0.2.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for fracsim-1.0.2.tar.gz
Algorithm Hash digest
SHA256 9b44d02819095e6e5cf781072b8915f9f373a2d495412d7f57dfe83e4636ba85
MD5 3d926b10fe2f2e5296d4a8a05586ea86
BLAKE2b-256 056e6018f6fe6be0dedf4ab4264301535f1e80103aef028678b12d1b0d8e8758

See more details on using hashes here.

File details

Details for the file fracsim-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: fracsim-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 27.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for fracsim-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 df76e92d0841ce1e1168d3437d6bc9b3e2b13766b0abefae52501dd0ca5fdb1f
MD5 36d3384d49af9b99783fdcf88a42d375
BLAKE2b-256 adcce65cfcb7ea50411ee4a44ab3caca794a1098cb3062943240e4b26c13fdb2

See more details on using hashes here.

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