blob: 7b1cf2e572ae400bcf5b191a1c0c2b2e69e07092 [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
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -08007model, the clean slate Internet design.
Alexander Afanasyev4d325162012-06-01 12:28:50 -07008
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08009We invite you to `join our mailing list
10<http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in
11discussions about ndnSIM implementation and simulations in general (`mailing list archives
12<http://www.lists.cs.ucla.edu/pipermail/ndnsim/>`_).
Alexander Afanasyev9c0794a2012-12-10 01:02:33 -080013
Alexander Afanasyev4d325162012-06-01 12:28:50 -070014Contents:
15
16.. toctree::
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070017 :maxdepth: 4
Alexander Afanasyev4d325162012-06-01 12:28:50 -070018
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070019 intro
20 getting-started
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070021 faq
Spyridon Mastorakisacd5e1a2016-12-07 14:34:25 -080022 examples
Spyridon Mastorakis2a3aefb2017-01-06 18:56:10 -080023 best-practices
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070024 helpers
25 cs
26 fw
27 applications
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070028 metric
Spyridon Mastorakisf34b3192015-02-16 17:42:01 -080029 parallel-simulations
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070030 guide-to-simulate-real-apps
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070031 ndnsim-research-papers
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070032 community-contributions
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070033
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070034
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070035.. toctree::
36 :hidden:
37 :glob:
38
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070039 meta/*
Alexander Afanasyevab933c62015-01-14 00:50:31 -050040 RELEASE_NOTES
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070041
Alexander Afanasyev9fb2e3d2013-03-30 21:11:07 -070042
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070043-------
44
Spyridon Mastorakisffe25862015-02-03 16:21:28 -080045If 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 -080046
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080047**For ndnSIM >= 2.0:**
48
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070049- **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** (`PDF <https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf>`__, `BibTex <http://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim>`__)
50
Spyridon Mastorakisacd5e1a2016-12-07 14:34:25 -080051- **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>`__)
52
Spyridon Mastorakisaf09eac2018-02-22 11:25:26 -080053**For ndnSIM 1.0:**
54
Spyridon Mastorakisacd5e1a2016-12-07 14:34:25 -080055- **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 -070056
57.. * :ref:`search`