Skip to content

Commit

Permalink
Update README to account for set_provider! (#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
jkrimmer committed Apr 27, 2021
1 parent e729ea6 commit eda249b
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,12 @@ The documentation of generic FFT functionality can be found in the [AbstractFFTs
## MKL

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


## License
Expand Down

0 comments on commit eda249b

Please sign in to comment.