Quickstart

The repository includes small data and configuration files to quickly run an instance of kmviz using a local index constructed with kmindex.

Requirements

• kmindex, see instructions for installation. We recommend the conda installation that includes kmindex dependencies.
• kmviz should be installed, see Installation.

Construct an index

cd tests/small_example
kmindex build -i index -f fof.txt -r my_index -d my_index_store -k 25 --hard-min 1 --bloom-size 100000 --cpr --nb-partitions 8 --threads 8

Start a kmindex-server

Start a query server at 127.0.0.1:8080. See kmindex-server --help if you need custom configuration.

cd tests/small_example
kmindex-server -i index

Start kmviz

poetry shell
cd tests/small_example
python -m kmviz.app --config config.yaml

The kmviz instance is now available at 127.0.0.1:8050.