blob: 0a9cfbb911521649b6b219129c08aa6f7f05d529 [file] [log] [blame]
Alexander Afanasyevf34fe562013-08-09 17:16:12 -07001{% extends "layout.html" %}
Alexander Afanasyev5dee3612015-08-25 16:09:04 -07002{% set title = _('ndnSIM 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
Alexander Afanasyevf34fe562013-08-09 17:16:12 -07007 <p>
8We 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>).
9 </p>
10
11 {% block tables %}
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070012 <!-- <p><strong>Parts of the documentation:</strong></p> -->
13 <table class="contentstable" align="center">
14 <tr>
15 <td width="50%" valign="top">
16 <h2>Getting Started</h2>
17 <div class="tile">
18 <p class="biglink"><a class="biglink" href="{{ pathto("intro") }}">Introduction</a><br/>
19 <span class="linkdescr">what is ndnSIM, how to get support, and what is in the package</span></p>
20 <p class="biglink"><a class="biglink" href="{{ pathto("getting-started") }}">Downloading and Compiling ndnSIM</a><br/>
21 <span class="linkdescr">requirements, downloading, compiling, simulating</span></p>
22 <p class="biglink"><a class="biglink" href="{{ pathto("faq") }}">FAQs</a><br/>
23 <span class="linkdescr">frequently asked questions (with answers!)</span></p>
24 <p class="biglink"><a class="biglink" href="{{ pathto("examples") }}">Simulation examples</a><br/>
25 <span class="linkdescr">basic tutorial examples</span></p>
26 </div>
27 </td>
28 <td width="50%" valign="top">
29 <h2>Advanced Topics</h2>
30 <div class="tile">
31 <p class="biglink"><a class="biglink" href="doxygen/annotated.html">ndnSIM API documentation</a><br/>
32 <span class="linkdescr">generated documentation of ndnSIM API</span></p>
33 <p class="biglink"><a class="biglink" href="{{ pathto("parallel-simulations") }}">Parallelize simulations using OpenMPI</a><br/>
34 <span class="linkdescr">how to use OpenMPI to parallelize execution of simulation scenarios</span></p>
35 <p class="biglink"><a class="biglink" href="{{ pathto("guide-to-simulate-real-apps") }}">Simulating real applications</a><br/>
36 <span class="linkdescr">guide on how to simulate real application that are written against ndn-cxx library</span></p>
37 </div>
38 </td>
39 </tr>
40 <tr>
41 <td width="50%" valign="top">
42 <h2>ndnSIM tutorial</h2>
43 <div class="tile">
44 <p class="biglink"><a class="biglink" href="{{ pathto("helpers") }}">ndnSIM helpers</a><br/>
45 <span class="linkdescr">very important components of ndnSIM for writing simulation scenarios</span></p>
46 <p class="biglink"><a class="biglink" href="{{ pathto("cs") }}">Content Store</a><br/>
47 <span class="linkdescr">several different build-in content store implementations: LRU, LFU, and others</span></p>
48 <p class="biglink"><a class="biglink" href="{{ pathto("fw") }}">Forwarding Strategies</a><br/>
49 <span class="linkdescr">experimenting with different build-in and custom Interest/Data forwarding strategies</span></p>
50 <p class="biglink"><a class="biglink" href="{{ pathto("applications") }}">ndnSIM applications</a><br/>
51 <span class="linkdescr">reference applications for network-leverl evaluations</span></p>
52 <p class="biglink"><a class="biglink" href="{{ pathto("metric") }}">Obtaining metrics</a><br/>
53 <span class="linkdescr">obtaining and visualizing metrics from simulation runs</span></p>
54 </div>
55 </td>
56 <td width="50%" valign="top">
57 <h2>ndnSIM Versions</h2>
58 <div class="tile">
59 <p class="biglink"><a class="biglink" href="#">ndnSIM 2.1</a><br/>
60 <span class="linkdescr">latest version</span></p>
61 <p class="biglink"><a class="biglink" href="http://ndnsim.net/2.0/">ndnSIM 2.0</a><br/>
62 <p class="biglink"><a class="biglink" href="http://ndnsim.net/1.0/">ndnSIM 1.0</a><br/>
63 </div>
64 </td>
65 </tr>
66 <tr>
67 <td width="50%" valign="top">
68 <h2>Publications</h2>
69 <div class="tile">
70 <p class="biglink"><a class="biglink" href="{{ pathto("ndnsim-research-papers") }}">ndnSIM-related publications</a><br/>
71 <span class="linkdescr">general papers about ndnSIM, research papers that use ndnSIM</span></p>
72 <p>If you are referring to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
73 <ul>
74 <li>
75 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 (<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>)
76 </li>
77 <li>
78 A. Afanasyev, I. Moiseenko, and L. Zhang, &#8220;ndnSIM: NDN simulator for NS-3,&#8221; NDN, Technical Report NDN-0005, 2012 (<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>)
79 </li>
80 </ul>
81 </div>
82 </td>
83 <td width="50%" valign="top">
84 <h2>Miscellaneous</h2>
85 <div class="tile">
86 <p class="biglink"><a class="biglink" href="{{ pathto("RELEASE_NOTES") }}">Release Notes</a><br/>
87 <span class="linkdescr">new features, changes, bug fixes, deprecations, and removals</span></p>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070088
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070089 <p class="biglink"><a class="biglink" href="http://redmine.named-data.net/projects/ndnsim">Reporting bugs</a><br/>
90 <span class="linkdescr"><a href="http://redmine.named-data.net/projects/ndnsim" target="_blank">ndnSIM Redmine</a>,
91 <span class="linkdescr"><a href="https://github.com/named-data-ndnSIM/ndnSIM/pulls" target="_blank">GitHub pull requests</a></span></p>
92
93 <p class="biglink"><a class="biglink" href="http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim" target="_blank">ndnSIM mailing list</a><br/>
94 <span class="linkdescr"><a href="http://www.lists.cs.ucla.edu/pipermail/ndnsim/" target="_blank">mailing list archives</a></span></p>
95
Spyridon Mastorakis5897c962015-08-31 15:37:18 -070096 <p class="biglink"><a class="biglink" href="{{ pathto("meta/authors") }}">ndnSIM Team</a></p>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070097 <p class="biglink"><a class="biglink" href="{{ pathto("meta/copying") }}">Copyright and License</a></p>
98 </div>
99 </td>
100 </tr>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700101 </table>
102
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700103 {% endblock %}
104
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700105
Alexander Afanasyev819eb772013-08-25 20:55:27 -0700106{% endblock %}