Skip to main content

The Next Generation of Microbial Variant Calling with Snippy

Project description

Snippy-NG

PyPI - Version PyPI - Python Version Test Coverage Downloads Benchmark

🚨 Snippy-NG is under construction and should not replace Snippy 🚨

Table of Contents

Installation

snippy is available on PyPI and can be installed using pip (without external dependencies):

pip install snippy-nextgen

The complete snippy-ng environment (including all dependencies) can be installed using the snippy-ng installer script. This script will install the latest version of snippy-ng and all its dependencies.

curl -sSL https://cpg.org.au/snippy-ng/install.sh | bash -s -- --force

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 add 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

License

snippy-ng is distributed under the terms of the MIT license.

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

snippy_nextgen-1.10.0.tar.gz (6.9 MB view details)

Uploaded Source

Built Distribution

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

snippy_nextgen-1.10.0-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file snippy_nextgen-1.10.0.tar.gz.

File metadata

  • Download URL: snippy_nextgen-1.10.0.tar.gz
  • Upload date:
  • Size: 6.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for snippy_nextgen-1.10.0.tar.gz
Algorithm Hash digest
SHA256 d1c8c7af8019d90c0f4977500c51b4b0dbe2a2c240e2714b93a6a7bbc448986f
MD5 e7f88b3933e6ceb58ea84d3554b56f13
BLAKE2b-256 2a31889f104029059ddd530ba8beaa127659493592239405a9756e02100eb6cb

See more details on using hashes here.

File details

Details for the file snippy_nextgen-1.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for snippy_nextgen-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33b639b8056a0f9397e38b48c6c5cb2e4ca04ec140daf564482ed684ab5769e2
MD5 375720b5ba48cc46ba19329682381f3f
BLAKE2b-256 a7343c618001b6a35e52b6c4e87096beff6cabb3306d29ecad6335149fb2b767

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