Skip to main content

Tool to monitor and characterize pathogens using Bloom filters.

Project description

XspecT - Acinetobacter Species Assignment Tool

Test linting: pylint Code style: black

XspecT is a Python-based tool to taxonomically classify sequence-reads (or assembled genomes) on the species and/or MLST level using Bloom Filters and a Support Vector Machine.

XspecT utilizes the uniqueness of kmers and compares extracted kmers from the input-data to a reference database. Bloom Filter ensure a fast lookup in this process. For a final prediction the results are classified using a Support Vector Machine.

Local extensions of the reference database are supported.

The tool is available as a web-based application and a smaller command line interface.

Installation

To install Xspect, please download the lastest 64 bit Python version and install the package using pip:

pip install xspect

Please note that Windows and Alpine Linux is currently not supported.

Usage

Get the models

To download basic pre-trained models, you can use the built-in command:

xspect download-models

Additional species models can be trained using:

xspect train-species you-ncbi-genus-name

How to run the web app

To run the web app, install and run XspecT Web. Additionally, run XspecT in API mode:

xspect api

How to use the XspecT command line interface

Run xspect with the configuration you want to run it with as arguments.

xspect classify-species your-genus path/to/your/input-set

For further instructions on how to use the command line interface, please refer to the documentation or execute:

xspect --help

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

xspect-0.2.7.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xspect-0.2.7-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

Details for the file xspect-0.2.7.tar.gz.

File metadata

  • Download URL: xspect-0.2.7.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xspect-0.2.7.tar.gz
Algorithm Hash digest
SHA256 c6b049f6451493c4a27206617282c7a58faada457d7ffa5860f8b2bd73535631
MD5 2ed33c7440c7bad2371f79a04af582a4
BLAKE2b-256 26fc9fa807d414c10398ee6d85560d0fdc2d8ce2c85b57da74a816d7d73e7d55

See more details on using hashes here.

Provenance

The following attestation bundles were made for xspect-0.2.7.tar.gz:

Publisher: pypi.yml on BIONF/XspecT2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xspect-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: xspect-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 37.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xspect-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4330bb9cea02dfbc8ef29057048f9c84adb892abfaed0aaf9610c5e5b7c180d8
MD5 c52a7fb9bda33f5e24fc83857f1e9131
BLAKE2b-256 aa93e177d0557b92004e3db43fa03e8638be77af68b944569836798b29e8df2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for xspect-0.2.7-py3-none-any.whl:

Publisher: pypi.yml on BIONF/XspecT2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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