README.md

IRKit

Information Retrieval tools intended for academic research.

Web: https://elshize.github.io/irkit/

Primary Goals

1. Composability and flexibility.
2. Modern and clean code.
3. Efficiency.

These goals should be achieved iteratively.

Documentation

https://elshize.github.io/irkit/docs/html/

Installation

We recommend using conan package manager. You can install it using pip:

export PATH=$HOME/.local/bin:$PATH
pip install --user conan

With conan installed, use it to install dependencies, and compile the project:

mkdir build && cd build
conan install .. --build=missing

You can also choose to use system installation of Boost:

mkdir build && cd build
conan install .. --build=missing -o irkit:use_system_boost=True

Once this is done, you can use cmake to build and install.

cmake ..
cmake --build .  # or: make
sudo cmake --build . --target install  # or: sudo make install

Conan Package

If you want to use irkit as a dependency in your project, you can use the conan package. First, must add the remote repositories:

conan remote add irkit https://api.bintray.com/conan/elshize/irkit
conan remote add conan-community https://api.bintray.com/conan/conan-community/conan
conan remote add cliutils https://api.bintray.com/conan/cliutils/CLI11
conan remote add bincrafters https://api.bintray.com/conan/bincrafters/public-conan
conan remote add manu https://api.bintray.com/conan/manu343726/conan-packages

Then install locally:

conan install irkit/0.1@elshize/develop

or use in your conanfile.py.