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 🚨

Check out our progress in the Snippy-NG Development Blog!

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.12.1.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.12.1-py3-none-any.whl (49.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snippy_nextgen-1.12.1.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.12.1.tar.gz
Algorithm Hash digest
SHA256 46f2760b14fca9e519ad3a20aee434e36a13f1eeff6eedb544a03bba706de4df
MD5 192848db7f3b1bd76e58bc909a2e698c
BLAKE2b-256 8300343806f43ef5048e37aa092f9c71e05983e7019b577cc7f0ad471e77133f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snippy_nextgen-1.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9b22df37d77614231e3c56b31e0b1b2f9ac666a50d87ba20764c136b0d612427
MD5 5f4b300de5d1fe0a5b14fef1bf1dc7fa
BLAKE2b-256 1e9bf15e2f664963f7d70434771b0f786a47f6770ee8e7e2596ffa1cabe52556

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