Skip to content

Commit

Permalink
Notes about plugins + fix CI Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
paugier committed Jan 28, 2024
1 parent 6b87f0d commit 3e6d048
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 4 deletions.
11 changes: 9 additions & 2 deletions plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,17 @@ Directory containing the plugins, i.e. Python packages declaring the

We should have

- [x] fluidfft-mpi4pyfft
- [x] fluidfft-mpi4pyfft (cannot be tested because mpi4py-fft installation fails)
- [ ] fluidfft-fftw
- [ ] fluidfft-mpi_with_fftw
- [ ] fluidfft-fftwmpi
- [ ] fluidfft-p3dfft
- [ ] fluidfft-pfft
- [ ] fluidfft-cuda (?)
- [ ] fluidfft-pyvkfft (https://pyvkfft.readthedocs.io)

Currently, we have only one tested plugin (fluidfft-pyfftw), which was written to
design and test the plugin machinery. However, I (PA) think that this (pure Python)
code will have to go back in fluidfft. Pyfftw can just be an optional dependency
for fluidfft.

TODO: When we have other plugins, move back the code using pyfftw inside fluidfft.
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ fluidfft-bench = "fluidfft.bench:run"
fluidfft-bench-analysis = "fluidfft.bench_analysis:run"

[project.entry-points."fluidfft.plugins"]
# TODO: uncomment when code using pyfftw is back in fluidfft
# "fft2d.with_pyfftw" = "fluidfft.fft2d.with_pyfftw"
# "fft3d.with_pyfftw" = "fluidfft.fft3d.with_pyfftw"
"fft2d.with_dask" = "fluidfft.fft2d.with_dask"

# should be in fluidfft-fftw
Expand Down
2 changes: 1 addition & 1 deletion tests/test_2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def test_get_classes():
nb_proc = mpi.nb_proc


methods_seq = ["fftw1d", "fftw2d", "cufft"]
methods_seq = ["fftw1d", "fftw2d", "cufft", "pyfftw"]
methods_seq = ["fft2d.with_" + method for method in methods_seq]
classes_seq = {
method: import_fft_class(method, raise_import_error=False)
Expand Down
2 changes: 1 addition & 1 deletion tests/test_3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_get_classes():
get_classes_mpi()


methods_seq = ["fftw3d"]
methods_seq = ["fftw3d", "pyfftw"]
methods_seq = ["fft3d.with_" + method for method in methods_seq]
classes_seq = {
method: import_fft_class(method, raise_import_error=False)
Expand Down

0 comments on commit 3e6d048

Please sign in to comment.