Skip to content

Commit eda249b

Browse files
authored
Update README to account for set_provider! (#199)
1 parent e729ea6 commit eda249b

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,12 @@ The documentation of generic FFT functionality can be found in the [AbstractFFTs
3131
## MKL
3232

3333
Alternatively, the FFTs in Intel's Math Kernel Library (MKL) can be used
34-
by setting an environment variable `JULIA_FFTW_PROVIDER` to `MKL` and running
35-
`Pkg.build("FFTW")`. MKL will be provided through `MKL_jll`.
36-
Setting this environment variable only needs to be done for the first build of the package;
37-
after that, the package will remember to use MKL when building and updating.
34+
by running `FFTW.set_provider!("mkl")`. MKL will be provided through `MKL_jll`.
35+
This change of provider is persistent and has to be done only once, i.e., the package will use MKL when building and updating.
3836
Note however that MKL provides only a subset of the functionality provided by FFTW. See
3937
Intel's [documentation](https://software.intel.com/en-us/mkl-developer-reference-c-using-fftw3-wrappers)
40-
for more information about potential differences or gaps in functionality.
38+
for more information about potential differences or gaps in functionality.
39+
In case MKL does not fit the needs (anymore), `FFTW.set_provider!("fftw")` allows to revert the change of provider.
4140

4241

4342
## License

0 commit comments

Comments
 (0)