Skip to main content

The Next Generation of Microbial Variant Calling with Snippy

Project description

Snippy-NG

CZI's Essential Open Source Software for Science 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.14.0.tar.gz (35.0 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.14.0-py3-none-any.whl (55.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snippy_nextgen-1.14.0.tar.gz
  • Upload date:
  • Size: 35.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.2 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for snippy_nextgen-1.14.0.tar.gz
Algorithm Hash digest
SHA256 19f31787b5ce41cf72ca1fbcce037a77f9dac8ff9ad491b6624c95c1524a3afe
MD5 d1162d7b43f3de3f1cb7c0af074909c8
BLAKE2b-256 a687db2bc9199601f22cc842df15b1ee205194f6b413f398b2e307035cc30e0d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: snippy_nextgen-1.14.0-py3-none-any.whl
  • Upload date:
  • Size: 55.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.2 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for snippy_nextgen-1.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09968dc41d9ce3d12f6338ac9cc3d47692db83988b9ea49eacfe30ecf0e89a3b
MD5 0bd16a30c9f0d46b11a7e3c2da57104f
BLAKE2b-256 8e40dc3eb59952554396d7d17f0ff8a362ea5c51218e221f1d53891562c2f12b

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