Read Me

##############################################################################
#
# README file for vicut
#
##############################################################################

This is a C++ implementation of a vi-cut algorithm

* Saket Navlakha, James White, Niranjan Nagarajan, Mihai Pop, Carl Kingsford:
"VI-Cut: Finding Biologically Accurate Clusterings in Hierarchical Tree
Decompositions Using the Variation of Information" In Proceedings of RECOMB 2009,
volume 5541, pages 400--417. (http://www.cbcb.umd.edu/VICut)


If you have any installation/usage problems or questions,
please e-mail Pawel Gajer at pgajer@gmail.com



##############################################################################
#
# INSTALLATION
#
##############################################################################

In order to install the package run the following commands

> ./configure
> make
> make install

'make install' installs vicut to /usr/local/bin directory. If you want to change
the installation directory, rerun ./configure with the prefix option

> ./configure --prefix=/other/directory

and then run 'make' and 'make install'. This will install vicut in
/other/directory/bin



##############################################################################
#
# USAGE
#
##############################################################################

For help with usage type vicut --help

The output of 'vicut --help' contains several example based on the data sets in
the 'examples' directory.
examples/README file contains short descriptions of the example datasets.