doc/models/source/index.rst
author Tom Henderson <tomh@tomh.org>
Tue, 24 May 2011 20:54:20 -0700
changeset 7266 bc99ae52b396
parent 7265 e74cc5da55e8
child 7276 c360ed25ae69
permissions -rw-r--r--
Move aodv module description out of doxygen
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
.. only:: html or latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
ns-3 Model Library
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
==================
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
7205
3e06e337b394 merge testing manual with regular manual
Tom Henderson <tomh@tomh.org>
parents: 7204
diff changeset
     6
This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is 
3e06e337b394 merge testing manual with regular manual
Tom Henderson <tomh@tomh.org>
parents: 7204
diff changeset
     7
available in five forms:
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     9
* `ns-3 Doxygen <http://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
* `Tutorial <http://www.nsnam.org/tutorials.html>`_
7205
3e06e337b394 merge testing manual with regular manual
Tom Henderson <tomh@tomh.org>
parents: 7204
diff changeset
    11
* `Manual <http://www.nsnam.org/tutorials.html>`_
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    12
* `Model Library <http://www.nsnam.org/tutorials.html>`_: *(this document)*
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
* `ns-3 wiki <http://www.nsnam.org/wiki/index.php/Main_Page>`_ 
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    16
``doc/models`` directory of ns-3's source code.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
.. toctree::
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
   :maxdepth: 2
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
   organization
7263
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    22
   animation
7266
bc99ae52b396 Move aodv module description out of doxygen
Tom Henderson <tomh@tomh.org>
parents: 7265
diff changeset
    23
   aodv
7263
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    24
   applications
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    25
   bridge
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    26
   click
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    27
   csma
7265
e74cc5da55e8 Move dsdv module description out of doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7263
diff changeset
    28
   dsdv
7263
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    29
   emulation-overview
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
   energy
7263
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    31
   flow-monitor
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
   internet-models
7263
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    33
   lte
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    34
   mesh
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    35
   distributed
7263
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    36
   network
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    37
   openflow-switch
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    38
   point-to-point
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    39
   propagation
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    40
   simple
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    41
   statistics
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    42
   uan
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    43
   wifi
7ebd56e409cf Order model library document by module and make visualizer show up in doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7205
diff changeset
    44
   wimax