Blame - docs/source/tutorial.rst - ndnSIM

blob: d1bb3747a6afbaa508af5b9edf8b7bbe5e87f0b3 [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
Spyridon Mastorakis	af09eac	2018-02-22 11:25:26 -0800	[diff] [blame]	7	model, the clean slate Internet design.
Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	8
Spyridon Mastorakis	460f57c	2014-12-17 00:44:14 -0800	[diff] [blame]	9	We invite you to `join our mailing list
Xinyu Ma	fc8956c	2019-04-08 23:17:52 -0700	[diff] [blame^]	10	<https://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in
Spyridon Mastorakis	460f57c	2014-12-17 00:44:14 -0800	[diff] [blame]	11	discussions about ndnSIM implementation and simulations in general (`mailing list archives
Xinyu Ma	fc8956c	2019-04-08 23:17:52 -0700	[diff] [blame^]	12	<https://www.lists.cs.ucla.edu/pipermail/ndnsim/>`_).
Alexander Afanasyev	9c0794a	2012-12-10 01:02:33 -0800	[diff] [blame]	13
Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	14	Contents:
				15
				16	.. toctree::
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	17	:maxdepth: 4
Alexander Afanasyev	4d32516	2012-06-01 12:28:50 -0700	[diff] [blame]	18
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	19	intro
				20	getting-started
Alexander Afanasyev	5dee361	2015-08-25 16:09:04 -0700	[diff] [blame]	21	faq
Spyridon Mastorakis	acd5e1a	2016-12-07 14:34:25 -0800	[diff] [blame]	22	examples
Spyridon Mastorakis	2a3aefb	2017-01-06 18:56:10 -0800	[diff] [blame]	23	best-practices
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	24	helpers
				25	cs
				26	fw
				27	applications
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	28	metric
Spyridon Mastorakis	f34b319	2015-02-16 17:42:01 -0800	[diff] [blame]	29	parallel-simulations
Alexander Afanasyev	5dee361	2015-08-25 16:09:04 -0700	[diff] [blame]	30	guide-to-simulate-real-apps
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	31	ndnsim-research-papers
Spyridon Mastorakis	a879e02	2017-10-16 17:12:14 -0700	[diff] [blame]	32	community-contributions
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	33
Alexander Afanasyev	5dee361	2015-08-25 16:09:04 -0700	[diff] [blame]	34
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	35	.. toctree::
				36	:hidden:
				37	:glob:
				38
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	39	meta/*
Alexander Afanasyev	ab933c6	2015-01-14 00:50:31 -0500	[diff] [blame]	40	RELEASE_NOTES
Alexander Afanasyev	f34fe56	2013-08-09 17:16:12 -0700	[diff] [blame]	41
Alexander Afanasyev	9fb2e3d	2013-03-30 21:11:07 -0700	[diff] [blame]	42
Alexander Afanasyev	4cd50e3	2013-04-22 18:32:31 -0700	[diff] [blame]	43	-------
				44
Spyridon Mastorakis	ffe2586	2015-02-03 16:21:28 -0800	[diff] [blame]	45	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]	46
Spyridon Mastorakis	af09eac	2018-02-22 11:25:26 -0800	[diff] [blame]	47	For ndnSIM >= 2.0:
				48
Xinyu Ma	fc8956c	2019-04-08 23:17:52 -0700	[diff] [blame^]	49	- 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 <https://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim>`__)
Spyridon Mastorakis	a879e02	2017-10-16 17:12:14 -0700	[diff] [blame]	50
Xinyu Ma	fc8956c	2019-04-08 23:17:52 -0700	[diff] [blame^]	51	- 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 <https://users.cs.fiu.edu/~afanasyev/assets/bibtex/tr-mastorakis2016ndnsim.html>`__)
Spyridon Mastorakis	acd5e1a	2016-12-07 14:34:25 -0800	[diff] [blame]	52
Spyridon Mastorakis	af09eac	2018-02-22 11:25:26 -0800	[diff] [blame]	53	For ndnSIM 1.0:
				54
Xinyu Ma	fc8956c	2019-04-08 23:17:52 -0700	[diff] [blame^]	55	- 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 <https://users.cs.fiu.edu/~afanasyev/assets/bibtex/tr-afanasyev2012ndnsim.html>`__)
Alexander Afanasyev	4cd50e3	2013-04-22 18:32:31 -0700	[diff] [blame]	56
				57	.. * :ref:`search`