PyViz - Revision history

Tomh: /* Plugins */

2015-03-24T15:56:56Z

Plugins

← Older revision		Revision as of 15:56, 24 March 2015
Line 124:		Line 124:

	= Plugins =		= Plugins =

			'''Warning:''' This section may contain dated information for ns-3 version < 3.10. Updated information is requested.

	Before proceeding, be sure you know how to program in PyGTK. Depending on what you want to do, GooCanvas knowledge may also be required.		Before proceeding, be sure you know how to program in PyGTK. Depending on what you want to do, GooCanvas knowledge may also be required.


	Python modules or packages appearing in <tt>contrib/visualizer/plugins/</tt> are loaded automatically by pyviz as plugins. Each plugin module must define a <tt>register(viz)</tt> function, that is called as soon as the visualizer is initialized, passing the Visualizer class instance as sole argument.		Python modules or packages appearing in <tt>contrib/visualizer/plugins/</tt> are loaded automatically by pyviz as plugins. Each plugin module must define a <tt>register(viz)</tt> function, that is called as soon as the visualizer is initialized, passing the Visualizer class instance as sole argument.

Tomh: /* Enabling the visualizer in your own simulation */

2015-03-24T15:55:22Z

Enabling the visualizer in your own simulation

← Older revision		Revision as of 15:55, 24 March 2015
Line 53:		Line 53:

	= Enabling the visualizer in your own simulation =		= Enabling the visualizer in your own simulation =
	== ns >= 3~~.11~~ ==		== current ns-3 ==

	In ns 3.11~~, because it is modular~~, you first need to add the 'visualizer' module to your program, as dependency~~. Then the --vis waf option works as in ns 3.10~~. Note: "scratch" programs do not need this step, they already link to the visualizer module by default.		In ns version 3.11 and later, you first need to add the 'visualizer' module to your program, as a dependency. Note: "scratch" programs do not need this step, they already link to the visualizer module by default.

			For non-scratch programs, find the wscript that declares the program, and modify it, such as:

	~~For non-scratch programs, find the wscript that declares the program, and modify it:~~
	diff -r fbeb6b1cca20 src/olsr/examples/wscript		diff -r fbeb6b1cca20 src/olsr/examples/wscript
	--- a/src/olsr/examples/wscript Thu Jun 02 09:21:24 2011 -0700		--- a/src/olsr/examples/wscript Thu Jun 02 09:21:24 2011 -0700

Tomh: /* Installation */

2015-03-24T15:53:29Z

Installation

← Older revision		Revision as of 15:53, 24 March 2015
Line 7:		Line 7:
	= Installation =		= Installation =

	== ns >= 3~~.10~~ ==		== current ns-3 ==

	PyViz has been integrated into mainline ns-3, starting with version 3.10. For earlier versions, see the section below.		PyViz has been integrated into mainline ns-3, starting with version 3.10. For earlier versions, see the section below.
