README.md

@dib-lab/kSpider

📖 Table of Contents

➤ Table of Contents

• ➤ Table of Contents
• ➤ Introduction
• ➤ Quick Installation (pip)
• ➤ Build from source
• ➤ Authors
• ➤ License

➤ Introduction

kSpider is a user-friendly command line interface program to perform sequence clustering. First, it creates an index using kProcessor for the source sequences. Second, it constructs a pairwise containment matrix through a single iteration over the index. Finally, it builds a graph from the pairwise matrix and applies a connected-components graph algorithm to extract the clusters with a user-defined containment threshold.

Documentations are hosted at https://dib-lab.github.io/kSpider

➤ Quick Installation (pip)

pip install kSpider

➤ Manual build / Development

Install dependencies

sudo apt-get install g++ swig cmake python3-dev zlib1g-dev libghc-bzlib-dev python3-distutils libboost-all-dev

git clone https://github.com/dib-lab/kSpider.git
cd kSpider
git submodule update --init --recursive
cmake -Bbuild
cmake --build build
bash build_wrapper.sh

➤ Authors

Mohamed Abuelanin	Tamer Manosur

➤ License

Licensed under MIT License.