18 July 2015

Passive Optical Network (PON) in NS3

This post will tell you how to install and work with Passive Optical Network Simulation under NS3.  I request the readers to not to ask any help related to the working of this PON (Passive Optical Network) as I was helping one of my friend in compiling this tool. and I dont know anything about optical networks.

Version: ns-allinone-3.19
PON: xgpon
OS: ubuntu 14.04.2 and Linux Mint 17.2

Download ns-allinone-3.19 from here
Download XGPON from here

Installation of NS3

To install ns3, perform the following steps.
1. Open the terminal
2. Execute the following commands one by one
pradeep@localhost $] sudo apt-get update
pradeep@localhost $]sudo apt-get install build-essential autoconf automake libxmu-dev python-pygoocanvas python-pygraphviz cvs mercurial bzr git cmake NetAnim p7zip-full python-matplotlib python-tk

Unzip the ns-allinone-3.19.tar.bz2 in the home folder (/home/pradeepkumar)

pradeep@localhost $] tar jzvf ns-allinone-3.19.tar.bz2
pradeep@localhost $] cd ns-allinone-3.19/

Now extract the xgpon software in this location 
/home/pradeepkumar/ns-allinone-3.19/ns-3.19/src. You can see the screenshot given below (the selected folder is xgpon, when you download the xgpon software, the folder name may be anything, but rename it is xgpon as shown in the following figure)
XGPON
Ns3-xgpon
Once the copying is done, go to the ~ns-allinone-3.19/ folder and execute the following command to compile ns3

Important Instructions
There are two important things to be done before you go for compiling ns3. 
 
There is a file which have to be copied to the ns3 folder from the xgpon folder. 
ipv4-l3-protocol.cc file from xgpon (/home/pradeepkumar/ns-allinone-3.19/ns-3.19/src/xgpon/changesOnOtherModules/src/internet/model) have to be copied to (/home/pradeepkumar/ns-allinone-3.19/ns-3.19/src/internet/model).  This is to run a huge simulation called Giant

A Path related to your ns3 installation have to be set. In linux mint, the path has to be set in the .profile file and in Ubuntu it has to be set in the .bashrc file. (here is the NS3 variable which is set as given below, either you can copy the entire line in to the .profile file or you can paste the following line in the terminal)

export NS3=/home/pradeepkumar/ns-allinone-3.19/ns-3.19/

Compiling NS3

pradeep@localhost $] ./build.py --enable-examples --enable-tests

This will take a few minutes to build all the software packages, finally you will get a screenshot like this (the highlighted information shows that the xgpon software is built)
pon
XGPON
After the installation of NS3 is over, the examples of xgpon can be run using the following command. 

There are some examples given in (/home/pradeepkumar/ns-allinone-3.19/ns-3.19/src/xgpon/scripts4evaluation/), the contents of this folder have to be pasted at ~ns-allinone-3.19/ns-3.19/. To run the example, here is the command 
pradeep@localhost $] cd ns-allinone-3.19/ns-3.19/
pradeep@localhost $] ./waf --pyrun pedro/pargiantscript.py
You will finally get the waveforms printed like the following pics
XGPON
XGPON

XGPON
XGPON
 
 The above simulation runs are almost more than 2 hours to get the waveform plotted. In the recent versions of ns3, it is faster, but I failed to install it on a ns-3.23 version. 

If any user is successful in getting the simulation, let me know through the comment section 
 
T S Pradeep Kumar