ns-3 Tutorial

This is the ns-3 Tutorial. 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 (this document)

  • Installation Guide

  • Manual

  • 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/tutorial directory of ns-3’s source code. Source file column width is 100 columns.

• 1. Quick Start
  • 1.1. Brief Summary
  • 1.2. Prerequisites
  • 1.3. Downloading ns-3
  • 1.4. Building and testing ns-3
• 2. Introduction
  • 2.1. About ns-3
  • 2.2. For ns-2 Users
  • 2.3. Contributing
  • 2.4. Tutorial Organization
• 3. Resources
  • 3.1. The Web
  • 3.2. Git
  • 3.3. CMake
  • 3.4. Development Environment
  • 3.5. Socket Programming
• 4. Getting Started
  • 4.1. Overview
  • 4.2. Prerequisites
  • 4.3. Downloading ns-3 using Git
  • 4.4. Building ns-3
  • 4.5. Testing ns-3
  • 4.6. Running a Script
• 5. Conceptual Overview
  • 5.1. Key Abstractions
  • 5.2. A First ns-3 Script
  • 5.3. Ns-3 Source Code
• 6. Tweaking
  • 6.1. Using the Logging Module
  • 6.2. Using Command Line Arguments
  • 6.3. Using the Tracing System
• 7. Building Topologies
  • 7.1. Building a Bus Network Topology
  • 7.2. Models, Attributes and Reality
  • 7.3. Building a Wireless Network Topology
  • 7.4. Queues in ns-3
• 8. Tracing
  • 8.1. Background
  • 8.2. Overview
  • 8.3. Real Example
  • 8.4. Trace Helpers
  • 8.5. Summary
• 9. Data Collection
  • 9.1. Motivation
  • 9.2. Example Code
  • 9.3. GnuplotHelper
  • 9.4. Supported Trace Types
  • 9.5. FileHelper
  • 9.6. Summary
• 10. Conclusion
  • 10.1. Futures
  • 10.2. Closing