Overview

== NetVisMonkey ==

This README documents the process of setting up, installing, and running 
NetVisMonkey (hereafter, NVM).

== Requirements ==

NVM has several dependencies which must be met in order to run. It may be the 
case that some of these dependencies are "soft", meaning that it may be 
possible to run without, or with some substitute, but NVM has not been tested 
or designed to run under those assumptions.

Here is the list of basic assumptions made by NVM:

 - Windows 7
 	- While we have made attempts to ensure that NVM will run on multiple 
 		platforms, we have not tested it under any except Windows 7.
 		
 - Python 2.6
 	- http://python.org/download/
 	
 - VPython 5.2
 	http://vpython.org/contents/download_windows.html
 	
 - Scapy 2.1.0
 	- Scapy is not developed with Windows use in mind, but does seem to work,
 		with some effort. The following instructions are based off of those 
 		found in the Scapy documentation at:
 	
 		 http://www.secdev.org/projects/scapy/doc/installation.html#windows
 		 
		Install Scapy: 
			Install from the mercurial repository:
				hg clone http://hg.secdev.org/scapy/rev/62d7ebd04e57 scapy_2.1.0
				
				(The url above is for the 2.1.0 tag. A full list of scapy tagged
				versions is available at http://hg.secdev.org/scapy/tags.)
				
				From within the scapy_2.1.0 directory, run "python setup.py install"
				
		Scapy also has several dependencies of it's own. Install each of the following
		by downloading and running the appropriate executable:
		
			pywin32: http://downloads.sourceforge.net/project/pywin32/pywin32/Build%20214/pywin32-214.win32-py2.6.exe
			
			WinPcap: 
				http://www.winpcap.org/install/bin/WinPcap_4_1_1.exe
					or alternatively, Wireshark, which includes WinPCap:
				http://www.wireshark.org/
			
			pypcap: http://www.secdev.org/projects/scapy/files/pcap-1.1-scapy-20090720.win32-py2.6.exe 
				This is a special version for Scapy, as the original leads to 
				some timing problems. Now works on Vista and Windows 7, too. 
				Under Vista/Win7 please	right-click on the installer and choose
				 �Run as administrator�.
				 
			libdnet: http://www.secdev.org/projects/scapy/files/dnet-1.12.win32-py2.6.exe
				Under Vista/Win7 please right-click on the installer and choose 
				�Run as administrator�.
			
			pyreadline: http://ipython.scipy.org/dist/pyreadline-1.5-win32-setup.exe

			
== Installation == 

NVM does not currently support any concept of "installation". The appropriate 
scripts are just run in place. The "trickiest" bit is ensuring that your
PYTHONPATH environment variable is set appropriately. In this case, NVM requires
that the 'src' directory (netvismonkey/src) be on the PYTHONPATH.

	> cd netvismonkey
	> set PYTHONPATH=src
	
== Running NetVisMonkey ==

NVM provides two primary "component-services": the Visualizer and the Collector.
The Visualizer is responsible for most user interactions, while the Collector is
responsible for collecting, parsing, and aggeregating data from the network.

TODO: Describe running the service in detail.