comparison README @ 57:87b9ea6fc7d0

* Document VAMPY_PYLIB and NUMPY_SHORTVERSION
author cannam
date Fri, 09 Oct 2009 14:35:08 +0000
parents c1e4f706ca9a
children 62dcaa5fe6f8
comparison
equal deleted inserted replaced
56:b2c4c752c3bc 57:87b9ea6fc7d0
89 self.vampy_flags = vf_DEBUG | vf_ARRAY | vf_REALTIME 89 self.vampy_flags = vf_DEBUG | vf_ARRAY | vf_REALTIME
90 90
91 91
92 ENVIRONMENT VARIABLES: 92 ENVIRONMENT VARIABLES:
93 93
94 Vampy recognises two optional environment variables: 94 Vampy recognises three optional environment variables:
95 95
96 VAMPY_COMPILED=1 recognise byte compiled python plugins (default) 96 VAMPY_COMPILED=1 recognise byte compiled python plugins (default)
97 VAMPY_COMPILED=0 ignore them 97 VAMPY_COMPILED=0 ignore them
98
98 VAMPY_EXTPATH: if given, searches this path for vampy plugins. 99 VAMPY_EXTPATH: if given, searches this path for vampy plugins.
99 (This is useful if you want to keep your python plugins separate.) 100 (This is useful if you want to keep your python plugins separate.)
100 Only a single fully qualified path name is recognised. 101 Only a single absolute path name is recognised.
101 102
102 Example: 103 Example:
103 export VAMPY_EXTPATH="/Users/Shared/Development/vampy-path" 104 export VAMPY_EXTPATH="/Users/Shared/Development/vampy-path"
105
106 VAMPY_PYLIB: path to the Python shared library to be preloaded
107 before scripts are run. The preload is necessary on some
108 systems to support plugins that load additional Python modules.
109 Vampy will attempt to preload the right library by default, but
110 it sometimes fails; if so, set this variable to override it.
104 111
105 112
106 COMPILING AND LINKING: 113 COMPILING AND LINKING:
107 114
108 Please use the make files provided. 115 Please use the make files provided.
111 118
112 119
113 COMPILER OPTIONS: 120 COMPILER OPTIONS:
114 121
115 HAVE_NUMPY : compile with Numpy array interface support 122 HAVE_NUMPY : compile with Numpy array interface support
123
124 NUMPY_SHORTVERSION : set to the minimum version of Numpy you have, as
125 a floating-point value; the default is 1.1, which should be OK for
126 use with Numpy 1.1, 1.2 and 1.3
116 127
117 for developers: 128 for developers:
118 _DEBUG : print very detailed messages and logs while Vampy is in use 129 _DEBUG : print very detailed messages and logs while Vampy is in use
119 _DEBUG_VALUES : print all converted values to stderr 130 _DEBUG_VALUES : print all converted values to stderr
120 131