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.9.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.9.0-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snippy_nextgen-1.9.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.9.0.tar.gz
Algorithm Hash digest
SHA256 cd658b23959b063cffc20b1288736979b095ecb4c4d4ffbaffda7604c60b976e
MD5 b2e5bca0dbee542080266b2b30d23886
BLAKE2b-256 984170fb76ccc1045c5d99fac497d66576f7fbed89b69ccf42330bcd3de7d9fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snippy_nextgen-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d26c8b8ae4a69b40c77b8c175f5bd028cee50c001f8a4ccfa466ad59a6ac648b
MD5 9fb944cc32bda6803af207519200705e
BLAKE2b-256 f55f9356987dc57e6d817f31c61f581931034a367c19831c114aa7a932f7ad66

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