ns-3 Manual

This is the ns-3 Manual. Primary documentation for the ns-3 project is organized as follows:

• Several guides that are version controlled for each release (the latest release) and development tree:

  • Tutorial

  • Installation Guide

  • Manual (this document)

  • Model Library

  • Contributing Guide

• ns-3 Doxygen: Documentation of the public APIs of the simulator

• ns-3 wiki

This document is written in reStructuredText for Sphinx and is maintained in the doc/manual directory of ns-3’s source code. Source file column width is 100 columns.

• 1. Organization
• 2. Simulator
  • 2.1. Events and Simulator
  • 2.2. Callbacks
  • 2.3. Object model
  • 2.4. Configuration and Attributes
  • 2.5. Object names
  • 2.6. RealTime
• 3. Additional Tools
  • 3.1. Random Variables
  • 3.2. Hash Functions
  • 3.3. Tracing
  • 3.4. Data Collection
  • 3.5. Statistical Framework
  • 3.6. Helpers
  • 3.7. Making Plots using the Gnuplot Class
  • 3.8. Using Python to Run ns-3
• 4. Developer Tools
  • 4.1. Working with Git as a user
  • 4.2. Working with Git as a maintainer
  • 4.3. Working with CMake
  • 4.4. Logging
  • 4.5. Tests
  • 4.6. Creating a new ns-3 model
  • 4.7. Adding a New Module to ns-3
  • 4.8. Creating Documentation
  • 4.9. Profiling
  • 4.10. Working with gitlab-ci-local
  • 4.11. Working with Docker
  • 4.12. Working with Cilicon
• 5. Utilities
  • 5.1. Print-introspected-doxygen
  • 5.2. bench-scheduler
• 6. Support
  • 6.1. Enabling Subsets of ns-3 Modules
  • 6.2. Enabling/disabling ns-3 Tests and Examples
  • 6.3. Troubleshooting