=======================
Notes on testing Mayavi
=======================


This directory contains unit tests for mayavi.

Running the tests
=================

The best way to run the tests in this directory is to do::

 $ nosetests

You may also run each test individually.  For example::

 $ python test_contour.py

===================================
DEBUGGING USING ON SCREEN RENDERING
===================================

These unit tests run off screen and make use of TestEngine.

TestEngine can be replaced by Engine to allow for scene creation
which may be useful in debuggine.

This can be easily done by uncommenting the following line from the setUp() functions

	e = Engine() // THis is commented by default

It must be followed by the commenting of :
	
	e = TestEngine() // This is uncommented by default

===================================
DEBUGGING USING IPython Shell
===================================

The IPython Shell can be embedded anywhere in the program.

You need to import IPython module and then add the following lines wherver you want to embed the shell:

	embedshell = IPython.Shell.IPShellEmbed()
	embedshell()
	



