blob: 088f15dd686aecd00bafb9f175949c6d2e85dbe8 [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
6The 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).
Alexander Afanasyev4d325162012-06-01 12:28:50 -07007
Alexander Afanasyeve6852122013-01-21 11:54:47 -08008We invite you to `join our mailing list <http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in discussions about ndnSIM implementation and simulations in general (`mailing list archives <http://www.lists.cs.ucla.edu/pipermail/ndnsim/>`_).
Alexander Afanasyev9c0794a2012-12-10 01:02:33 -08009
Alexander Afanasyev4d325162012-06-01 12:28:50 -070010Contents:
11
12.. toctree::
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070013 :maxdepth: 4
Alexander Afanasyev4d325162012-06-01 12:28:50 -070014
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070015 intro
16 getting-started
17 helpers
18 cs
19 fw
20 applications
21
22.. toctree::
23 :maxdepth: 2
24
25 examples
26 metric
27 ndnsim-packet-formats
28 faq
29 ndnsim-research-papers
30
31.. toctree::
32 :hidden:
33 :glob:
34
35 new-packet-formats
36 meta/*
37
Alexander Afanasyev9fb2e3d2013-03-30 21:11:07 -070038
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070039-------
40
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070041If 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 -070042 **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>`_)
43
44.. * :ref:`search`