https://github.com/lcav/mkl_fft

Python wrappers for Intel MKL FFT routines
https://github.com/lcav/mkl_fft

Last synced: 7 months ago
JSON representation

Python wrappers for Intel MKL FFT routines

• Host: GitHub
• URL: https://github.com/lcav/mkl_fft
• Owner: LCAV
• Created: 2015-11-24T11:01:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-12-11T14:47:51.000Z (over 8 years ago)
• Last Synced: 2025-04-15T12:17:25.620Z (about 1 year ago)
• Language: Python
• Size: 29.3 KB
• Stars: 1
• Watchers: 11
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# mklfft

__This package has been obsoleted by the development of a proper wrapper around MKL FFT directly by the good people of Intel. Please use [their package](https://github.com/IntelPython/mkl_fft) instead.__

This is a wrapper around the Intel Math Kernel Library FFT. It is very fast.

### Authors

* Ivan Dokmanić

* Robin Scheibler

### Setup the library

It might be necessary to setup an environment variable with location of

the shared library

    export LIBMKL=$HOME/anaconda/lib/libmkl_rt.dylib

for example with anaconda installed in the home directory. This should be adapted to your setup.

### Use the library

The library has a syntax similar to that of numpy.

It supports

* In-place and out-of-place transforms

* Scrambled or unscrambled output 

* Orthogonal or standard normalization

* 1D FFT, including multiple FFTs on arbitrary dimension of a multidimensional array

* 2D FFT

* Real or complex data

### Test

There are unit tests for `fft`, `ifft`, `rfft`, and `irfft`.

    nosetests

There is also a speed test

    python ./mklfft/tests/test_speed.py

### License

    Copyright (c) 2016 Ivan Dokmanić, Robin Scheibler

    Permission is hereby granted, free of charge, to any person obtaining a copy of

    this software and associated documentation files (the "Software"), to deal in

    the Software without restriction, including without limitation the rights to

    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies

    of the Software, and to permit persons to whom the Software is furnished to do

    so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all

    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

    SOFTWARE.