Giter Club home page Giter Club logo

finufft's Introduction

Flatiron Institute Nonuniform Fast Fourier Transform libraries: FINUFFT

Alex H. Barnett and Jeremy F. Magland, with additional code by Ludvig af Klinteberg and Yu-hsuan "Melody" Shih.

This is a lightweight library to compute the three standard types of nonuniform FFT to a specified precision, in one, two, or three dimensions. It is written in C++ with interfaces to C, Fortran, MATLAB/octave, and python. A julia interface also exists.

Please see the online documentation, or its equivalent, the user manual. You will also want to see example codes in the directories examples, test, fortran, matlab, and python_tests. If you cannot compile, try our precompiled binaries.

If you prefer to read text files, the source to generate the above documentation is in human-readable (mostly .rst) files as follows:

  • docs/install.rst : installation and compilation instructions
  • docs/math.rst : mathematical definitions
  • docs/dirs.rst : explanation of directories and files in the package
  • docs/usage.rst : interfaces from C++, C and Fortran, notes on parameters
  • docs/matlabhelp.raw : MATLAB/octave interfaces
  • finufftpy/_interfaces.py : python interface docstrings
  • docs/related.rst : packages using FINUFFT
  • docs/issues.rst : known issues and bug reports
  • docs/refs.rst : journal article references
  • docs/ackn.rst : acknowledgments

If you find FINUFFT useful in your work, please cite this code and the forthcoming paper (see references).

finufft's People

Contributors

ahbarnett avatar magland avatar melodyshih avatar janden avatar dfm avatar ludvigak avatar mosco avatar dylex avatar hugostrand avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.