blob: 37d7fe474a31da9179327255affcbc80ca52e305 [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
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080034 parallel-simulations
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070035 ndnsim-research-papers
36
37.. toctree::
38 :hidden:
39 :glob:
40
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070041 meta/*
Alexander Afanasyevab933c62015-01-14 00:50:31 -050042 RELEASE_NOTES
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070043
Alexander Afanasyev9fb2e3d2013-03-30 21:11:07 -070044
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070045-------
46
Spyridon Mastorakisffe25862015-02-03 16:21:28 -080047If you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080048 **S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM 2.0: A new version of the NDN simulator for NS-3," NDN, Technical Report NDN-0028, 2015** (`PDF <http://named-data.net/techreport/ndn-0028-1-ndnsim-v2.pdf>`__, `BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399>`__)
Spyridon Mastorakisffe25862015-02-03 16:21:28 -080049
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080050 **A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM: NDN simulator for NS-3," NDN, Technical Report NDN-0005, 2012** (`PDF <http://named-data.net/wp-content/uploads/TRndnsim.pdf>`__, `BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367>`__)
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070051
52.. * :ref:`search`