[Scipy-svn] r4481 - trunk/scipy/sandbox/mkufunc

[scipy-svn at scipy.org]

Author: ilan
Date: 2008-06-25 11:12:15 -0500 (Wed, 25 Jun 2008)
New Revision: 4481

Added:
   trunk/scipy/sandbox/mkufunc/README.txt
Log:
Added readme file

Added: trunk/scipy/sandbox/mkufunc/README.txt
===================================================================
--- trunk/scipy/sandbox/mkufunc/README.txt	2008-06-25 15:59:50 UTC (rev 4480)
+++ trunk/scipy/sandbox/mkufunc/README.txt	2008-06-25 16:12:15 UTC (rev 4481)
@@ -0,0 +1,19 @@
+
+mkufunc (make universal function) is a tool which lets you create
+a C compiled version of a universal function (UFunc).
+
+It works by translating the python function into C and then uses
+scipy.weave to create a UFunc which calls the appropriate C function
+in the inner 1-d loop.  This means that there are no Python calls
+when the calculation is performed, making the calculation
+fast (in particular when the arrays involved in the calculation
+are very large).
+
+Requirements:
+
+  pypy
+
+You need the pypy path in your PYTHONPATH environment:
+
+$ export PYTHONPATH=/giant/src/pypy-dist
+