WTV Documentation
Welcome to the WTV documentation. This project provides tools for ion selection in mass spectrometry data based on the WTV-2.0 algorithm.
Features
- Command-line interface (CLI) for easy usage
- Library functions for programmatic access
- Support for MSP file format
- Configurable parameters for different use cases
Quick Start
Installation
uv sync --all-extras
Running the CLI
uv run wtv-cli --msp_path input.msp --outpath ./output --mz_min 35 --mz_max 400
Navigation
Explore the sections below:
- Installation - How to install and set up the package
- CLI Usage - Using the command-line interface
- Library Usage - Using the library programmatically
- API Reference - Detailed API documentation
- Ion Selection API
- Utils API
- Similarity API
Acknowledgements
This project is based on the original work by Honglun Yuan et al., published in WTV_2.0.