blob: 69cd53d8826ddd6f61f8fa8e87017e9aaf928d2d [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
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070023 faq
Spyridon Mastorakisacd5e1a2016-12-07 14:34:25 -080024 examples
Spyridon Mastorakis2a3aefb2017-01-06 18:56:10 -080025 best-practices
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070026 helpers
27 cs
28 fw
29 applications
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070030 metric
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080031 parallel-simulations
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070032 guide-to-simulate-real-apps
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070033 ndnsim-research-papers
34
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070035
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070036.. 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
Spyridon Mastorakisffe25862015-02-03 16:21:28 -080046If you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
Spyridon Mastorakisffe25862015-02-03 16:21:28 -080047
Spyridon Mastorakisacd5e1a2016-12-07 14:34:25 -080048- **S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM 2: An updated NDN simulator for NS-3," NDN, Technical Report NDN-0028, Revision 2, 2016** (`PDF <https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf>`__, `BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399>`__)
49
50- **A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM: NDN simulator for NS-3," NDN, Technical Report NDN-0005, 2012** (`PDF <https://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`