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

Uploaded Python 3

File details

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

File metadata

  • Download URL: snippy_nextgen-1.12.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.12.0.tar.gz
Algorithm Hash digest
SHA256 a2195f35426d67b35064c68403dc7dc0d8c2369ba1f267cbae6052fb2bd3e7ca
MD5 1b28e22ad9fe1bb19763776ccc32e50b
BLAKE2b-256 2f62b5383572fb3daca4cd9c9d480e3453de239ae41f338c661ff7a026c14963

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snippy_nextgen-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72dd9049246e9f6b9445dbfa4f8dbedb0e4d655be923c4c658fb49e4ffa99137
MD5 293c18c9d6a5ea7d40a66d9018536e57
BLAKE2b-256 81690582d0727bf1758013ac3c646d1dacb2851481180158dff836b1b583ffe6

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