--- name: "f2py" section: "1" platform: "macos" package: "python_modules" version: "92" release: "macOS 26.5" platforms: ["linux", "macos"] url: "https://new.carta.tech/f2py" --- # f2py(1) Fortran to Python interface generator ## NAME f2py - Fortran to Python interface generator ## SYNOPSIS (1) To construct extension module sources: **f2py** \[\\] \ \[\[\[only:\]\|\|\[skip:\]\] \ \] \[: \ ...\] (2) To compile fortran files and build extension modules: **f2py** -c \[\, \, \\] \ (3) To generate signature files: **f2py** -h \ ...\< same options as in (1) \> ## DESCRIPTION This program generates a Python C/API file (\module.c) that contains wrappers for given Fortran or C functions so that they can be called from Python. With the -c option the corresponding extension modules are built. ## OPTIONS - **-h \** Write signatures of the fortran routines to file \ and exit. You can then edit \ and use it instead of \. If \==stdout then the signatures are printed to stdout. - **\** Names of fortran routines for which Python C/API functions will be generated. Default is all that are found in \. - **skip:** Ignore fortran functions that follow until \`:'. - **only:** Use only fortran functions that follow until \`:'. - **:** Get back to \ mode. - **-m \** Name of the module; f2py generates a Python/C API file \module.c or extension module \. Default is ´untitled´. - **--\[no-\]lower** Do \[not\] lower the cases in \. By default, --lower is assumed with -h key, and --no-lower without -h key. - **--build-dir \** All f2py generated files are created in \. Default is tempfile.mktemp(). - **--overwrite-signature** Overwrite existing signature file. - **--\[no-\]latex-doc** Create (or not) \module.tex. Default is --no-latex-doc. - **--short-latex** Create 'incomplete' LaTeX document (without commands \\documentclass, \\tableofcontents, and \\begin{document}, \\end{document}). - **--\[no-\]rest-doc** Create (or not) \module.rst. Default is --no-rest-doc. - **--debug-capi** Create C/API code that reports the state of the wrappers during runtime. Useful for debugging. - **-include´\´** Add CPP #include statement to the C/API code. \ should be in the format of either \`"filename.ext"' or \`\'. As a result \ will be included just before wrapper functions part in the C/API code. The option is depreciated, use \`usercode\` statement in signature files instead. - **--\[no-\]wrap-functions** Create Fortran subroutine wrappers to Fortran 77 functions. --wrap-functions is default because it ensures maximum portability/compiler independence. - **--help-link \[..\]** List system resources found by system\_info.py. \[..\] may contain a list of resources names. See also --link-\ switch below. - **--quiet** Run quietly. - **--verbose** Run with extra verbosity. - **-v** Print f2py version ID and exit. - **--include\_paths path1:path2:...** Search include files (that f2py will scan) from the given directories. ## CONFIG\_FC OPTIONS The following options are effective only when -c switch is used. - **--help-compiler** List available Fortran compilers \[DEPRECIATED\]. - **--fcompiler=\** Specify Fortran compiler type by vendor. - **--compiler=\** Specify C compiler type (as defined by distutils) - **--fcompiler-exec=\** Specify the path to F77 compiler \[DEPRECIATED\]. - **--f90compiler-exec=\** Specify the path to F90 compiler \[DEPRECIATED\]. - **--help-fcompiler** List available Fortran compilers and exit. - **--f77exec=\** Specify the path to F77 compiler. - **--f90exec=\** Specify the path to F90 compiler. - **--f77flags="..."** Specify F77 compiler flags. - **--f90flags="..."** Specify F90 compiler flags. - **--opt="..."** Specify optimization flags. - **--arch="..."** Specify architecture specific optimization flags. - **--noopt** Compile without optimization. - **--noarch** Compile without arch-dependent optimization. - **--debug** Compile with debugging information. ## EXTRA OPTIONS The following options are effective only when -c switch is used. - **--link-\** Link extension module with \ as defined by numpy\_distutils/system\_info.py. E.g. to link with optimized LAPACK libraries (vecLib on MacOSX, ATLAS elsewhere), use --link-lapack\_opt. See also --help-link switch. - **-L/path/to/lib/ -l\** - **-D\ -U\ -I/path/to/include/** - **\.o \.so \.a** - **-DPREPEND\_FORTRAN -DNO\_APPEND\_FORTRAN -DUPPERCASE\_FORTRAN -DUNDERSCORE\_G77** Macros that might be required with non-gcc Fortran compilers. - **-DF2PY\_REPORT\_ATEXIT** To print out a performance report of F2PY interface when python exits. Available for Linux. - **-DF2PY\_REPORT\_ON\_ARRAY\_COPY=\** To send a message to stderr whenever F2PY interface makes a copy of an array. Integer \ sets the threshold for array sizes when a message should be shown. ## REQUIREMENTS Python 1.5.2 or higher (2.x is supported). Numerical Python 13 or higher (20.x,21.x,22.x,23.x are supported). Optional Numarray 0.9 or higher partially supported. numpy\_distutils from Scipy (can be downloaded from F2PY homepage) ## SEE ALSO [python(1)](/python/1.md) ## BUGS For instructions on reporting bugs, see http://cens.ioc.ee/projects/f2py2e/FAQ.html ## AUTHOR Pearu Peterson \ ## INTERNET RESOURCES Main website: http://cens.ioc.ee/projects/f2py2e/ User's Guide: http://cens.ioc.ee/projects/f2py2e/usersguide/ Mailing list: http://cens.ioc.ee/mailman/listinfo/f2py-users/ Scipy website: http://www.numpy.org ## COPYRIGHT Copyright (c) 1999, 2000, 2001, 2002, 2003, 2004, 2005 Pearu Peterson ## LICENSE NumPy License ## VERSION 2\.45.241