|
| 1 | + |
| 2 | +# The Network Simulator, Version 3 |
| 3 | + |
| 4 | +[](http://hits.dwyl.io/aqm-eval-suite/ns-3-dev-git) |
| 5 | +[](https://travis-ci.com/aqm-eval-suite/ns-3-dev-git) |
| 6 | + |
| 7 | +## Table of Contents: |
| 8 | + |
| 9 | +1) An overview |
| 10 | +2) Building ns-3 |
| 11 | +3) Running ns-3 |
| 12 | +4) Getting access to the ns-3 documentation |
| 13 | +5) Working with the development version of ns-3 |
| 14 | + |
| 15 | +Note: Much more substantial information about ns-3 can be found at |
| 16 | +http://www.nsnam.org |
| 17 | + |
| 18 | +### 1) An Open Source project |
| 19 | + |
| 20 | +ns-3 is a free open source project aiming to build a discrete-event |
| 21 | +network simulator targeted for simulation research and education. |
| 22 | +This is a collaborative project; we hope that |
| 23 | +the missing pieces of the models we have not yet implemented |
| 24 | +will be contributed by the community in an open collaboration |
| 25 | +process. |
| 26 | + |
| 27 | +The process of contributing to the ns-3 project varies with |
| 28 | +the people involved, the amount of time they can invest |
| 29 | +and the type of model they want to work on, but the current |
| 30 | +process that the project tries to follow is described here: |
| 31 | +http://www.nsnam.org/developers/contributing-code/ |
| 32 | + |
| 33 | +This README excerpts some details from a more extensive |
| 34 | +tutorial that is maintained at: |
| 35 | +http://www.nsnam.org/documentation/latest/ |
| 36 | + |
| 37 | +### 2) Building ns-3 |
| 38 | + |
| 39 | +The code for the framework and the default models provided |
| 40 | +by ns-3 is built as a set of libraries. User simulations |
| 41 | +are expected to be written as simple programs that make |
| 42 | +use of these ns-3 libraries. |
| 43 | + |
| 44 | +To build the set of default libraries and the example |
| 45 | +programs included in this package, you need to use the |
| 46 | +tool 'waf'. Detailed information on how to use waf is |
| 47 | +included in the file doc/build.txt |
| 48 | + |
| 49 | +However, the real quick and dirty way to get started is to |
| 50 | +type the command |
| 51 | + ./waf configure --enable-examples |
| 52 | +followed by |
| 53 | + ./waf |
| 54 | +in the directory which contains |
| 55 | +this README file. The files built will be copied in the |
| 56 | +build/ directory. |
| 57 | + |
| 58 | +The current codebase is expected to build and run on the |
| 59 | +set of platforms listed in the RELEASE_NOTES file. |
| 60 | + |
| 61 | +Other platforms may or may not work: we welcome patches to |
| 62 | +improve the portability of the code to these other platforms. |
| 63 | + |
| 64 | +### 3) Running ns-3 |
| 65 | + |
| 66 | +On recent Linux systems, once you have built ns-3 (with examples |
| 67 | +enabled), it should be easy to run the sample programs with the |
| 68 | +following command, such as: |
| 69 | + |
| 70 | + ./waf --run simple-global-routing |
| 71 | + |
| 72 | +That program should generate a simple-global-routing.tr text |
| 73 | +trace file and a set of simple-global-routing-xx-xx.pcap binary |
| 74 | +pcap trace files, which can be read by tcpdump -tt -r filename.pcap |
| 75 | +The program source can be found in the examples/routing directory. |
| 76 | + |
| 77 | +### 4) Getting access to the ns-3 documentation |
| 78 | + |
| 79 | +Once you have verified that your build of ns-3 works by running |
| 80 | +the simple-point-to-point example as outlined in 3) above, it is |
| 81 | +quite likely that you will want to get started on reading |
| 82 | +some ns-3 documentation. |
| 83 | + |
| 84 | +All of that documentation should always be available from |
| 85 | +the ns-3 website: http:://www.nsnam.org/documentation/. |
| 86 | + |
| 87 | +This documentation includes: |
| 88 | + |
| 89 | + - a tutorial |
| 90 | + |
| 91 | + - a reference manual |
| 92 | + |
| 93 | + - models in the ns-3 model library |
| 94 | + |
| 95 | + - a wiki for user-contributed tips: http://www.nsnam.org/wiki/ |
| 96 | + |
| 97 | + - API documentation generated using doxygen: this is |
| 98 | + a reference manual, most likely not very well suited |
| 99 | + as introductory text: |
| 100 | + http://www.nsnam.org/doxygen/index.html |
| 101 | + |
| 102 | +### 5) Working with the development version of ns-3 |
| 103 | + |
| 104 | +If you want to download and use the development version |
| 105 | +of ns-3, you need to use the tool 'mercurial'. A quick and |
| 106 | +dirty cheat sheet is included in doc/mercurial.txt but |
| 107 | +reading through the mercurial tutorials included on the |
| 108 | +mercurial website is usually a good idea if you are not |
| 109 | +familiar with it. |
| 110 | + |
| 111 | +If you have successfully installed mercurial, you can get |
| 112 | +a copy of the development version with the following command: |
| 113 | +"hg clone http://code.nsnam.org/ns-3-dev" |
0 commit comments