AutoTabGrouping Files

This file contains information about the files in this project.

There are 2 files in this project:
1. Daemon.py         ---> It is the daemon that divides creates the clustered graph
2. browsingdata.xpi  ---> The plugin that extracts the features from each tab and keeps track of various events.
                          It has some limitations for now.

1. Daemon.py
This file is written in Python. Python 2.7 or greater would be required to run this script properly.

1.1. Python Installation:

1.1.1. On Windows:
You have to download the latest Windows(TM) installer from the python site http://python.org/getit/. Install it just as any other Windows software. 

1.1.2. On GNU/Linux Distributions:
Generally all GNU/Linux distributions come with Python, so no need to worry about that :) If you don't have it then you can install it by either downloading from the python website or from your distribution's repository.

For Fedora
# yum install python

For Debian
# apt-get install python

1.2. Required Modules to be Installed:
  * igraph
  * AlchemyAPI
  * pyinotify

1.2.1. igraph installation:

  * On GNU/Linux: http://igraph.wikidot.com/installing-python-igraph-on-linux
  * On Windows and Mac OS X: You can read about installing python-igraph on Windows and MacOS here: http://www.cs.rhul.ac.uk/home/tamas/development/igraph/tutorial/install.html

1.2.2. AlchemyAPI installation:
The Python (2.x) SDK for AlchemyAPI can be downloaded from here: http://www.alchemyapi.com/tools/
The downloaded file AlchemyAPI_Python-0.7.tar.gz should be extracted. Installation instructions are present in the README file.

1.2.3 pyinotify installation:
The Pyinotify package can be downloaded from https://github.com/seb-m/pyinotify.

2. browsingdata.xpi
This the firefox plugin that extracts the features from each tab and keeps track of various events.
It has limitations for now w.r.t. to finding out the parent tab of a tab. The tester of this code using this plugin must therefore follow some execution guidelines which are stated below in the section "Guidelines for correct testing"

To install this plugin:
Open Mozilla Firefox and press Ctrl-O. Select the plugin file and then subsequently install the plugin.

Using this plugin:
The plugin can either be enabled or disabled using the icon/button on the lower right corner of your browser window.
When disabled the browsing session is not left untracked.

3. Guidelines for correct testing

* If an hyperlink in Tab-A is needed to be opened, open the hyperlink in a new tab(Tab-B).
* DO NOT change between tabs unless and until Tab-B loads fully. If you change to Tab-C before Tab-B is loaded fully then Tab-C could be considered the parent of Tab-B incorrectly.
* Delete all files in the directory called BrowsingFootmarks after every browsing session, where all the files generated by the firefox plugin are stored.
* Do the same (deleting files from BrowsingFootmarks directory) everytime you test the code.(Sorry about the inconvenience but it will be like this for now)