https://github.com/dfm/python-nufft

Python bindings to a subset of the NUFFT algorithm
https://github.com/dfm/python-nufft

Last synced: about 1 year ago
JSON representation

Python bindings to a subset of the NUFFT algorithm

• Host: GitHub
• URL: https://github.com/dfm/python-nufft
• Owner: dfm
• License: other
• Created: 2015-01-17T18:27:44.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-03-15T19:53:56.000Z (about 2 years ago)
• Last Synced: 2025-03-25T06:19:07.086Z (about 1 year ago)
• Language: Fortran
• Size: 108 KB
• Stars: 61
• Watchers: 4
• Forks: 13
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Python-NUFFT

============

.. image:: https://travis-ci.org/ThomasA/python-nufft.svg?branch=master

    :target: https://travis-ci.org/ThomasA/python-nufft

.. image:: https://coveralls.io/repos/github/ThomasA/python-nufft/badge.svg?branch=master

           :target: https://coveralls.io/github/ThomasA/python-nufft?branch=master

.. image:: https://readthedocs.org/projects/python-nufft/badge/?version=latest

	   :target: http://python-nufft.readthedocs.io/en/latest/?badge=latest

	   :alt: Documentation Status

Python bindings to a subset of the `NUFFT algorithm

`_. 1D, 2D, and 3D

cases are implemented.

Usage

-----

The documentation can be found on `ReadTheDocs

`_.

To install, run ``python setup.py install``. Then, to evaluate a

type-3 FT in 1D, use ``nufft.nufft1d3``. Assuming that you have a time

series in ``t`` and ``y`` and you want to evaluate it at (angular)

frequencies ``f``:

.. code-block:: python

    import nufft

    ft = nufft.nufft1d3(t, y, f)

You can specify your required precision using ``eps=1e-15``. The

default is ``1e-15``.

Authors and License

-------------------

Python bindings by Dan Foreman-Mackey, Thomas Arildsen, and

Marc T. Henry de Frahan but the code that actually does the work is

from the Greengard lab at NYU (see `the website

`_). The Fortran code

is BSD licensed and the Python bindings are MIT licensed.