Skip to content

Commit

Permalink
add FI logo and support info README and doc front page
Browse files Browse the repository at this point in the history
  • Loading branch information
ahbarnett committed Jan 10, 2025
1 parent 40b9929 commit 1b4aa81
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ see `docs/ackn.rst` for full list of contributors.

This is a lightweight CPU 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, Python, and (in a separate [repository](https://github.com/ludvigak/FINUFFT.jl)) Julia. It now also integrates the GPU CUDA library cuFINUFFT.

Docs and installation
---------------------

Please see the [online documentation](http://finufft.readthedocs.io/en/latest/index.html) which can also be downloaded as a [PDF manual](https://finufft.readthedocs.io/_/downloads/en/latest/pdf/), and a [project overview](https://users.flatironinstitute.org/~ahb/notes/finufft-project-summary-2023.pdf).
You will also want to see CPU example codes in the directories `examples`, `test`, `fortran`, `matlab/test`, `matlab/examples`, `python/finufft/test`, etc, and GPU examples in `examples/cuda`, `test/cuda`, etc.

Expand Down Expand Up @@ -46,6 +49,16 @@ If you prefer to read text files, the source to generate the above documentation
- `docs/ackn.rst` : authors and acknowledgments
- `docs/refs.rst` : journal article references (ours and others)

Support
-------

<img align="right" src="docs/FIlogo_200.png" width="200">

FINUFFT/cuFINUFFT was developed at, and is supported by,
the Flatiron Institute at the Simons Foundation.

Citing
------

If you find (cu)FINUFFT useful in your work, please star this repository and
cite it and the following. It will help us to improve the library if you also
Expand Down
Binary file added docs/FIlogo_200.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs/overview.src
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@ is written in C++, OpenMP, and calls
`FFTW <http://www.fftw.org>`_.
It has been developed since 2017 at the `Center for Computational Mathematics
<https://www.simonsfoundation.org/flatiron/center-for-computational-mathematics/>`_ at the `Flatiron Institute <https://www.simonsfoundation.org/flatiron>`_,
a division of the `Simons Foundation <https://www.simonsfoundation.org>`_,
by :ref:`Alex Barnett and others<ackn>`,
and is released under an
`Apache v2 license <https://github.com/flatironinstitute/finufft/blob/master/LICENSE>`_. Here is a `project overview <https://users.flatironinstitute.org/~ahb/notes/finufft-project-summary-2023.pdf>`_.
`Apache v2 license <https://github.com/flatironinstitute/finufft/blob/master/LICENSE>`_. Here is a `project overview from 2023 <https://users.flatironinstitute.org/~ahb/notes/finufft-project-summary-2023.pdf>`_.

.. image:: FIlogo_200.png
:width: 30%

What does FINUFFT do?
-----------------------
Expand Down

0 comments on commit 1b4aa81

Please sign in to comment.