Quickstart¶

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.

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

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

xspect api

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