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 kmer indices 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.

The tool is available as a web-based application and as a 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 models download

Additional species models can be trained using:

xspect models train ncbi

How to run the web app

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

xspect web

How to use the XspecT command line interface

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

xspect classify species

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: xspect-0.4.1.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.4.1.tar.gz
Algorithm Hash digest
SHA256 f3a9852fd73d397f209ac2e1bc6a1c41b1e846129138151f83459d4d8d6d3c2e
MD5 4c8be6bcac6184740ba88bbe31c54d37
BLAKE2b-256 e62effd1a3f1199a381dfd6d92d5032bbab82460fd9c3db913b4bd44f7e97c45

See more details on using hashes here.

Provenance

The following attestation bundles were made for xspect-0.4.1.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.4.1-py3-none-any.whl.

File metadata

  • Download URL: xspect-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 32.9 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15ce773b1c97193e0179f7b1efc0ac05c991ecab2274cb472ce08414151e4286
MD5 10aef52eb7a829dbcf2b10dcc1a593d8
BLAKE2b-256 51f51f7bd3ebc516fe741ea42a835bb75f8a82c6f1a84bfcff1b0f5a95fa6acb

See more details on using hashes here.

Provenance

The following attestation bundles were made for xspect-0.4.1-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