API Reference for Enthought Tool Suite 3.0.1
This module helps customize the mayavi install. It tries to import any site_mayavi.py (anywhere on sys.path) or user_mayavi.py. The user_mayavi.py script is found in the users ~/.mayavi2 directory and this directory is also injected into the path.
It is the users responsibility to import the mayavi registry (enthought.mayavi.registry:registry) and register any new modules or filters into mayavi using suitable metadata.
If the user desires to contribute any plugins then they may expose a function called get_plugins() which returns a list of plugins that they wish to add to the default mayavi envisage app. The user may expose one set of global plugins in the site_mayavi module and another in the user_mayavi module without any problems.
The function get_custom_plugins returns a list of all the available custom plugins.
home = get_home_directory()
m2dir = join(home, '.mayavi2')
user_module = join(m2dir, 'user_mayavi.py')
Convenience function that returns all customization plugins as a list.
| Local name | Refers to |
|---|---|
| exists | os.path.exists |
| get_home_directory | enthought.util.home_directory.get_home_directory |
| join | os.path.join |
| sys | sys |
© Copyright 2002-2008 Enthought, Inc.