Blame - docs/source/tutorial.rst - ndnSIM

blob: 69cd53d8826ddd6f61f8fa8e87017e9aaf928d2d [file] [log] [blame]

Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	1	.. ndnSIM: NS-3 based NDN simulator documentation master file
				2
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	3	Welcome
				4	=======
				5
Spyridon Mastorakis	460f57c	2014-12-17 00:44:14 -0800	[diff] [blame]	6	The ndnSIM 2.0 is NS-3 module that implements Named Data Networking (NDN) communication
				7	model, the clean slate Internet design. ndnSIM is specially optimized for simulation
				8	purposes and has a cleaner and more extensible internal structure comparing to the
				9	existing NDN implementation (NDNx).
Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	10
Spyridon Mastorakis	460f57c	2014-12-17 00:44:14 -0800	[diff] [blame]	11	We invite you to `join our mailing list
				12	<http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in
				13	discussions about ndnSIM implementation and simulations in general (`mailing list archives
				14	<http://www.lists.cs.ucla.edu/pipermail/ndnsim/>`_).
Alexander Afanasyev	9c0794a	2012-12-10 01:02:33 -0800	[diff] [blame]	15
Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	16	Contents:
				17
				18	.. toctree::
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	19	:maxdepth: 4
Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	20
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	21	intro
				22	getting-started
Alexander Afanasyev	5dee361	2015-08-25 16:09:04 -0700	[diff] [blame]	23	faq
Spyridon Mastorakis	acd5e1a	2016-12-07 14:34:25 -0800	[diff] [blame]	24	examples
Spyridon Mastorakis	2a3aefb	2017-01-06 18:56:10 -0800	[diff] [blame]	25	best-practices
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	26	helpers
				27	cs
				28	fw
				29	applications
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	30	metric
Spyridon Mastorakis	f34b319	2015-02-16 17:42:01 -0800	[diff] [blame]	31	parallel-simulations
Alexander Afanasyev	5dee361	2015-08-25 16:09:04 -0700	[diff] [blame]	32	guide-to-simulate-real-apps
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	33	ndnsim-research-papers
				34
Alexander Afanasyev	5dee361	2015-08-25 16:09:04 -0700	[diff] [blame]	35
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	36	.. toctree::
				37	:hidden:
				38	:glob:
				39
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	40	meta/*
Alexander Afanasyev	ab933c6	2015-01-14 00:50:31 -0500	[diff] [blame]	41	RELEASE_NOTES
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	42
Alexander Afanasyev	9fb2e3d	2013-03-30 21:11:07 -0700	[diff] [blame]	43
Alexander Afanasyev	4cd50e3	2013-04-22 18:32:31 -0700	[diff] [blame]	44	-------
				45
Spyridon Mastorakis	ffe2586	2015-02-03 16:21:28 -0800	[diff] [blame]	46	If you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
Spyridon Mastorakis	ffe2586	2015-02-03 16:21:28 -0800	[diff] [blame]	47
Spyridon Mastorakis	acd5e1a	2016-12-07 14:34:25 -0800	[diff] [blame]	48	- 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 Afanasyev	4cd50e3	2013-04-22 18:32:31 -0700	[diff] [blame]	51
				52	.. * :ref:`search`