doc/models/source/index.rst

.. only:: html or latex

ns-3 Model Library
==================

This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is 
available in five forms:

* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
* Tutorial, Manual, and Model Library *(this document)* for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
* `ns-3 wiki <https://www.nsnam.org/wiki>`_ 

This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the
``doc/models`` directory of ns-3's source code.

.. toctree::
   :maxdepth: 1

   organization
   animation
   antenna
   aodv
   applications
   bridge
   brite
   buildings
   click
   csma
   dsdv
   dsr
   emulation-overview
   energy
   flow-monitor
   internet-models
   lr-wpan
   lte
   mesh
   distributed
   mobility
   network
   nix-vector-routing
   olsr
   openflow-switch
   point-to-point
   propagation
   spectrum
   sixlowpan
   topology
   traffic-control
   uan
   wave
   wifi
   wimax
split manual; create model library 2011-05-13 23:10:33 -07:00			`.. only:: html or latex`

			`ns-3 Model Library`
			`==================`

merge testing manual with regular manual 2011-05-13 23:21:38 -07:00			`This is the ns-3 Model Library documentation. Primary documentation for the ns-3 project is`
			`available in five forms:`
split manual; create model library 2011-05-13 23:10:33 -07:00
documentation: Align other configuration files with commit 06865c73 2019-11-06 13:16:23 -08:00			* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
			* Tutorial, Manual, and Model Library (this document) for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
			* `ns-3 wiki <https://www.nsnam.org/wiki>`_
split manual; create model library 2011-05-13 23:10:33 -07:00
			This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the
			``doc/models`` directory of ns-3's source code.

			`.. toctree::`
Manual chapter on documentation. 2013-12-11 15:18:55 -08:00			`:maxdepth: 1`
split manual; create model library 2011-05-13 23:10:33 -07:00
			`organization`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`animation`
integrated antenna docs in models library docs 2012-04-11 11:38:40 +02:00			`antenna`
Move aodv module description out of doxygen 2011-05-24 20:54:20 -07:00			`aodv`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`applications`
			`bridge`
include BRITE documentation in the build 2012-12-06 08:45:57 -08:00			`brite`
buildings doc can now be built standalone and within models library doc 2011-10-26 18:53:54 +02:00			`buildings`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`click`
			`csma`
Move dsdv module description out of doxygen 2011-05-24 18:47:02 -07:00			`dsdv`
Add IPv4 DSR routing 2012-01-27 15:15:48 -08:00			`dsr`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`emulation-overview`
split manual; create model library 2011-05-13 23:10:33 -07:00			`energy`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`flow-monitor`
split manual; create model library 2011-05-13 23:10:33 -07:00			`internet-models`
fix lr-wpan documentation build 2014-04-30 13:40:07 -07:00			`lr-wpan`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`lte`
			`mesh`
split manual; create model library 2011-05-13 23:10:33 -07:00			`distributed`
start some mobility documentation 2012-05-04 16:16:41 -07:00			`mobility`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`network`
Routing sphynx documentation upgrades 2017-05-28 22:22:41 +02:00			`nix-vector-routing`
Move uan module description out of doxygen 2011-05-25 00:12:59 -07:00			`olsr`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`openflow-switch`
			`point-to-point`
			`propagation`
Remove extra ':'s 2013-11-14 16:57:49 -08:00			`spectrum`
Fix sixlowpan module documentation (thanks Peter) 2013-12-12 09:12:36 +01:00			`sixlowpan`
Topology reader docs fixings 2011-11-06 17:46:16 +01:00			`topology`
traffic-control: Add the traffic control layer 2016-03-08 10:43:16 -08:00			`traffic-control`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`uan`
base implementation of the IEEE 802.11p standard 2013-12-03 11:25:59 -08:00			`wave`
Order model library document by module and make visualizer show up in doxygen 2011-05-24 14:27:52 -07:00			`wifi`
			`wimax`