blob: 72634b2f21c21cf0c177260c5aea5346ad98c1ca [file] [log] [blame]
Alexander Afanasyevf34fe562013-08-09 17:16:12 -07001{% extends "layout.html" %}
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002{% set title = _('ndnSIM 2.0 documentation') %}
Alexander Afanasyevf34fe562013-08-09 17:16:12 -07003
4{% block body %}
5 <h1>{{ docstitle|e }}</h1>
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08006
7<p>ndnSIM 2.0 is a new release of <a class="reference external" href="http://ndnsim.net/1.0/">NS-3 based Named Data Networking (NDN) simulator</a> that went through extensive refactoring and rewriting. The key new features of the new version:</p>
8
9<ul class="simple">
10<li>ndnSIM no longer re-implements basic NDN primitives and directly uses implementation from <a class="reference external" href="http://named-data.net/doc/ndn-cxx/">ndn-cxx library (NDN C++ library with eXperimental eXtensions)</a>.</li>
11<li>All NDN forwarding and management is implemented directly using source code of <a class="reference external" href="http://named-data.net/doc/NFD/">Named
12Data Networking Forwarding Daemon (NFD)</a></li>
Alexander Afanasyev963621b2015-01-11 18:34:33 -080013<li>Packet format changed to the <a class="reference external" href="http://named-data.net/doc/ndn-tlv/">NDN packet format</a></li>
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080014</ul>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070015
16 <p>
17We 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>).
18 </p>
19
20 {% block tables %}
21 <p><strong>Parts of the documentation:</strong></p>
22 <table class="contentstable" align="center"><tr>
23 <td width="50%" valign="top">
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080024 <p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}">ndnSIM 2.0 tutorial</a><br/>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070025 <div class="linkdescr" style="margin-left: 20px">
26 <p class="biglink"><a class="biglink" href="{{ pathto("intro") }}">Introduction</a><br/>
27 <span class="linkdescr">what is ndnSIM, how to get support, and what is in the package</span></p>
28 <p class="biglink"><a class="biglink" href="{{ pathto("getting-started") }}">Getting started</a><br/>
29 <span class="linkdescr">portability, requirements, downloading, compiling, simulating</span></p>
30 <p class="biglink"><a class="biglink" href="{{ pathto("helpers") }}">ndnSIM helpers</a><br/>
31 <span class="linkdescr">very important components of ndnSIM for writing simulation scenarios</span></p>
32 <p class="biglink"><a class="biglink" href="{{ pathto("cs") }}">Content Store</a><br/>
33 <span class="linkdescr">several different build-in content store implementations: LRU, LFU, and others</span></p>
34 <p class="biglink"><a class="biglink" href="{{ pathto("fw") }}">Forwarding Strategies</a><br/>
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080035 <span class="linkdescr">experimenting with different build-in and custom Interest/Data forwarding strategies</span></p>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070036 <p class="biglink"><a class="biglink" href="{{ pathto("applications") }}">ndnSIM applications</a><br/>
37 <span class="linkdescr">reference applications for network-leverl evaluations</span></p>
38 <p class="biglink"><a class="biglink" href="{{ pathto("metric") }}">Obtaining metrics</a><br/>
39 <span class="linkdescr">obtaining and visualizing metrics from simulation runs</span></p>
40 </div>
41 </p>
42 <p class="biglink"><a class="biglink" href="{{ pathto("examples") }}">Simulation examples</a><br/>
43 <span class="linkdescr">basic tutorial examples</span></p>
44
45 </td>
46 <td width="50%" valign="top">
47 <p class="biglink"><a class="biglink" href="doxygen/annotated.html">ndnSIM API documentation</a><br/>
48 <span class="linkdescr">doxygen-generated API documentation</span></p>
49 <p class="biglink"><a class="biglink" href="{{ pathto("faq") }}">FAQs</a><br/>
50 <span class="linkdescr">frequently asked questions (with answers!)</span></p>
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080051 <p class="biglink"><a class="biglink" href="{{ pathto("parallel-simulations") }}">How to use OpenMPI</a><br/>
52 <span class="linkdescr">speeding up simulations by using OpenMPI for parallel execution of scenarios</span></p>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070053 <p class="biglink"><a class="biglink" href="{{ pathto("ndnsim-research-papers") }}">ndnSIM research papers</a><br/>
54 <span class="linkdescr">list of ndnSIM-related papers</span></p>
55 </td></tr>
56 </table>
57
58 <p><strong>Meta information:</strong></p>
59 <table class="contentstable" align="center"><tr>
60 <td width="50%" valign="top">
Alexander Afanasyevab933c62015-01-14 00:50:31 -050061 <p class="biglink"><a class="biglink" href="{{ pathto("RELEASE_NOTES") }}">Release Notes</a></p>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070062 <p class="biglink"><a class="biglink" href="{{ pathto("meta/bugs") }}">Reporting bugs</a></p>
63 <p class="biglink"><a class="biglink" href="{{ pathto("meta/about") }}">About the documentation</a></p>
64 </td><td width="50%" valign="top">
65 <p class="biglink"><a class="biglink" href="{{ pathto("meta/license") }}">ndnSIM license</a></p>
66 <p class="biglink"><a class="biglink" href="{{ pathto("meta/copyright") }}">Copyright</a></p>
67 </td></tr>
68 </table>
69 {% endblock %}
70
71 <p>
72<hr class="docutils" />
73<dl class="docutils">
Spyridon Mastorakisffe25862015-02-03 16:21:28 -080074<dt>If you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!</dt>
75<dd><strong>S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, &#8220;ndnSIM 2.0: A new version of the NDN simulator for NS-3,&#8221; NDN, Technical Report NDN-0028, 2015</strong> (<a class="reference external" href="http://named-data.net/techreport/ndn-0028-1-ndnsim-v2.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399">BibTex</a>)</dd>
76<dd><strong>A. Afanasyev, I. Moiseenko, and L. Zhang, &#8220;ndnSIM:
77 NDN simulator for NS-3,&#8221; NDN, Technical Report NDN-0005, 2012</strong> (<a class="reference external" href="http://named-data.net/wp-content/uploads/TRndnsim.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367">BibTex</a>)</dd>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070078</dl>
79 </p>
80
Alexander Afanasyev819eb772013-08-25 20:55:27 -070081{% endblock %}