blob: 71289ddad7de69a321c3dadcb6bcadf5cecabc90 [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>
Spyridon Mastorakisa879e022017-10-16 17:12:14 -07008This website includes the ndnSIM documentation and is intended to help the community use the simulator for NDN experimentation. It is not intended to present the principles or the design of the NDN architecture and communication model.
Xinyu Mafc8956c2019-04-08 23:17:52 -07009We invite you to <a href="https://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="https://www.lists.cs.ucla.edu/pipermail/ndnsim/" target="_blank">mailing list archives</a>).
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070010 </p>
11
12 {% block tables %}
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070013 <!-- <p><strong>Parts of the documentation:</strong></p> -->
14 <table class="contentstable" align="center">
15 <tr>
16 <td width="50%" valign="top">
17 <h2>Getting Started</h2>
18 <div class="tile">
19 <p class="biglink"><a class="biglink" href="{{ pathto("intro") }}">Introduction</a><br/>
20 <span class="linkdescr">what is ndnSIM, how to get support, and what is in the package</span></p>
21 <p class="biglink"><a class="biglink" href="{{ pathto("getting-started") }}">Downloading and Compiling ndnSIM</a><br/>
22 <span class="linkdescr">requirements, downloading, compiling, simulating</span></p>
23 <p class="biglink"><a class="biglink" href="{{ pathto("faq") }}">FAQs</a><br/>
24 <span class="linkdescr">frequently asked questions (with answers!)</span></p>
25 <p class="biglink"><a class="biglink" href="{{ pathto("examples") }}">Simulation examples</a><br/>
26 <span class="linkdescr">basic tutorial examples</span></p>
Spyridon Mastorakis2a3aefb2017-01-06 18:56:10 -080027 <p class="biglink"><a class="biglink" href="{{ pathto("best-practices") }}">Best practises</a><br/>
28 <span class="linkdescr">best practises on using ndnSIM</span></p>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070029 </div>
30 </td>
31 <td width="50%" valign="top">
32 <h2>Advanced Topics</h2>
33 <div class="tile">
34 <p class="biglink"><a class="biglink" href="doxygen/annotated.html">ndnSIM API documentation</a><br/>
35 <span class="linkdescr">generated documentation of ndnSIM API</span></p>
36 <p class="biglink"><a class="biglink" href="{{ pathto("parallel-simulations") }}">Parallelize simulations using OpenMPI</a><br/>
37 <span class="linkdescr">how to use OpenMPI to parallelize execution of simulation scenarios</span></p>
38 <p class="biglink"><a class="biglink" href="{{ pathto("guide-to-simulate-real-apps") }}">Simulating real applications</a><br/>
39 <span class="linkdescr">guide on how to simulate real application that are written against ndn-cxx library</span></p>
40 </div>
41 </td>
42 </tr>
43 <tr>
44 <td width="50%" valign="top">
45 <h2>ndnSIM tutorial</h2>
46 <div class="tile">
47 <p class="biglink"><a class="biglink" href="{{ pathto("helpers") }}">ndnSIM helpers</a><br/>
48 <span class="linkdescr">very important components of ndnSIM for writing simulation scenarios</span></p>
49 <p class="biglink"><a class="biglink" href="{{ pathto("cs") }}">Content Store</a><br/>
50 <span class="linkdescr">several different build-in content store implementations: LRU, LFU, and others</span></p>
51 <p class="biglink"><a class="biglink" href="{{ pathto("fw") }}">Forwarding Strategies</a><br/>
52 <span class="linkdescr">experimenting with different build-in and custom Interest/Data forwarding strategies</span></p>
53 <p class="biglink"><a class="biglink" href="{{ pathto("applications") }}">ndnSIM applications</a><br/>
54 <span class="linkdescr">reference applications for network-leverl evaluations</span></p>
55 <p class="biglink"><a class="biglink" href="{{ pathto("metric") }}">Obtaining metrics</a><br/>
56 <span class="linkdescr">obtaining and visualizing metrics from simulation runs</span></p>
57 </div>
58 </td>
59 <td width="50%" valign="top">
60 <h2>ndnSIM Versions</h2>
61 <div class="tile">
Alexander Afanasyevfbbe13d2019-02-21 13:40:52 -050062 <p class="biglink"><a class="biglink" href="#">ndnSIM 2.7</a><br/>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070063 <span class="linkdescr">latest version</span></p>
Xinyu Mafc8956c2019-04-08 23:17:52 -070064 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.6/">ndnSIM 2.6</a><br/>
65 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.5/">ndnSIM 2.5</a><br/>
66 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.4/">ndnSIM 2.4</a><br/>
67 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.3/">ndnSIM 2.3</a><br/>
68 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.2/">ndnSIM 2.2</a><br/>
69 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.1/">ndnSIM 2.1</a><br/>
70 <p class="biglink"><a class="biglink" href="https://ndnsim.net/2.0/">ndnSIM 2.0</a><br/>
71 <p class="biglink"><a class="biglink" href="https://ndnsim.net/1.0/">ndnSIM 1.0</a><br/>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070072 </div>
73 </td>
74 </tr>
75 <tr>
76 <td width="50%" valign="top">
77 <h2>Publications</h2>
78 <div class="tile">
79 <p class="biglink"><a class="biglink" href="{{ pathto("ndnsim-research-papers") }}">ndnSIM-related publications</a><br/>
80 <span class="linkdescr">general papers about ndnSIM, research papers that use ndnSIM</span></p>
81 <p>If you are referring to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080082 <ul style="padding-left:20px">
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070083 <li>
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080084 <b>For ndnSIM >= 2.0:</b>
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070085 </li>
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080086 <ul style="padding-left:30px">
87 <li>
Xinyu Mafc8956c2019-04-08 23:17:52 -070088 S. Mastorakis, A. Afanasyev, and L. Zhang, "On the Evolution of ndnSIM: an Open-Source Simulator for NDN Experimentation," ACM SIGCOMM Computer Communication Review (CCR), July 2017 (<a class="reference external" href="https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf">PDF</a>) (<a class="reference external" href="https://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim">BibTex</a>)
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080089 </li>
90 <li>
Xinyu Mafc8956c2019-04-08 23:17:52 -070091 S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, &#8220;ndnSIM 2: An updated NDN simulator for NS-3,&#8221; NDN, Technical Report NDN-0028, Revision 2, 2016 (<a class="reference external" href="https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf">PDF</a>) (<a class="reference external" href="https://users.cs.fiu.edu/~afanasyev/assets/bibtex/tr-mastorakis2016ndnsim.html">BibTex</a>)
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080092 </li>
93 </ul>
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070094 <li>
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080095 <b> For ndnSIM 1.0:</b>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070096 </li>
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080097 <ul style="padding-left:30px">
98 <li>
Xinyu Mafc8956c2019-04-08 23:17:52 -070099 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="https://named-data.net/wp-content/uploads/TRndnsim.pdf">PDF</a>) (<a class="reference external" href="https://users.cs.fiu.edu/~afanasyev/assets/bibtex/tr-afanasyev2012ndnsim.html">BibTex</a>)
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -0800100 </li>
101 </ul>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700102 </ul>
103 </div>
104 </td>
105 <td width="50%" valign="top">
106 <h2>Miscellaneous</h2>
107 <div class="tile">
108 <p class="biglink"><a class="biglink" href="{{ pathto("RELEASE_NOTES") }}">Release Notes</a><br/>
109 <span class="linkdescr">new features, changes, bug fixes, deprecations, and removals</span></p>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700110
Xinyu Mafc8956c2019-04-08 23:17:52 -0700111 <p class="biglink"><a class="biglink" href="https://redmine.named-data.net/projects/ndnsim">Reporting bugs</a><br/>
112 <span class="linkdescr"><a href="https://redmine.named-data.net/projects/ndnsim" target="_blank">ndnSIM Redmine</a>,
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700113 <span class="linkdescr"><a href="https://github.com/named-data-ndnSIM/ndnSIM/pulls" target="_blank">GitHub pull requests</a></span></p>
114
Xinyu Mafc8956c2019-04-08 23:17:52 -0700115 <p class="biglink"><a class="biglink" href="https://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim" target="_blank">ndnSIM mailing list</a><br/>
116 <span class="linkdescr"><a href="https://www.lists.cs.ucla.edu/pipermail/ndnsim/" target="_blank">mailing list archives</a></span></p>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700117
Spyridon Mastorakisa879e022017-10-16 17:12:14 -0700118 <p class="biglink"><a class="biglink" href="{{ pathto("community-contributions") }}">Community Contributions</a><br/>
119 <span class="linkdescr">very much appreciated contributions of the ndnSIM user community</span></p>
120
Spyridon Mastorakis5897c962015-08-31 15:37:18 -0700121 <p class="biglink"><a class="biglink" href="{{ pathto("meta/authors") }}">ndnSIM Team</a></p>
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700122 <p class="biglink"><a class="biglink" href="{{ pathto("meta/copying") }}">Copyright and License</a></p>
123 </div>
124 </td>
125 </tr>
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700126 </table>
127
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700128 {% endblock %}
129
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700130
Alexander Afanasyev819eb772013-08-25 20:55:27 -0700131{% endblock %}