Snippy-NG
Synopsis
🚨 This software is still under development 🚨
snippy-ng is a modern version of the classic snippy tool.
It finds variants in haploid microbial
genomes relative to a reference genome.
It can accept short reads, long reads, or
assembled genomes.
It can also combine the variants from multiple
samples to make a multiple sequence alignment
and a phylogenomic tree.
Final results can be viewed from an interactive
HTML report.
Documentation
Installation
Install script
curl -sSL https://cpg.org.au/snippy-ng/install.sh | bash -s -- --force
Conda
Will be available on first official release.
Quick Start
snippy-ng short --ref tests/data/reference.gbk --R1 tests/data/mutant_R1.fastq.gz --R2 tests/data/mutant_R2.fastq.gz
snippy-ng asm --ref tests/data/reference.gbk tests/data/wildtype.contigs.fa
export CLAIR3_MODELS=./clair3_models # try to find appropriate models in this directory
snippy-ng long --ref tests/data/JKD6159.fasta tests/data/JKD6159.fastq.gz
snippy-ng utils gather --json --ref tests/data/reference.gbk tests/data/{wildtype,mutant}* > samples.json
snippy-ng multi samples.json --cpus 6 -o multi
snippy-ng tree --fast multi/core/core.095.aln -o multi/tree
snippy-ng utils report tree multi/tree/tree.snps.newick --metadata multi/snippy.vcf.summary.tsv -o multi/report
Development
To set up a development environment, clone the repository and install pixi and hatch. Pixi is used to manage external dependencies, and Hatch is used to manage the Python package development.
git clone git@github.com:centre-pathogen-genomics/snippy-ng.git && cd snippy-ng
# install pixi if not already installed
curl -fsSL https://pixi.sh/install.sh | bash
# install hatch if not already installed
pixi global install hatch
Activate the pixi environment and launch a hatch shell. This will install all dependencies and set up the development environment.
pixi shell
hatch shell
snippy-ng --help
Testing
Run the default fast test suite with:
pixi run test
Run the simulation-backed integration tests with:
pixi run -e integration test-integration
Simulated inputs are generated at test time and cached under .cache/integration-sim/.
See docs/integration-tests.md for the scenario format and harness contract.
License
snippy-ng is distributed under the terms of the MIT license.
Funding
This work was funded by the CZI EOSS scheme from 2024-2026.
Authors
- Wytammma Wirth
- Torsten Seemann
1 maintainer
Metadata
1 maintainer
Release files for snippy-nextgen 1.38.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| snippy_nextgen-1.38.0.tar.gz | 37.0 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| snippy_nextgen-1.38.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 37.5 MB
Release files / snippy_nextgen-1.38.0.tar.gz
| Download URL | snippy_nextgen-1.38.0.tar.gz |
|---|---|
| Size | 37.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
43f162e7550a46125f21256ac8e3fd55c56e121b37276aa4f4e8e5b0f8d85ff8
|
|
BLAKE2b-256 checksum How to use checksums |
cf53971eeace72478e4692816c3e73fc704d093e4b12b6847c730b93b392ede2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.18.1 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.15.1
|
Release files / snippy_nextgen-1.38.0-py3-none-any.whl
| Download URL | snippy_nextgen-1.38.0-py3-none-any.whl |
|---|---|
| Size | 485.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c03aa21f72aa613caaf8f47840ac9bc48c691127f688323702b5cef98a0ea4be
|
|
BLAKE2b-256 checksum How to use checksums |
97f7ff898d41a62ac316f3a619463aa9320f52fbd415bc0165f7c75b01e42023
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.18.1 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.15.1
|
Security for snippy-nextgen 1.38.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
