What is f2py used for while building numpy source?
OK, after a bit of poking around I think I've confirmed a few of my initial suspicions
First:
So none other than
f2py
itself uses Fortran.
As I mentioned in the comments, all of the Fortran source files the OP is referring to are in /test/
or /doc/
directories, and I therefore suspect that they are for testing and documenting f2py
(and numpy.distutils
, which uses f2py
). A glance at a few of the source files seems to confirm this impression. f2py
itself looks like it's written in Python and C.
I looked into the linear algebra modules. For LAPACK, there is a make_lite.py file which extracts only the necessary subroutines from a LAPACK source tree, and converts them into C using
f2c
This seemed strange to me, since I don't actually have f2c
installed (or Plex
, which is another library that seems to be required by make_lite.py
). I decided to stick an extra line in main()
to show whether make_lite.py
actually gets used during a normal install:
...
def main():
# let's see if you're actually doing anything
import subprocess; subprocess.call(['touch', '/tmp/hello_from_make_lite'])
...
Sure enough, after installing numpy in a clean virtualenv there is no hello_from_make_lite
file in my /tmp/
, indicating that make_lite.main()
never executed. Take a look at numpy/linalg/lapack_lite/README
:
The
numpy/linalg/blas_lite.c
,numpy/linalg/dlapack_lite.c
, andnumpy/linalg/zlapack_lite.c
aref2c
'd versions of the LAPACK routines required by theLinearAlgebra
module, and wrapped by thelapack_lite
module. The scripts in this directory can be used to create these files automatically from a directory of LAPACK source files.
So numpy is already distributed with these f2c
'd C source files - there's no need to use make_lite.py
unless you're a dev wanting to update these functions from a new version of the LAPACK library.
So when exactly during the creation of NumPy was it convenient to create
f2py
?
As far as I can tell, f2py
doesn't get used at all during a normal numpy install. Again, I stuck an extra line in f2py2e.main()
:
...
def main():
import subprocess; subprocess.call(['touch', '/tmp/hello_from_f2py2e'])
...
And again, /tmp/hello_from_f2py2e
doesn't exist after a normal install of numpy.
So what is f2py
actually used for? Check out the scipy source tree, and from its root call
$ find . -iname *.f*
You'll see loads and loads of important-looking Fortran files, including fftpack
, odepack
, arpack
, fitpack
, etc. I suspect that f2py
is mainly required to wrap the Fortran extensions for scipy rather than numpy.
I might be wrong, though - perhaps one of the numpy or scipy devs will set me straight.
Update
Actually, I think f2py
is not actually required during a normal installation of scipy either! If you take a look in the source directory for one of the Fortran modules, e.g. fftpack
, you'll see that it already contains .pyf
files, which would normally be automatically generated by f2py
and define the interfaces for the Fortran functions (see here).
I think the deal is that f2py
was used to initially generate the .pyf
wrappers for the Fortran functions, but these .pyf
files are distributed along with the rest of the source tree so that it's unnecessary to run f2py
again during the normal build process.