blob: 9b777eb02fd8a9229cdead094e6661cfca2c6b1c [file] [log] [blame]
Alexander Afanasyev4d325162012-06-01 12:28:50 -07001.. ndnSIM: NS-3 based NDN simulator documentation master file
2
Alexander Afanasyevf34fe562013-08-09 17:16:12 -07003Welcome
4=======
5
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08006The ndnSIM 2.0 is NS-3 module that implements Named Data Networking (NDN) communication
7model, the clean slate Internet design. ndnSIM is specially optimized for simulation
8purposes and has a cleaner and more extensible internal structure comparing to the
9existing NDN implementation (NDNx).
Alexander Afanasyev4d325162012-06-01 12:28:50 -070010
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080011We invite you to `join our mailing list
12<http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in
13discussions about ndnSIM implementation and simulations in general (`mailing list archives
14<http://www.lists.cs.ucla.edu/pipermail/ndnsim/>`_).
Alexander Afanasyev9c0794a2012-12-10 01:02:33 -080015
Alexander Afanasyev4d325162012-06-01 12:28:50 -070016Contents:
17
18.. toctree::
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070019 :maxdepth: 4
Alexander Afanasyev4d325162012-06-01 12:28:50 -070020
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070021 intro
22 getting-started
23 helpers
24 cs
25 fw
26 applications
27
28.. toctree::
29 :maxdepth: 2
30
31 examples
32 metric
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070033 faq
34 ndnsim-research-papers
35
36.. toctree::
37 :hidden:
38 :glob:
39
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070040 meta/*
Alexander Afanasyevab933c62015-01-14 00:50:31 -050041 RELEASE_NOTES
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070042
Alexander Afanasyev9fb2e3d2013-03-30 21:11:07 -070043
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070044-------
45
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070046If you refer to ndnSIM in a published work, please cite the following paper, not just the ndnSIM website. Thank you!
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070047 **A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM: NDN simulator for NS-3," NDN, Technical Report NDN-0005, 2012** (`BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367>`_)
48
49.. * :ref:`search`