parKVFinder Installation

parKVFinder Installation Guide

Follow these steps to install parKVFinder software on Linux or macOS:

1. Download parKVFinder source code.

Get the latest parKVFinder release from here.

On the terminal, go to the directory containing parKVFinder-x.x-x.zip file.

$ unzip parKVFinder-x.x.x.zip
$ cd parKVFinder

Or, clone the parKVFinder repository into a new directory using git.

$ git clone https://github.com/LBC-LNBio/parKVFinder.git
$ cd parKVFinder

2. Compile parKVFinder from source.

parKVFinder supports GCC (GNU Compiler Collection) versions later than 6. If necessary, refer to this guide for installing GCC versions later than 6 on Linux and macOS.

$ make

3. Create a symbolic link to run parKVFinder consistently.

$ make link

Note: make link create a soft symbolic link for parKVFinder in your /usr/local/bin directory, using the following command sudo ln -s `pwd`/parKVFinder /usr/local/bin/parKVFinder.

4. Export KVFinder_PATH variable and add to ~/.bashrc file or similar configuration file.

$ export KVFinder_PATH=`pwd`
$ echo "export KVFinder_PATH=`pwd`" >> ~/.bashrc
$ source ~/.bashrc

Note: Depending on the operating system, other configuration files are used instead of ~/.bashrc. For example, in macOS ~/.bash_profile are used.

If you are planning on using parKVFinder on Windows, refer to this parKVFinder-win repository.

---