.. only:: html or latex

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

This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is organized as
follows:

* Several guides that are version controlled for each release (the
  `latest release <https://www.nsnam.org/documentation/latest/>`_) and
  `development tree <https://www.nsnam.org/ns-3-dev/documentation/>`_:

  * Tutorial
  * Installation Guide
  * Manual
  * Model Library *(this document)*
  * Contributing Guide
* `ns-3 Doxygen <https://www.nsnam.org/docs/doxygen/index.html>`_: Documentation of the public APIs of
  the simulator
* `ns-3 wiki <https://www.nsnam.org/wiki/Main_Page>`_

This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <https://www.sphinx-doc.org/>`_ and is maintained in the
``doc/models`` directory of ns-3's source code (and much of the source content is also pulled
from the ``doc/`` directory of each module.  Source file column width is 100 columns.

.. toctree::
   :maxdepth: 1

   organization
   animation
   antenna
   aodv
   applications
   bridge
   brite
   buildings
   click
   csma
   dsdv
   dsr
   emulation-overview
   energy
   flow-monitor
   internet-models
   internet-apps
   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
