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 are 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.5.0.tar.gz (488.9 kB view details)

Uploaded Source

Built Distribution

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

xspect-0.5.0-py3-none-any.whl (504.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xspect-0.5.0.tar.gz
Algorithm Hash digest
SHA256 350949799597d5c7678093d33a4d478c0d9ad47f80eff0bb13270a3481980d8b
MD5 7d581f04c3fc162c7fdcd3ab3e62fc3a
BLAKE2b-256 8f01d08530c13f4bf44964fa40aa62ac84cde67ae1c0754e4e281839a1f8ddf9

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: xspect-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 504.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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c8f043c7dc9e17a35ed9346ffc0fc469a4d444cd7cedd4117dedfbcdacda676
MD5 34f6e6d8e3c06e0d78d251039faa5f87
BLAKE2b-256 4b8ec34b01445f4c2c92508b4402c12e0336a6e0409a66fe22506149a5006a77

See more details on using hashes here.

Provenance

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