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

Uploaded Python 3

File details

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

File metadata

  • Download URL: snippy_nextgen-1.12.2.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.2.tar.gz
Algorithm Hash digest
SHA256 4a4ea1c929dc3bea5233aa430543691fbea694600a9c35cc0e9dd96386635bfc
MD5 6a454cc79813aba763feff3b1d4f576c
BLAKE2b-256 3a040e7f7511418ed7d291dae2f02c26390dcc13380b298b5f0d4d3363a8ae4b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snippy_nextgen-1.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e008cda4e05f4786d61382958cc1b3268f98c0c4fe215c1e6eb9d59ccc7e8a6
MD5 93a2eb68e4a4d233e13bc6c2130d7ef2
BLAKE2b-256 c8b5446357e547ec7ba3d52663ee12cba21e1b9bed8caea842623d80893590b4

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