-------------------------
Priya Mahadevan

Please read the instructions below before
you run the script
-------------------------


The input file should list all the edges in the graph, only 1 edge should
be reported on each line.
An example input file named 'sample_input' is part of this source release.


To compute various topology related metrics for your input graph,
================================================================

1. Ensure that perl and gnuplot are installed on your machine. 
   The script is a bash script, make sure your shell is bash.

2. Create a new directory where you would like the output files
to be generated. Its highly recommened to create a new directory, as
 the program outputs a lot of files.

3. Copy the metrics_source.tar.gz file to this newly created directory.

4. Unzip and untar the files using the gunzip and tar -xvf commands.

5. Copy the input file (it should have the same format as the 'sample_input' file)
   to this new directory.

6. Specify the input filename in the params file. (Replace "sample_input"
with the name of your input file name)

7. Run the doit_script from the command line
   ./doit_script


How to interpret the output files
=================================

1. Scalar metrics related to connectivity are written to a file
 called output. Sample metric values calculated include average node
 degree, assortativity coefficient, average neighbor connectivity, 
 mean clustering, clustering coefficient, etc.

2. The degree distribution PDF is in out.deg
   The degree distribution CCDF is in deg.ccdf

   The corresponding plots of degree PDF and degree CCDF are output to
   degree_distr.ps and ccdf_deg.ps

3. The average neighbor connectivity results are stored in out.nbr and 
   avg_nbr_conn.ps    
   
4. The clustering results are stored in out.clus and clus_coeff.ps
   
5. The rich club connectivity results are stored in rich_club and 
   rich_club.ps