# README

## Requirements

`Python3.6` is expected for this program because currently the CPLEX solver being used expects that version of Python.

To install the non-CPLEX dependencies, use `pip install -r requirements.txt`.

To install CPLEX, visit the IBM website and navigate to the proper license (student, academic, professional, etc.), and follow the installation guide provided by IBM.

## Running Example Script

Once dependencies are enabled you should be able to run our example code using `python example.py`. The current example script runs on the `bank` dataset with k = 4, using k-means.

## Running your Own Tests

To run one of your own tests, edit the following three things:

1. Create an entry in `example_config.ini`. An entry begins with `[your_title]` and contains all the fields specified by the example.

2. Change the objective in `dataset_configs.ini` if you desire.

3. Run the example script using your specifications instead of example by running `python example.py your_title`.