docs: Updating documentation for ndnSIM 2.5 release
Change-Id: Ia1dba06a9afd66a810171d4a512f35f6df6ba22a
diff --git a/docs/ns3_html_theme/ns3_doxy_header.html b/docs/ns3_html_theme/ns3_doxy_header.html
index 5f45f4f..2bb3c41 100644
--- a/docs/ns3_html_theme/ns3_doxy_header.html
+++ b/docs/ns3_html_theme/ns3_doxy_header.html
@@ -33,7 +33,7 @@
</td>
<td id="projecttext">
<div id="projectbrief">NS-3 based Named Data Networking (NDN) simulator</div>
- <span id="projectnumber">ndnSIM 2.3: NDN, CCN, CCNx, content centric networks</span>
+ <span id="projectnumber">ndnSIM 2.5: NDN, CCN, CCNx, content centric networks</span>
</td>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
diff --git a/docs/source/_templates/indexcontent.html b/docs/source/_templates/indexcontent.html
index f7134ce..7d73e6e 100644
--- a/docs/source/_templates/indexcontent.html
+++ b/docs/source/_templates/indexcontent.html
@@ -76,16 +76,26 @@
<p class="biglink"><a class="biglink" href="{{ pathto("ndnsim-research-papers") }}">ndnSIM-related publications</a><br/>
<span class="linkdescr">general papers about ndnSIM, research papers that use ndnSIM</span></p>
<p>If you are referring to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
- <ul>
+ <ul style="padding-left:20px">
<li>
- 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 (<a class="reference external" href="https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf">PDF</a>) (<a class="reference external" href="http://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim">BibTex</a>)
+ <b>For ndnSIM >= 2.0:</b>
</li>
+ <ul style="padding-left:30px">
+ <li>
+ 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 (<a class="reference external" href="https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf">PDF</a>) (<a class="reference external" href="http://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim">BibTex</a>)
+ </li>
+ <li>
+ 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 (<a class="reference external" href="https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399">BibTex</a>)
+ </li>
+ </ul>
<li>
- 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 (<a class="reference external" href="https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399">BibTex</a>)
+ <b> For ndnSIM 1.0:</b>
</li>
- <li>
- A. Afanasyev, I. Moiseenko, and L. Zhang, “ndnSIM: NDN simulator for NS-3,” NDN, Technical Report NDN-0005, 2012 (<a class="reference external" href="https://named-data.net/wp-content/uploads/TRndnsim.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367">BibTex</a>)
- </li>
+ <ul style="padding-left:30px">
+ <li>
+ A. Afanasyev, I. Moiseenko, and L. Zhang, “ndnSIM: NDN simulator for NS-3,” NDN, Technical Report NDN-0005, 2012 (<a class="reference external" href="https://named-data.net/wp-content/uploads/TRndnsim.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367">BibTex</a>)
+ </li>
+ </ul>
</ul>
</div>
</td>
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
index 640625b..e60c10d 100644
--- a/docs/source/examples.rst
+++ b/docs/source/examples.rst
@@ -12,6 +12,14 @@
If you compiled ndnSIM with examples (``./waf configure --enable-examples``) you can
directly run the example without putting scenario into ``scratch/`` folder.
+.. note::
+ A few mobile simulation scenarios are available. The project code may require a custom version of ndnSIM (see project commits for further details).
+
+ - `Project Repository <https://github.com/4th-ndn-hackathon/ndnSIM-Mobile-Simulation-Package>`__
+ - `Vehicle to Infrastructure Example <https://github.com/4th-ndn-hackathon/ndnSIM-Mobile-Simulation-Package/blob/master/examples/simple-wifi-mobility.cpp>`__
+ - `Vehicle to Vehicle Example <https://github.com/4th-ndn-hackathon/ndnSIM-Mobile-Simulation-Package/blob/master/examples/ndn-v2v-simple.cpp>`__
+
+
.. _simple-scenario:
Simple scenario
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
index 3b74f68..782ccde 100644
--- a/docs/source/getting-started.rst
+++ b/docs/source/getting-started.rst
@@ -10,9 +10,10 @@
ndnSIM 2.x has been successfully compiled and used on following platforms:
- Ubuntu Linux 16.04 (32- and 64-bit platform)
-- macOS 10.10
+- Ubuntu Linux 17.10 (64-bit platform)
- macOS 10.11
- macOS 10.12
+- macOS 10.13
.. _requirements:
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
index 9dd0908..a3dea20 100644
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
@@ -10,18 +10,6 @@
.. image:: _static/ndnSIM-structure.*
:width: 100%
-- Packet format changed to [NDN Packet Specification](http://named-data.net/doc/ndn-tlv/)
-
-- ndnSIM uses implementation of basic NDN primitives from
- [ndn-cxx library (NDN C++ library with eXperimental eXtensions)](http://named-data.net/doc/ndn-cxx/)
-
-- All NDN forwarding and management is implemented directly using source code of
- [Named Data Networking Forwarding Daemon (NFD)](http://named-data.net/doc/NFD/)
-
-- Allows [simulation of real applications](http://ndnsim.net/2.1/guide-to-simulate-real-apps.html)
- written against ndn-cxx library
-
-
A new release of `NS-3 based Named Data Networking (NDN) simulator <http://ndnsim.net/1.0/>`__
went through a number of extensive refactoring and rewriting. The key new features of the
new version:
@@ -35,12 +23,12 @@
- All NDN forwarding and management is implemented directly using source code of `Named
Data Networking Forwarding Daemon (NFD) <http://named-data.net/doc/NFD/>`_
-- It is possible to :doc:`simulation some real applications <guide-to-simulate-real-apps>`
+- It is possible to :doc:`simulate some real applications <guide-to-simulate-real-apps>`
written against ndn-cxx library
.. note::
- Please note that ndnSIM 2.0 has major refactoring and simulation scenario written for
- previous releases most likely would need to be changed to run on ndnSIM 2.0 platform.
+ Please note that ndnSIM >= 2.0 has been through major refactoring and simulation scenario written for
+ ndnSIM 1.0 most likely would need to be changed to run on ndnSIM >= 2.0 platforms.
Such integration with ndn-cxx and NFD ensures that the simulations are maximally realistic
and can be reproduced in real environments with virtually no changes to the source code.
@@ -62,16 +50,36 @@
More documentation
------------------
-Overall structure of ndnSIM is described in our paper and technical reports:
+Overall structure of ndnSIM is described in our paper and technical reports.
+
+**For ndnSIM >= 2.0:**
- **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>`__)
- **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>`__)
+**For ndnSIM 1.0:**
+
- **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>`__)
`ndnSIM API documentation <doxygen/index.html>`_
+Presentations on ndnSIM:
+
+- **S. Mastorakis, A. Afanasyev, and L. Zhang, "On the Evolution of ndnSIM: an Open-Source Ecosystem for NDN Experimentation", NDN Community Meeting (NDNcomm), Memphis, TN, March 2017** (`Slides <https://www.caida.org/workshops/ndn/1703/slides/ndn1703_smastorakis.pptx>`__)
+
+- **A. Afanasyev and others, “Developing Simple Simulations with ndnSIM.” NDN Tutorial at ACM ICN 2016, Kyoto, Japan, Sep-2016** (`Slides <https://users.cs.fiu.edu/~afanasyev/assets/papers/talks-afanasyev2016ndn-tutorial-ndnsim.pdf>`__)
+
+- **S. Mastorakis, "ndnSIM: Current Status & Latest Advancements", 6th NDN Retreat, San Diego, CA, March 2016** (`Slides <https://www.caida.org/workshops/ndn/1603/slides/ndn1603_smastorakis2.pdf>`__)
+
+- **A. Afanasyev, J. Burke, P. Crowley, S. DiBenedetto, V. Jacobson, J. Thompson, B. Zhang, and L. Zhang, “Named Data Networking. ndnSIM: a modular NDN simulator.” An Introduction to NDN and its Software Architecture Tutorial at 1st ACM Conference on Information-Centric Networking (ICN-2014), Sep-2014** (`Slides <https://users.cs.fiu.edu/~afanasyev/assets/papers/talks-afanasyev2014ndnsim.pptx>`__)
+
+- **A. Afanasyev, “Tutorial for students: ndnSIM.” AsiaFI 2013 Summer School, Aug-2013** (`Slides <https://users.cs.fiu.edu/~afanasyev/assets/papers/talks-afanasyev2013ndnsim-tutorial.pptx>`__)
+
+- **A. Afanasyev, I. Moiseenko, and L. Zhang, “ndnSIM: a modular NDN simulator. Introduction and Tutorial.” 3rd NDN retreat, Oct-2012** (`Slides <https://users.cs.fiu.edu/~afanasyev/assets/papers/talks-afanasyev2012ndnsim.pdf>`__)
+
+- **A. Afanasyev, I. Moiseenko, and L. Zhang, “ndnSIM: a modular NDN simulator.” CCNxCon 2012, Sep-2012** (`Slides <https://users.cs.fiu.edu/~afanasyev/assets/papers/talks-ccnxcon-afanasyev2012ndnsim.pdf>`__)
+
Also, you can `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. Do not forget to
diff --git a/docs/source/meta/copying.rst b/docs/source/meta/copying.rst
index 1609bcb..786e039 100644
--- a/docs/source/meta/copying.rst
+++ b/docs/source/meta/copying.rst
@@ -2,7 +2,7 @@
Copyright and License
=====================
-Copyright © 2011-2015 University of California, Los Angeles
+Copyright © 2011-2018 University of California, Los Angeles
ndnSIM is licensed under conditions of GNU General Public License version 3.0 or later
with permission to be linked with NS-3 codebase (GPL 2.0).
@@ -24,7 +24,7 @@
- NDN Forwarding Daemon (NFD) licensed under conditions of `GNU GPL 3.0+
<https://github.com/named-data/NFD/blob/master/COPYING.md>`__
-
+
ndnSIM also relies on several other third-party libraries with non-GPL compatible
license. These library fall into category of "System Libraries" under GPL license
definitions and are used in accordance with GPL license exception for "System Libraries":
diff --git a/docs/source/ndnsim-research-papers.rst b/docs/source/ndnsim-research-papers.rst
index 6644e79..4627132 100644
--- a/docs/source/ndnsim-research-papers.rst
+++ b/docs/source/ndnsim-research-papers.rst
@@ -7,7 +7,22 @@
---------------------------
.. note::
- if you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website
+ if you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website.
+
+**For ndnSIM >= 2.0:**
+
+- **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>`__)
+
+ As a proposed Internet architecture, Named Data Networking (NDN) takes a
+ fundamental departure from today's TCP/IP architecture, thus requiring extensive
+ experimentation and evaluation. To facilitate such experimentation, we have developed
+ ndnSIM, an open-source NDN simulator based on the NS-3 simulation framework. Since its
+ first release in 2012, ndnSIM has gone through five years of active development and
+ integration with the NDN prototype implementations, and has become a popular platform
+ used by hundreds of researchers around the world. This paper presents an overview of the
+ ndnSIM design, the ndnSIM development process, the design tradeoffs, and the reasons
+ behind the design decisions. We also share with the community a number of lessons we
+ have learned in the process.
- **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>`__)
@@ -21,6 +36,8 @@
the ndn-cxx library (NDN C++ library with eXperimental eXtensions) and the NDN Forwarding Daemon
(NFD) to enable experiments with real code in a simulation environment.
+**For ndnSIM 1.0:**
+
- **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>`__)
Named Data Networking (NDN) is a newly proposed Internet architecture. NDN retains the
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
index 373184a..7b1cf2e 100644
--- a/docs/source/tutorial.rst
+++ b/docs/source/tutorial.rst
@@ -4,7 +4,7 @@
=======
The ndnSIM 2.0 is NS-3 module that implements Named Data Networking (NDN) communication
-model, the clean slate Internet design.
+model, the clean slate Internet design.
We invite you to `join our mailing list
<http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in
@@ -44,10 +44,14 @@
If you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
+**For ndnSIM >= 2.0:**
+
- **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>`__)
- **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>`__)
+**For ndnSIM 1.0:**
+
- **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>`__)
.. * :ref:`search`