View source for Install and run Aqua-Sim-NG code

== How-To build ns-3 + aqua-sim==

* download and unpack ns-3.27 source code:

<code>wget http://www.nsnam.org/release/ns-allinone-3.27.tar.bz2</code>

<code>tar xjf ns-allinone-3.27.tar.bz2</code>

'''Note:''' Aqua-Sim-NG has been tested with ns-3.27. The higher versions of ns-3 (i.e., 3.28, 3.29) might not be compilable with aqua-sim modules.

* get aqua-sim source code:

- move to ../src directory of ns-3:

<code>cd "ns-3_working_dir/ns-3.27/src/"</code>

- for multichannel MAC development:

<code>git clone https://github.com/dugdmitry/aqua-sim-ng.git</code>

- original version from main repository:

<code>git clone https://github.com/rmartin5/aqua-sim-ng.git</code>

* build ns-3 with aqua-sim source code:

- change to ns-3 working directory:

<code>cd "ns-3_working_dir/ns-3.27/</code>

- configure and build using "waf":

<code>./waf clean</code>

<code>./waf configure --build-profile=debug --enable-examples</code>

<code>./waf</code>


== How-To run examples ==

After building ns-3 + aqua-sim, simulation scripts can be run using <code>./waf --run 'script_name'</code> command.

The scripts are located in <code>/scratch</code> folder, and also in <code>examples</code> folders of the corresponding ns-3 models, located in <code>src/</code>.

E.g., the corresponding examples of aqua-sim models are located in <code>../src/aqua-sim-ng/examples/</code>


'''Note:''' Names of the scripts to execute may differ from the names of the corresponding .cc files.

For example, in order to run "../src/aqua-sim-ng/examples/multichannel_mac_example.cc" script, the following command should be executed:


<code>./waf --run ./waf --run MultichannelMacExample</code>

'script_source_name.cc' and corresponding 'script_name' mapping can be found in "../src/model_name/examples/wscript" file.


=== Running multichannel MAC example ===

<code>./waf --run "MultichannelMacExample --packetSize=50 --channelId=1 --RngRun=11"</code>

The command above will run a script for multichannel MAC example, with OnOffApplication's packet size of 50 Bytes,
on channel 1.

'RngRun' parameter defines a seed value of the pseudo-random generator during the script execution. Simulation results can be repeated using the same 'RngRun' value.