Line 23:		Line 23:

	yum install python-devel gnome-python2 gnome-python2-gnomedesktop gnome-python2-rsvg graphviz-python pygoocanvas python-kiwi		yum install python-devel gnome-python2 gnome-python2-gnomedesktop gnome-python2-rsvg graphviz-python pygoocanvas python-kiwi

			On OS X, you need to install the pygtk, pygoocanvas, and pygraphviz packages. The specific package names depend on which version of python you are using and which package manager is being used for Python packages (default [https://wiki.python.org/moin/MacPython MacPython], or [http://www.macports.org MacPorts], or [http://brew.sh Homebrew], or [https://pypi.python.org/pypi/pip pip]). Note that ns-3 (as of ns-3.22) is only compatible with Python 2.7 or older, not Python 3.

			For example, using MacPorts and python27, the following additional package installations made PyViz available on an OS X Yosemite machine:

			port install py27-pygtk py27-pygoocanvas py27-pygraphviz

	Configure and build your ns-3 tree as usual, and make sure NS-3 Python bindings are ''enabled''; '''pyviz will not work without Python bindings'''!		Configure and build your ns-3 tree as usual, and make sure NS-3 Python bindings are ''enabled''; '''pyviz will not work without Python bindings'''!
Line 28:		Line 34:
	You can test the visualizer for example with the FlowMonitor sample program:		You can test the visualizer for example with the FlowMonitor sample program:

	./waf --pyrun src/flow-monitor/examples/wifi-olsr-flowmon.py --~~visualize~~		./waf --pyrun src/flow-monitor/examples/wifi-olsr-flowmon.py --vis

	And the result should be something similar to the screenshot below:		And the result should be something similar to the screenshot below:
Line 34:		Line 40:
	[[File:Pyviz-flowmon.png]]		[[File:Pyviz-flowmon.png]]

	== ns < 3.10 ==		== ns versions < 3.10 ==

	For earlier ns-3 versions, PyViz is found on a separate branch. There are multiple branches of PyViz, merged with different versions of NS-3:		For earlier ns-3 versions, PyViz is found on a separate branch. There are multiple branches of PyViz, merged with different versions of NS-3:
Line 42:		Line 48:
	# [http://code.nsnam.org/gjc/ns-3.8-pyviz/ gjc/ns-3.8-pyviz]: this branch is based on NS-3.8		# [http://code.nsnam.org/gjc/ns-3.8-pyviz/ gjc/ns-3.8-pyviz]: this branch is based on NS-3.8
	# [http://code.nsnam.org/gjc/ns-3.9-pyviz/ gjc/ns-3.9-pyviz]: this branch is based on NS-3.9		# [http://code.nsnam.org/gjc/ns-3.9-pyviz/ gjc/ns-3.9-pyviz]: this branch is based on NS-3.9
	# [http://code.nsnam.org/gjc/ns-3-pyviz-dev/ gjc/ns-3-pyviz-dev]: this branch is based on the current NS-3 development version, ns-3-dev.		# [http://code.nsnam.org/gjc/ns-3-pyviz-dev/ gjc/ns-3-pyviz-dev]: this branch was based on the current NS-3 development version, ns-3-dev, but seems to be no longer maintained.

	You will have to select one of those branches, and [http://hgbook.red-bean.com/read/a-tour-of-mercurial-merging-work.html merge] it with your code.		You will have to select one of those branches, and [http://hgbook.red-bean.com/read/a-tour-of-mercurial-merging-work.html merge] it with your code.

Tomh at 22:54, 18 March 2015

2015-03-18T22:54:37Z

← Older revision		Revision as of 22:54, 18 March 2015
Line 1:		Line 1:
			{{TOC}}

	= Introduction =		= Introduction =

GustavoCarneiro: /* Known problems */

2011-10-18T14:17:10Z

Known problems

← Older revision		Revision as of 14:17, 18 October 2011
Line 110:		Line 110:

	= Known problems =		= Known problems =
	~~NS 3.8: PyViz does~~ not ~~detect WiMax transmissions due to a [http://www.nsnam.org/bugzilla/show_bug.cgi?id=905 bug] in WimaxNetDevice. This has been fixed in NS 3~~.9.		LTE devices do not support visualizer yet.

			You cannot use visualizer with simulations that require emulation (EmuNetDevice, TapNetDevice) or real-time scheduler (RealTimeSimulator).

	= Plugins =		= Plugins =

GustavoCarneiro: /* ns >= 3.11 */

2011-10-05T16:16:09Z

ns >= 3.11

@@ Line 47: / Line 47: @@
 == ns >= 3.11 ==
-In ns 3.11, because it is modular, you first need to add the 'visualizer' module to your program, as dependency.  Then the --vis waf option works as in ns 3.10.
+In ns 3.11, because it is modular, you first need to add the 'visualizer' module to your program, as dependency.  Then the --vis waf option works as in ns 3.10.  Note: "scratch" programs do not need this step, they already link to the visualizer module by default.
   diff -r fbeb6b1cca20 src/olsr/examples/wscript
   --- a/src/olsr/examples/wscript	Thu Jun 02 09:21:24 2011 -0700
@@ Line 64: / Line 62: @@
        obj = bld.create_ns3_program('olsr-hna',
 == ns 3.10 ==

Vedranm: Add instructions for Fedora

2011-09-07T12:30:10Z

Add instructions for Fedora

← Older revision		Revision as of 12:30, 7 September 2011
Line 4:		Line 4:

	= Installation =		= Installation =

			== ns >= 3.10 ==

	PyViz has been integrated into mainline ns-3, starting with version 3.10. For earlier versions, see the section below.		PyViz has been integrated into mainline ns-3, starting with version 3.10. For earlier versions, see the section below.

	You will need to have certain python modules installed. Following installation instructions (for Ubuntu):		You will need to have certain python modules installed. Following installation instructions (for Ubuntu/Debian):

	sudo apt-get install python-dev python-pygraphviz python-kiwi python-pygoocanvas \		sudo apt-get install python-dev python-pygraphviz python-kiwi python-pygoocanvas \
	python-gnome2 python-gnomedesktop python-rsvg		python-gnome2 python-gnomedesktop python-rsvg

	Optionally, you may install Interactive Python in order to have a Console button in the visualizer GUI:		Optionally, you may install Interactive Python in order to have a Console button in the visualizer GUI:

	sudo apt-get install ipython		sudo apt-get install ipython

	Configure and build your ns-3 tree as usual~~. WARNING:~~ make sure NS-3 Python bindings are ''enabled''; pyviz will not work without Python bindings!		On Fedora/RedHat, do:

			yum install python-devel gnome-python2 gnome-python2-gnomedesktop gnome-python2-rsvg graphviz-python pygoocanvas python-kiwi

			Configure and build your ns-3 tree as usual, and make sure NS-3 Python bindings are ''enabled''; '''pyviz will not work without Python bindings'''!

	You can test the visualizer for example with the FlowMonitor sample program:		You can test the visualizer for example with the FlowMonitor sample program:

	./waf --pyrun src~~/contrib~~/flow-monitor/examples/wifi-olsr-flowmon.py --~~vis~~		./waf --pyrun src/flow-monitor/examples/wifi-olsr-flowmon.py --visualize

	And the result should be something similar to the screenshot below:		And the result should be something similar to the screenshot below:
Line 24:		Line 32:
	[[File:Pyviz-flowmon.png]]		[[File:Pyviz-flowmon.png]]

	== ~~Installation for~~ ns < 3.10 ==		== ns < 3.10 ==

	For earlier ns-3 versions, PyViz is found on a separate branch. There are multiple branches of PyViz, merged with different versions of NS-3:		For earlier ns-3 versions, PyViz is found on a separate branch. There are multiple branches of PyViz, merged with different versions of NS-3:

GustavoCarneiro: /* ns >= 3.11 */

2011-06-03T10:39:53Z

ns >= 3.11

← Older revision		Revision as of 10:39, 3 June 2011
Line 40:		Line 40:

	In ns 3.11, because it is modular, you first need to add the 'visualizer' module to your program, as dependency. Then the --vis waf option works as in ns 3.10.		In ns 3.11, because it is modular, you first need to add the 'visualizer' module to your program, as dependency. Then the --vis waf option works as in ns 3.10.

			Example:


			diff -r fbeb6b1cca20 src/olsr/examples/wscript
			--- a/src/olsr/examples/wscript Thu Jun 02 09:21:24 2011 -0700
			+++ b/src/olsr/examples/wscript Fri Jun 03 11:25:14 2011 +0100
			@@ -2,7 +2,7 @@

			def build(bld):
			obj = bld.create_ns3_program('simple-point-to-point-olsr',
			- ['point-to-point', 'internet', 'olsr', 'applications', 'wifi'])
			+ ['point-to-point', 'internet', 'olsr', 'applications', 'wifi', 'visualizer'])
			obj.source = 'simple-point-to-point-olsr.cc'

			obj = bld.create_ns3_program('olsr-hna',

	== ns 3.10 ==		== ns 3.10 ==

GustavoCarneiro: /* Enabling the visualizer in your own simulation */

2011-04-04T23:40:32Z

Enabling the visualizer in your own simulation

← Older revision		Revision as of 23:40, 4 April 2011
Line 37:		Line 37:

	= Enabling the visualizer in your own simulation =		= Enabling the visualizer in your own simulation =
			== ns >= 3.11 ==

	== ns >= 3.10 ==		In ns 3.11, because it is modular, you first need to add the 'visualizer' module to your program, as dependency. Then the --vis waf option works as in ns 3.10.

			== ns 3.10 ==

	For Python simulations, there is an API to start the visualizer. You have to import the visualizer module, and call visualizer.start() instead of ns3.Simulator.Run(). For C++ simulations, there is no API. For C++ simulations (but also works for Python ones) you need to set the GlobalValue <tt>SimulatorImplementationType</tt> to <tt>"ns3::VisualSimulatorImpl"</tt>. This can be set from the command-line, for example (add the <tt>--SimulatorImplementationType=ns3::VisualSimulatorImpl</tt> option), or via the waf option <tt>--visualize</tt>, in addition to the usual <tt>--run</tt> option to run programs.		For Python simulations, there is an API to start the visualizer. You have to import the visualizer module, and call visualizer.start() instead of ns3.Simulator.Run(). For C++ simulations, there is no API. For C++ simulations (but also works for Python ones) you need to set the GlobalValue <tt>SimulatorImplementationType</tt> to <tt>"ns3::VisualSimulatorImpl"</tt>. This can be set from the command-line, for example (add the <tt>--SimulatorImplementationType=ns3::VisualSimulatorImpl</tt> option), or via the waf option <tt>--visualize</tt>, in addition to the usual <tt>--run</tt> option to run programs.

GustavoCarneiro: /* ns >= 3.10 */

2011-04-03T11:31:45Z

ns >= 3.10

← Older revision		Revision as of 11:31, 3 April 2011
Line 40:		Line 40:
	== ns >= 3.10 ==		== ns >= 3.10 ==

	For Python simulations, there is an API to start the visualizer. You have to import the visualizer module, and call visualizer.start() instead of ns3.Simulator.Run(). For C++ simulations, there is no API. For C++ simulations (but also works for Python ones) you need to set the GlobalValue <tt>SimulatorImplementationType</tt> to <tt>"ns3::VisualSimulatorImpl"</tt>. This can be set from the command-line, for example (add the <tt>--SimulatorImplementationType=ns3::VisualSimulatorImpl</tt> option), or via the waf option <tt>--~~visualizer~~</tt>, in addition to the usual <tt>--run</tt> option to run programs.		For Python simulations, there is an API to start the visualizer. You have to import the visualizer module, and call visualizer.start() instead of ns3.Simulator.Run(). For C++ simulations, there is no API. For C++ simulations (but also works for Python ones) you need to set the GlobalValue <tt>SimulatorImplementationType</tt> to <tt>"ns3::VisualSimulatorImpl"</tt>. This can be set from the command-line, for example (add the <tt>--SimulatorImplementationType=ns3::VisualSimulatorImpl</tt> option), or via the waf option <tt>--visualize</tt>, in addition to the usual <tt>--run</tt> option to run programs.


	== ns before 3.10 ==		== ns before 3.10 ==