Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #23

Merged
merged 2 commits into from
Jan 9, 2024
Merged

Improve docs #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70bf4db
Add AUTHORS (just myself now)
Jan 9, 2024
5ec68a1
Add CI badge in README.md
Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Multiple people have contributed to DDC. To show our appreciation for their
public spirit, we list here in alphabetical order a condensed list of their
contributions.


Yuuichi Asahi - CEA (yuuichi.asahi(at)cea.fr)
* Maintainer
* Initial designer and first development steps
* Co-developer
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# kokkos-fft

[![CI](https://github.com/CExA-project/kokkos-fft/actions/workflows/cmake.yml/badge.svg)](https://github.com/CExA-project/kokkos-fft/actions)

UNOFFICIAL FFT interfaces for Kokkos C++ Performance Portability Programming EcoSystem

KokkosFFT implements local interfaces Kokkos and de facto standard FFT libraries, including fftw, cufft and hipfft.
Expand Down Expand Up @@ -28,7 +30,7 @@ Kokkos::Random_XorShift64_Pool<> random_pool(12345);
Kokkos::fill_random(x, random_pool, 1);
Kokkos::fence();

KokkosFFT::rfft(x, x_hat);
KokkosFFT::rfft(execution_space(), x, x_hat);
```

Depending on the View dimension, it automatically uses the batched plans as follows
Expand All @@ -55,7 +57,7 @@ Kokkos::fill_random(x, random_pool, 1);
Kokkos::fence();

int axis = -1;
KokkosFFT::rfft(x, x_hat, KokkosFFT::FFT_Normalization::BACKWARD, axis); // FFT along -1 axis and batched along 0th axis
KokkosFFT::rfft(execution_space(), x, x_hat, KokkosFFT::FFT_Normalization::BACKWARD, axis); // FFT along -1 axis and batched along 0th axis
```

## Building KokkosFFT
Expand Down