跳转到主要内容

使用k-mer草图比较生物序列的工具

项目描述

sourmash

快速搜索、比较和分析基因组与宏基因组数据集。

Project Status: Active – The project has reached a stable, usable state and is being actively developed. License: 3-Clause BSD Documentation Gitter

DOI pyOpenSci

Bioconda install PyPI Conda Platforms

Python 3.10 Python 3.11 Python 3.12 Build Status codecov

用法

sourmash sketch dna *.fq.gz
sourmash compare *.sig -o distances.cmp -k 31
sourmash plot distances.cmp

sourmash 1.0 已在 JOSS 上发表;如果使用 sourmash,请引用该论文(doi: 10.21105/joss.06830):

最新主要版本是 sourmash v4,与旧版本存在一些命令行和 Python 不兼容性问题。请访问我们的迁移指南升级!


sourmash 是一个 k-mer 分析多工具,我们旨在提供稳定、健壮的程序化和命令行 API,用于各种序列比较。我们的一些特色包括

  • FracMinHash sketching,允许在不同大小数据集之间进行准确比较(包括 ANI)
  • sourmash gather,一种组合 k-mer 方法,用于更精确的宏基因组分析

请参阅sourmash 发表物以获取详细信息。

这个名字是对 Mash 的致敬,结合了 @ctb 对威士忌的喜爱。(酸浆 用于制作威士忌。)

维护者:C. Titus Brown (@ctb),Luiz C. Irber, Jr (@luizirber),以及 N. Tessa Pierce-Ward (@bluegenes)。

sourmash 最初由 数据密集型生物学实验室 开发,该实验室位于 UC Davis 兽医学院,现在包括来自全球研究者和开发者社区的贡献。

安装

我们建议使用 conda-forge 安装 sourmash

conda install -c conda-forge sourmash-minimal

这将安装 sourmash 4 的最新稳定版本。

您也可以使用 pip 安装 sourmash

pip install sourmash

快速入门教程可用

要求

sourmash 在 Windows、Mac OS X 和 Linux 上使用 Python 3.10 及以上版本运行。基本要求是 screed、cffi、numpy、matplotlib 和 scipy。conda 将安装所有必需的软件包,并且是我们推荐安装方法(见下文)。

使用 conda 安装

conda-forge 是 conda 包管理器的一个社区维护频道。安装 conda 后,您可以通过运行以下命令安装 sourmash:

$ conda create -n sourmash_env -c conda-forge sourmash-minimal
$ conda activate sourmash_env
$ sourmash --help

这将安装最新发布的版本

支持

如有疑问,请通过 Github 上的问题打开问题,或在我们的聊天中提问。

开发

开发在 github 上的sourmash-bio/sourmash进行。

sourmash 使用 Python 和 Rust 开发,您需要 Rust 环境来构建它;请参阅开发人员说明以获取我们建议的开发设置。

安装后,sourmash 是主要的命令行入口点;使用 python -m sourmash 运行它,或者通过 pip install -e /path/to/repo 在虚拟环境中进行开发者安装。

sourmash/ 目录包含 Python 库和命令行界面代码。

src/core/ 目录包含实现核心功能的 Rust 库。

测试需要 py.test,可以使用 make test 运行。

有关设置开发环境的更多信息,请参阅开发者说明

CTB 2024年1月

发布历史 发布通知 | RSS 源

下载文件

下载您平台对应的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

sourmash-4.8.11.tar.gz (13.3 MB 查看哈希值)

上传于 源代码

构建的发行版

sourmash-4.8.11-py3-none-win_amd64.whl (1.9 MB 查看哈希)

上传于 Python 3 Windows x86-64

sourmash-4.8.11-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.8 MB 查看哈希)

上传于 Python 3 manylinux: glibc 2.17+ x86-64

sourmash-4.8.11-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.2 MB 查看哈希)

上传于 Python 3 manylinux: glibc 2.17+ ARM64

sourmash-4.8.11-py3-none-macosx_11_0_x86_64.whl (2.5 MB 查看哈希)

上传于 Python 3 macOS 11.0+ x86-64

sourmash-4.8.11-py3-none-macosx_11_0_arm64.whl (2.3 MB 查看哈希)

上传于 Python 3 macOS 11.0+ ARM64

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面