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.11.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.11.0-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snippy_nextgen-1.11.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.11.0.tar.gz
Algorithm Hash digest
SHA256 d69be5ec9c0e9550db4ad68bf52691157aa758ef2963c47f19020de74dfd1a06
MD5 c89e6e7ff36f3f63acef953f9e74c115
BLAKE2b-256 342194e413053951f4b957c54f19971a9b587cd121b5a6389a0e1fe83078dcbf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snippy_nextgen-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17a45bf7f97a0df23e00c04289b8a387a40912a6387d1998dbc1992e1bb90893
MD5 3d9c9229f1209a25caadbddcd15f194f
BLAKE2b-256 9e949df233bdf6c8f7a34d023faf23fb95a452fbce7c4089b6b74f95e48748ca

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