= Installing the WARPnet Framework =

== Installing the software ==

 1. First ensure that you are running [http://www.python.org/ Python 2.6] or higher. If not, install the latest 2.6 version of Python. We have not tested the server with Python 3+ and since the syntax has changed for several important commands it will probably not work yet.
 1. Download and install the [http://twistedmatrix.com/trac/ Twisted networking library] from source. 
 1. Download and install [http://pypi.python.org/pypi/zope.interface#download Zope.interface] from source. The Twisted library depends on this.
 1. WARPnet uses PCAP to communicate with the WARP board directly. To allow the Python-based server/client to access PCAP, the Pcapy module needs to be installed. As WARPnet works with [http://oss.coresecurity.com/projects/pcapy.html Pcapy version 10.5] only, download this to your computer.
 1. Before installing Pcapy, it needs to be patched for some WARPnet specific functionality. Download patchFile.diff from the repository into the Pcapy folder and run the following.
{{{
 patch < patchFile.diff
 python setup.py install
}}}
 1. Download and install [http://oss.coresecurity.com/projects/impacket.html Impacket] from source. This package helps in analyzing raw Ethernet packets. Again, to install run the following from the Impacket folder.
{{{
 python setup.py install
}}}

== Installing the Framework ==

The WARPnet Framework is a standalone module that works just like any Python module. However, for now it is not installed into `site-packages` but added to the Python path on a per shell basis.

 1. Download the WARPnet Framework folder and store it anywhere on your computer. Note the absolute path to it as it will be important later.
 1. Download `warpnet_client_experiment_structs.py` and `experiment.py`. These are an example definitions file and example script that work with OFDM Reference Design v15.

=== Running the server ===

Running the server is explained in more detail [wiki:WARPnet/RunningServer here].

=== Setting up a shell for the Client ===

 1. Navigate to the `warpnet_framework` folder.
 1. Run the following. This will add the Framework to the Python path.
{{{
 source path_setup.sh absolutePathToFramework
}}}
 1. Now, browse to your experiment.py. To run your experiment type:
{{{
 python experiment.py
}}}