|
| 1 | +Metadata-Version: 2.2 |
| 2 | +Name: mkl_fft |
| 3 | +Version: 1.3.11 |
| 4 | +Summary: MKL-based FFT transforms for NumPy arrays |
| 5 | +Home-page: http://github.com/IntelPython/mkl_fft |
| 6 | +Download-URL: http://github.com/IntelPython/mkl_fft |
| 7 | +Author: Intel Corporation |
| 8 | +Maintainer: Intel Corp. |
| 9 | +Maintainer-email: [email protected] |
| 10 | +License: BSD |
| 11 | +Keywords: DFTI,FFT,Fourier,MKL |
| 12 | +Platform: Windows |
| 13 | +Platform: Linux |
| 14 | +Platform: Mac OS-X |
| 15 | +Classifier: Development Status :: 5 - Production/Stable |
| 16 | +Classifier: Intended Audience :: Science/Research |
| 17 | +Classifier: Intended Audience :: Developers |
| 18 | +Classifier: License :: OSI Approved |
| 19 | +Classifier: Programming Language :: C |
| 20 | +Classifier: Programming Language :: Python |
| 21 | +Classifier: Programming Language :: Python :: 3 |
| 22 | +Classifier: Programming Language :: Python :: 3.9 |
| 23 | +Classifier: Programming Language :: Python :: 3.10 |
| 24 | +Classifier: Programming Language :: Python :: 3.11 |
| 25 | +Classifier: Programming Language :: Python :: 3.12 |
| 26 | +Classifier: Programming Language :: Python :: Implementation :: CPython |
| 27 | +Classifier: Topic :: Software Development |
| 28 | +Classifier: Topic :: Scientific/Engineering |
| 29 | +Classifier: Operating System :: Microsoft :: Windows |
| 30 | +Classifier: Operating System :: POSIX |
| 31 | +Classifier: Operating System :: Unix |
| 32 | +Classifier: Operating System :: MacOS |
| 33 | +Requires-Python: >=3.7 |
| 34 | +Description-Content-Type: text/markdown |
| 35 | +License-File: LICENSE.txt |
| 36 | +Requires-Dist: numpy>=1.16 |
| 37 | +Requires-Dist: mkl |
| 38 | +Dynamic: author |
| 39 | +Dynamic: classifier |
| 40 | +Dynamic: description |
| 41 | +Dynamic: description-content-type |
| 42 | +Dynamic: download-url |
| 43 | +Dynamic: home-page |
| 44 | +Dynamic: keywords |
| 45 | +Dynamic: license |
| 46 | +Dynamic: maintainer |
| 47 | +Dynamic: maintainer-email |
| 48 | +Dynamic: platform |
| 49 | +Dynamic: requires-dist |
| 50 | +Dynamic: requires-python |
| 51 | +Dynamic: summary |
| 52 | + |
| 53 | +## ``mkl_fft`` -- a NumPy-based Python interface to Intel (R) MKL FFT functionality |
| 54 | +[](https://github.com/IntelPython/mkl_fft/actions/workflows/conda-package.yml) |
| 55 | +[](https://github.com/IntelPython/mkl_fft/actions/workflows/build_pip.yaml) |
| 56 | +[](https://github.com/IntelPython/mkl_fft/actions/workflows/conda-package-cf.yml) |
| 57 | + |
| 58 | +`mkl_fft` started as a part of Intel (R) Distribution for Python* optimizations to NumPy, and is now being released |
| 59 | +as a stand-alone package. It can be installed into conda environment using |
| 60 | + |
| 61 | +``` |
| 62 | + conda install -c https://software.repos.intel.com/python/conda mkl_fft |
| 63 | +``` |
| 64 | + |
| 65 | +or from conda-forge channel: |
| 66 | + |
| 67 | +``` |
| 68 | + conda install -c conda-forge mkl_fft |
| 69 | +``` |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +To install mkl_fft Pypi package please use following command: |
| 74 | + |
| 75 | +``` |
| 76 | + python -m pip install --index-url https://software.repos.intel.com/python/pypi --extra-index-url https://pypi.org/simple mkl_fft |
| 77 | +``` |
| 78 | + |
| 79 | +If command above installs NumPy package from the Pypi, please use following command to install Intel optimized NumPy wheel package from Intel Pypi Cloud: |
| 80 | + |
| 81 | +``` |
| 82 | + python -m pip install --index-url https://software.repos.intel.com/python/pypi --extra-index-url https://pypi.org/simple mkl_fft numpy==<numpy_version> |
| 83 | +``` |
| 84 | + |
| 85 | +Where `<numpy_version>` should be the latest version from https://software.repos.intel.com/python/conda/ |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +Since MKL FFT supports performing discrete Fourier transforms over non-contiguously laid out arrays, MKL can be directly |
| 90 | +used on any well-behaved floating point array with no internal overlaps for both in-place and not in-place transforms of |
| 91 | +arrays in single and double floating point precision. |
| 92 | + |
| 93 | +This eliminates the need to copy input array contiguously into an intermediate buffer. |
| 94 | + |
| 95 | +`mkl_fft` directly supports N-dimensional Fourier transforms. |
| 96 | + |
| 97 | +More details can be found in SciPy 2017 conference proceedings: |
| 98 | + https://github.com/scipy-conference/scipy_proceedings/tree/2017/papers/oleksandr_pavlyk |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +It implements the following functions: |
| 103 | + |
| 104 | +### Complex transforms, similar to those in `scipy.fftpack`: |
| 105 | + |
| 106 | +`fft(x, n=None, axis=-1, overwrite_x=False)` |
| 107 | + |
| 108 | +`ifft(x, n=None, axis=-1, overwrite_x=False)` |
| 109 | + |
| 110 | +`fft2(x, shape=None, axes=(-2,-1), overwrite_x=False)` |
| 111 | + |
| 112 | +`ifft2(x, shape=None, axes=(-2,-1), overwrite_x=False)` |
| 113 | + |
| 114 | +`fftn(x, n=None, axes=None, overwrite_x=False)` |
| 115 | + |
| 116 | +`ifftn(x, n=None, axes=None, overwrite_x=False)` |
| 117 | + |
| 118 | +### Real transforms |
| 119 | + |
| 120 | +`rfft(x, n=None, axis=-1, overwrite_x=False)` - real 1D Fourier transform, like `scipy.fftpack.rfft` |
| 121 | + |
| 122 | +`rfft_numpy(x, n=None, axis=-1)` - real 1D Fourier transform, like `numpy.fft.rfft` |
| 123 | + |
| 124 | +`rfft2_numpy(x, s=None, axes=(-2,-1))` - real 2D Fourier transform, like `numpy.fft.rfft2` |
| 125 | + |
| 126 | +`rfftn_numpy(x, s=None, axes=None)` - real ND Fourier transform, like `numpy.fft.rfftn` |
| 127 | + |
| 128 | +... and similar `irfft*` functions. |
| 129 | + |
| 130 | + |
| 131 | +The package also provides `mkl_fft._numpy_fft` and `mkl_fft._scipy_fft` interfaces which provide drop-in replacements for equivalent functions in NumPy and SciPy respectively. |
| 132 | + |
| 133 | +--- |
| 134 | + |
| 135 | +To build ``mkl_fft`` from sources on Linux: |
| 136 | + - install a recent version of MKL, if necessary; |
| 137 | + - execute ``source /path/to/mklroot/bin/mklvars.sh intel64`` ; |
| 138 | + - execute ``pip install .`` |
0 commit comments