This ns-3 module is intended to make experimental simulation of networks a bit easier. It has a wrapper to take care of loading in run folder configurations (e.g., runtime, random seed), a topology abstraction, an additional routing abstraction called "arbiter routing", a heuristic TCP optimizer, and a few handy applications.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details (in ./LICENSE).

1. Install the following dependencies:

   • Python 3.7+
   • MPI:

     sudo apt-get install mpic++
     sudo apt-get install libopenmpi-dev
     

   • lcov: sudo apt-get install lcov

   Additionally, if you are going to make use of functionality beyond the C++ ns-3 module:

   • gnuplot (for plotting): sudo apt-get install gnuplot
   • numpy (for plotting): pip install numpy
   • statsmodels (for plotting): pip install statsmodels
   • exputilpy (for testing and plotting): pip install git+https://github.com/snkas/exputilpy.git

2. You need to add the basic-sim module into your own ns-3's contrib/ folder.

   Method 1: git clone

   cd /path/to/your/folder/of/ns-3/contrib
   git clone https://github.com/snkas/basic-sim.git
   

   Method 2: git submodule

   cd /path/to/your/folder/of/ns-3/contrib
   git submodule add https://github.com/snkas/basic-sim.git
   

   Method 3: download the zip of this git repository and extract it there.

3. Now you should be able to compile it along with all your other modules. It has been tested for ns-3 version 3.31.

Documentation (including tutorials) to get started is located in the doc/ folder. A good starting point is: doc/getting_started.md.

To perform the full range of testing of this module (Python 3.7+):

sudo apt-get update
sudo apt-get -y install mpic++
sudo apt-get -y install libopenmpi-dev
sudo apt-get -y install lcov
sudo apt-get -y install gnuplot
pip install numpy
pip install statsmodels
pip install git+https://github.com/snkas/exputilpy.git
cd build
bash build.sh
bash test.sh
bash tutorial.sh
bash example.sh

Refactored, extended and maintained by Simon.

Contributions were made by (former) students in the NDAL group who did a project or their thesis, among which: Hussain, Hanjing (list will continue to be updated).

The ECMP routing hashing function is inspired by https://github.com/mkheirkhah/ecmp (accessed: February 20th, 2020), though heavily modified.