blob: 7730b0151b38365648219aa30e2791b55a903777 [file] [log] [blame]
Alexander Afanasyevf34fe562013-08-09 17:16:12 -07001{% extends "layout.html" %}
2{% set title = _('ndnSIM documentation') %}
3
4{% block body %}
5 <h1>{{ docstitle|e }}</h1>
6 <p>
7The ndnSIM is NS-3 module that implements Named Data Networking (NDN) communication model, the clean slate Internet design. ndnSIM is specially optimized for simulation purposes and has a cleaner and more extensible internal structure comparing to the existing NDN implementation (NDNx).
8 </p>
9
10 <p>
11We invite you to <a href="http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim" target="_blank">join our mailing list</a> to see and participate in discussions about ndnSIM implementation and simulations in general (<a href="http://www.lists.cs.ucla.edu/pipermail/ndnsim/" target="_blank">mailing list archives</a>).
12 </p>
13
14 {% block tables %}
15 <p><strong>Parts of the documentation:</strong></p>
16 <table class="contentstable" align="center"><tr>
17 <td width="50%" valign="top">
18 <p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}">ndnSIM tutorial</a><br/>
19 <div class="linkdescr" style="margin-left: 20px">
20 <p class="biglink"><a class="biglink" href="{{ pathto("intro") }}">Introduction</a><br/>
21 <span class="linkdescr">what is ndnSIM, how to get support, and what is in the package</span></p>
22 <p class="biglink"><a class="biglink" href="{{ pathto("getting-started") }}">Getting started</a><br/>
23 <span class="linkdescr">portability, requirements, downloading, compiling, simulating</span></p>
24 <p class="biglink"><a class="biglink" href="{{ pathto("helpers") }}">ndnSIM helpers</a><br/>
25 <span class="linkdescr">very important components of ndnSIM for writing simulation scenarios</span></p>
26 <p class="biglink"><a class="biglink" href="{{ pathto("cs") }}">Content Store</a><br/>
27 <span class="linkdescr">several different build-in content store implementations: LRU, LFU, and others</span></p>
28 <p class="biglink"><a class="biglink" href="{{ pathto("fw") }}">Forwarding Strategies</a><br/>
29 <span class="linkdescr">experimenting with differnet build-in and custom Interest/Data forwarding strategies</span></p>
30 <p class="biglink"><a class="biglink" href="{{ pathto("applications") }}">ndnSIM applications</a><br/>
31 <span class="linkdescr">reference applications for network-leverl evaluations</span></p>
32 <p class="biglink"><a class="biglink" href="{{ pathto("metric") }}">Obtaining metrics</a><br/>
33 <span class="linkdescr">obtaining and visualizing metrics from simulation runs</span></p>
34 </div>
35 </p>
36 <p class="biglink"><a class="biglink" href="{{ pathto("examples") }}">Simulation examples</a><br/>
37 <span class="linkdescr">basic tutorial examples</span></p>
38
39 </td>
40 <td width="50%" valign="top">
41 <p class="biglink"><a class="biglink" href="doxygen/annotated.html">ndnSIM API documentation</a><br/>
42 <span class="linkdescr">doxygen-generated API documentation</span></p>
43 <p class="biglink"><a class="biglink" href="{{ pathto("faq") }}">FAQs</a><br/>
44 <span class="linkdescr">frequently asked questions (with answers!)</span></p>
45 <p class="biglink"><a class="biglink" href="{{ pathto("faq") }}">ndnSIM packet format</a><br/>
46 <span class="linkdescr">definition of the optimized default packet format</span></p>
47 <p class="biglink"><a class="biglink" href="{{ pathto("ndnsim-research-papers") }}">ndnSIM research papers</a><br/>
48 <span class="linkdescr">list of ndnSIM-related papers</span></p>
49 </td></tr>
50 </table>
51
52 <p><strong>Meta information:</strong></p>
53 <table class="contentstable" align="center"><tr>
54 <td width="50%" valign="top">
55 <p class="biglink"><a class="biglink" href="{{ pathto("meta/bugs") }}">Reporting bugs</a></p>
56 <p class="biglink"><a class="biglink" href="{{ pathto("meta/about") }}">About the documentation</a></p>
57 </td><td width="50%" valign="top">
58 <p class="biglink"><a class="biglink" href="{{ pathto("meta/license") }}">ndnSIM license</a></p>
59 <p class="biglink"><a class="biglink" href="{{ pathto("meta/copyright") }}">Copyright</a></p>
60 </td></tr>
61 </table>
62 {% endblock %}
63
64 <p>
65<hr class="docutils" />
66<dl class="docutils">
67<dt>If you refer to ndnSIM in a published work, please cite the following paper, not just the ndnSIM website. Thank you!</dt>
68<dd><strong>A. Afanasyev, I. Moiseenko, and L. Zhang, &#8220;ndnSIM: NDN simulator for NS-3,&#8221; NDN, Technical Report NDN-0005, 2012</strong> (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367">BibTex</a>)</dd>
69</dl>
70 </p>
71
72{% endblock %}