Part of a Python framework that allows a user to GPU accelerate their Python code with cuFFT. An object is created that handles the interface between Python and cuFFT. This object is part of a larger container within the cuda_manager. Thus, while this repo may be used standalone, it is recommended it be downloaded with cuda_manager. Doing a recursive clone on cuda_manager will also clone cufft_helpers.
cuBLAS functions are supported as they become needed by the user. Thus, currently not all functions are available out of the box. When a user needs a new function, it may be added to the source in the same manner others are. When doing this, start a new branch, add the function, compile, test, and then merge request after verifying the added function works. Available cuFFT functions are listed below.
For reference to official Nvidia documentation:
To compile the shared library, run the setup.py file found in the root folder from the command line, with optional argument(s) -arch, and -cc_bin if on Windows. On Windows, the NVCC compiler looks for cl.exe to compile the C/C++, which comes with Visual Studio. On Linux, it uses the built in GCC compiler. An example of a command line run to compile the code is given below:
python setup.py -arch=sm_50 -cc_bin="C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin"
If you are unable to compile, you may download precompiled libraries here.
- Python 3.6.x (2.7 compatibility not yet tested)
- The latest version of the Nvidia CUDA Toolkit
- (Windows) Visual Studio 2013 Professional, or any compatible version with your version of CUDA Toolkit. Note: You can download a trial of Professional to obtain cl.exe. Compilation via the command line will still work after the trial period has ended.
- cufft_addredundants : To save memory, the cuFFTExecR2C returns the array with non-redundant results only. This will add the redundant values back in.
- cufft_plan : Setup cuFFT plan with size, and store for reuse.
- cufft_conj : Returns the complex conjugate of the complex input.
For sample scripts or further documentation on how to use this framework, view sample scripts that import and utilize cufft_helpers, and/or view the PowerPoint presentation here.
The MIT License (MIT)
Copyright (c) 2018 (Arthur Suszko (art.suszko@gmail.com), Geoff Gunter (geoffmgunter@gmail.com) and contributors)
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.