我正在用Python封装一个Fortran模块。我选择使用Cython来做。我的问题是在Python中传递一个 np.ndarray
到Fortran。我能够收到一个 np.ndarray
但我所有的尝试都没有成功。
我发现,问题直接出在Cython-Fortran的接口上,因为我的Fotran子程序工作正常(没有数据也能正常工作)。Cython那边似乎也能正常工作,我可以在那边操作变量。
我的最小工作实例。
PATTERN_wrap.f90
module PATTERN_wrap
use iso_c_binding, only: c_float, c_double, c_short, c_int
implicit none
CONTAINS
subroutine c_pattern(scalar_variable, array_variable, return_array) bind(c)
implicit NONE
INTEGER(c_int), intent(in) :: scalar_variable
INTEGER(c_int), intent(in), DIMENSION(10, 15) :: array_variable
REAL(c_float), INTENT(OUT), DIMENSION(10) :: return_array
write(*,*) "start fortran"
write(*,*) "scalar_variable"
write(*,*) scalar_variable
write(*,*) "array_variable"
write(*,*) array_variable
return_array = 3
write(*,*) "end fortran"
! call DO_PATTERN(&
! scalar_variable=scalar_variable, &
! array_variable=array_variable, &
! return_array=return_array)
!
end subroutine
end module PATTERN_wrap
注:调用子程序 DO_PATTERN
实际上做了一些事情的代码被注释掉了,因为它在此刻并不相关。我只是想指出,上面的代码是一个包装器。
pattern.pyx
#cython: language_level=3
import cython
import numpy as np
cimport numpy as np
cdef extern:
void c_pattern(
int *scalar_variable,
int *array_variable,
float *return_array
)
def run_pattern(
int scalar_variable,
):
cdef:
np.ndarray[int, ndim=2, mode="fortran"] array_variable = np.ones((10,15), dtype=np.int32, order='F')
np.ndarray[float, ndim=1, mode="fortran"] return_array = np.zeros(10, dtype=np.float32, order='F')
c_pattern(
&scalar_variable,
&array_variable[0,0],
&return_array[0],
)
print('Cython side')
print(return_array)
return return_array
setup.py
from distutils.core import setup
from distutils.extension import Extension
from Cython.Distutils import build_ext
import numpy
npy_include_dir = numpy.get_include()
ext_modules = [Extension("pattern", ["pattern.pyx"],
include_dirs = [npy_include_dir],
libraries = ['gfortran', 'fftw3'], # need to include gfortran as a library
extra_link_args=[
"PATTERN_wrap.o"
])]
setup(name = 'pattern',
cmdclass = {'build_ext': build_ext},
ext_modules = ext_modules)
我在编译我的fortran代码时使用了
gfortran -Wall -fbounds-check -lm -g -fbacktrace -fcheck=all -Wall -ffpe-trap=zero,invalid,overflow -fPIC -L/usr/lib/ -lfftw3 -L/usr/lib/ -lfftw3 -c PATTERN_wrap.f90
和编译Cython代码,用 python -m pip install .
或 python setup.py build_ext --inplace
. 这似乎没有任何区别。
我测试了这个包。
$ python -c "import pattern; pattern.run_pattern(2);"
start fortran
scalar_variable
2
array_variable
end fortran
Cython side
[3. 3. 3. 3. 3. 3. 3. 3. 3. 3.]
如你所见,标量被正确地传给了Fortran, 返回数组也被正确地传回给了Cython. 唯一不行的是把数组从Cython传到Fortran。简而言之,应该有一个由1组成的二维数组,打印在 array_variable
.
除了上面的MWE,我还尝试了不同的方法。
将数组与 <int*> array_variable.data
这一点是被Cython所不鼓励的(https:/github.comcythoncythonwikitutorials-NumpyPointerToC。)
创建变量为Fortran连续的MemoryView。int[::1,:] array_variable = np.ones((10,15), dtype=np.int32, order='F')
.
我所有的尝试都和MWE一样失败了。
我也试过使用头文件,但没有任何区别。这里以头文件为例。Fortran - Cython Workflow 这个问题本身并不包含我的问题的答案--那里只有标量被传递给Fortran。
我还想说的是,当我用f2py编译一个包时,同样的封装程序和所有底层文件都能正常工作。子程序也可以在原来的Fortran程序中工作。
EDIT.我的开发环境是在dock中运行的。
我的开发环境是在docker中运行的。基本镜像是 continuumio/miniconda3:4.8.2
我在那里测试了gfortran-8和gfortran-9,以及启用fortran的hdf5编译器。结果都是一样的。
我决定在我的主机系统Ubuntu 18.04上用gccgfortran 7.50运行我的测试。它确实能正常工作。于是我又尝试了不同的gcc版本。
我测试了图像。
运行它们时,使用了:
docker run --rm -v ~/minimum_working_example:/mwe -it gcc:7 /bin/bash
然后
apt update && apt install python3-pip -yy && cd /mwe && python3 -m pip install cython numpy && make && python3 setup.py build_ext --inplace && python3 -c "import pattern; pattern.run_pattern(2);" && rm -rf build/ *.so *.c *.mod *.o
在所有这些图片上,我的代码都能正常工作。
EDIT2:
我刚刚在裸图上进行了测试 continuumio/miniconda3:4.8.2
用同样的测试命令(添加了apt install gfortran,因为默认情况下没有fortran),代码就能用了。
我重建了我的镜像,并以同样的方式进行测试。它不工作...
我设法找到了解决方案。代码是好的。 问题出在我的配置上。
如上所述,我测试了gccgfortran的不同配置,看看是否会影响Cython化。因此,我继续拆解我的Dockerfile,以便找到导致代码崩溃的步骤。结果发现,是conda安装numpy的问题。
我上面所有的ggc镜像测试都是用pip做的。
$ python -m pip install numpy
Collecting numpy
Downloading numpy-1.18.4-cp38-cp38-manylinux1_x86_64.whl (20.7 MB)
|████████████████████████████████| 20.7 MB 18.9 MB/s
Installing collected packages: numpy
Successfully installed numpy-1.18.4
一个包,一个轮子,简单快捷。然而,我在我的 "生产 "镜像中使用的是conda。
如果你用conda安装numpy。
$ conda install numpy
Collecting package metadata (current_repodata.json): done
Solving environment: done
## Package Plan ##
environment location: /opt/conda
added / updated specs:
- numpy
The following packages will be downloaded:
package | build
---------------------------|-----------------
blas-1.0 | mkl 6 KB
intel-openmp-2020.1 | 217 780 KB
libgfortran-ng-7.3.0 | hdf63c60_0 1006 KB
mkl-2020.1 | 217 129.0 MB
mkl-service-2.3.0 | py38he904b0f_0 62 KB
mkl_fft-1.0.15 | py38ha843d7b_0 159 KB
mkl_random-1.1.1 | py38h0573a6f_0 341 KB
numpy-1.18.1 | py38h4f9e942_0 5 KB
numpy-base-1.18.1 | py38hde5b4d6_1 4.2 MB
------------------------------------------------------------
Total: 135.5 MB
...
要注意的是,除了numpy之外,conda还安装了... ... libgfortran-ng-7.3.0
. 在我工作的镜像中,安装了gccgfortran 8.5.0。
为什么这很重要?当你运行cython编译时。
$ python setup.py build_ext --inplace
running build_ext
cythoning pattern.pyx to pattern.c
building 'pattern' extension
creating build
creating build/temp.linux-x86_64-3.8
gcc -pthread -B /opt/conda/compiler_compat -Wl,--sysroot=/ -Wsign-compare -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC -I/opt/conda/lib/python3.8/site-packages/numpy/core/include -I/opt/conda/include/python3.8 -c pattern.c -o build/temp.linux-x86_64-3.8/pattern.o
In file included from /opt/conda/lib/python3.8/site-packages/numpy/core/include/numpy/ndarraytypes.h:1832,
from /opt/conda/lib/python3.8/site-packages/numpy/core/include/numpy/ndarrayobject.h:12,
from /opt/conda/lib/python3.8/site-packages/numpy/core/include/numpy/arrayobject.h:4,
from pattern.c:599:
/opt/conda/lib/python3.8/site-packages/numpy/core/include/numpy/npy_1_7_deprecated_api.h:17:2: warning: #warning "Using deprecated NumPy API, disable it with " "#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION" [-Wcpp]
#warning "Using deprecated NumPy API, disable it with " \
^~~~~~~
gcc -pthread -shared -B /opt/conda/compiler_compat -L/opt/conda/lib -Wl,-rpath=/opt/conda/lib -Wl,--no-as-needed -Wl,--sysroot=/ build/temp.linux-x86_64-3.8/pattern.o -lgfortran -o /mwe/pattern.cpython-38-x86_64-linux-gnu.so PATTERN_wrap.o
如你所见,在列表行中,传递给gcc的包括有: /opt/conda/lib
.
$ ls /opt/conda/lib | grep "fortran"
libgfortran.so
libgfortran.so.4
libgfortran.so.4.0.0
在这里,它是。libgfortran
在不同的版本中,我最初编译我的代码。
解决办法是。
$ conda install -c conda-forge libgfortran-ng==8.2.0
注意: 使用conda-forge通道是必要的, 在我的例子中, conda无法解决仅来自基本通道的包的依赖关系. 而且,这个版本的libgfortran-ng还需要把libblas从openblas版本改成mkl,如果你担心的话。
这样,我在conda中安装了一个和我系统中使用的主要版本相同的libgfortran。重新编译Cython化的包后,一切都正常了。
总之,要小心conda。
PS:感谢@DawidW的反馈和对我代码的测试。