Merge branch 'topic/default/fluidfft-get-methods' into 'branch/default'

Topic/default/fluidfft get methods

See merge request fluiddyn/fluidfft!71

Author: paugier

Makefile

@@ -35,6 +35,9 @@ cleanall: clean cleanso cleanpythran
 black:
 	pdm run black
 
+format:
+	pdm run black
+
 tests:
 	pytest -s tests
 

noxfile.py

@@ -24,7 +24,7 @@
 import nox
 
 os.environ.update({"PDM_IGNORE_SAVED_PYTHON": "1"})
-nox.options.reuse_existing_virtualenvs = 1
+nox.options.reuse_existing_virtualenvs = True
 nox.options.sessions = ["tests"]
 
 no_venv_session = partial(nox.session, venv_backend="none")

plugins/README.md

@@ -1,4 +1,4 @@
-# Fluidfft plugins
+# Fluidfft plugins and methods
 
 The main Fluidfft package only contains pure Python FFT classes using other
 packages to perform the transforms.
@@ -18,6 +18,13 @@ in its `pyproject.toml` file like this:
 "fft3d.with_fftw3d" = "fluidfft_fftw.fft3d.with_fftw3d"
 ```
 
+The method strings (for example `"fft3d.with_fftw3d"`) can be given to
+{func}`fluidfft.import_fft_class` and Operator classes (like
+{class}`fluidfft.fft3d.operators.OperatorsPseudoSpectral3D`).
+
+The methods available can be obtained with the command line `fluidfft-get-methods`
+and the function {func}`fluidfft.get_methods`.
+
 The following plugins are implemented in Fluidfft repository:
 
 - `fluidfft-fftw`
@@ -31,9 +38,9 @@ We plan to soon also have:
 
 - `fluidfft-pyvkfft` (<https://pyvkfft.readthedocs.io>)
 
-Currently, the plugins can be installed from the repository (see
-[](#build-from-source)) but the corresponding library has to be installed
-first.
+There are few plugins available on PyPI (see <https://pypi.org/search/?q=fluidfft>).
+Note that their installation can trigger compilation (see [](#build-from-source))
+and that the corresponding library has to be installed first.
 
 ## Install FFT libraries
 

pyproject.toml

@@ -55,6 +55,7 @@ p3dfft = ["fluidfft-p3dfft"]
 [project.scripts]
 fluidfft-bench = "fluidfft.bench:run"
 fluidfft-bench-analysis = "fluidfft.bench_analysis:run"
+fluidfft-get-methods = "fluidfft.cli_get_methods:main"
 
 [project.entry-points."fluidfft.plugins"]
 "fft2d.with_pyfftw" = "fluidfft.fft2d.with_pyfftw"

src/fluidfft/cli_get_methods.py

@@ -0,0 +1,39 @@
+import argparse
+
+from fluidfft import get_methods, __version__
+
+from pprint import pprint
+
+
+def main():
+
+    parser = argparse.ArgumentParser(
+        prog="fluidfft-get-methods",
+        description="Print available FFT methods.",
+    )
+
+    parser.add_argument("-V", "--version", action="version", version=__version__)
+
+    parser.add_argument("-d", "--dim", default=None)
+
+    parser.add_argument("-s", "--sequential", action="store_true")
+    parser.add_argument("-p", "--parallel", action="store_true")
+
+    args = parser.parse_args()
+
+    dim = args.dim
+    if dim is not None:
+        dim = int(dim)
+
+    if args.sequential and args.parallel:
+        raise ValueError("--sequential and --parallel are incompatible options")
+    elif args.sequential:
+        sequential = True
+    elif args.parallel:
+        sequential = False
+    else:
+        sequential = None
+
+    methods = get_methods(dim, sequential)
+
+    pprint(sorted(methods))

src/fluidfft/meson.build

@@ -4,6 +4,7 @@ python_sources = [
   'base.py',
   'bench.py',
   'bench_analysis.py',
+  'cli_get_methods.py',
   'util.py',
   'build_conf.txt',
 ]

tests/test_cli_get_methods.py

@@ -0,0 +1,26 @@
+import sys
+
+from unittest.mock import patch
+
+from fluidfft.cli_get_methods import main
+
+
+def test_get_methods():
+
+    with patch.object(sys, "argv", []):
+        main()
+
+    with patch.object(sys, "argv", ["fluidfft-get-methods", "-d", "2"]):
+        main()
+
+    with patch.object(sys, "argv", ["fluidfft-get-methods", "-d", "3"]):
+        main()
+
+    with patch.object(sys, "argv", ["fluidfft-get-methods", "-s"]):
+        main()
+
+    with patch.object(sys, "argv", ["fluidfft-get-methods", "-p"]):
+        main()
+
+    with patch.object(sys, "argv", ["fluidfft-get-methods", "-d", "3", "-s"]):
+        main()