Skip to content

Commit

Permalink
Update README + docs (again)
Browse files Browse the repository at this point in the history
  • Loading branch information
jipolanco committed Oct 28, 2024
1 parent c4f5e28 commit 97cffb9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Yet another package for computing multidimensional [non-uniform fast Fourier tra
Like other [existing packages](#differences-with-other-packages), computation of NUFFTs on CPU
are parallelised using threads.
Transforms can also be performed on GPUs.
In principle all kinds of GPU are supported.
In principle all kinds of GPU for which
a [KernelAbstractions.jl](https://github.com/JuliaGPU/KernelAbstractions.jl)
backend exists are supported.

## Basic usage

Expand Down Expand Up @@ -205,7 +207,7 @@ vp = randn(Complex{T}, Np) # random values at points (must be complex)
# Create plan for data of type Complex{T}. Note that we pass the points `xp` as
# a first argument, which calls an AbstractNFFTs-compatible constructor.
p = NonuniformFFTs.NFFTPlan(xp, Ns)
# p = AbstractNFFTs.plan_nfft(xp, Ns) # this is also possible
# p = plan_nfft(xp, Ns) # this is also possible

# Getting the expected dimensions of input and output data.
AbstractNFFTs.size_in(p) # (256, 256)
Expand Down
6 changes: 4 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Yet another package for computing multidimensional [non-uniform fast Fourier tra
Like other [existing packages](#similar-packages), computation of NUFFTs on CPU
are parallelised using threads.
Transforms can also be performed on GPUs.
In principle all kinds of GPU are supported.
In principle all kinds of GPU for which
a [KernelAbstractions.jl](https://github.com/JuliaGPU/KernelAbstractions.jl)
backend exists are supported.

## Installation

Expand Down Expand Up @@ -273,7 +275,7 @@ vp = randn(Complex{T}, Np) # random values at points (must be complex)
# Create plan for data of type Complex{T}. Note that we pass the points `xp` as
# a first argument, which calls an AbstractNFFTs-compatible constructor.
p = NonuniformFFTs.NFFTPlan(xp, Ns)
# p = AbstractNFFTs.plan_nfft(xp, Ns) # this is also possible
# p = plan_nfft(xp, Ns) # this is also possible

# Getting the expected dimensions of input and output data.
AbstractNFFTs.size_in(p) # (256, 256)
Expand Down

0 comments on commit 97cffb9

Please sign in to comment.