Skip to content

Commit

Permalink
README: add more system requirements hints regarding single precision…
Browse files Browse the repository at this point in the history
… and openmp fftw support, partly to adress #7
  • Loading branch information
lschneiderbauer committed Dec 28, 2024
1 parent 5b15fc0 commit c707a7b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ See the original paper by Arts, L.P.A., van den Broek, E.L. The fast continuous
## System dependencies

- R \>= 4.1
- [fftw](https://www.fftw.org/) library (used by [fCWT](https://github.com/fastlib/fCWT))
- [fftw](https://www.fftw.org/) library with [single-precision support](https://www.fftw.org/faq/section2.html#singleprec) enabled (used by [fCWT](https://github.com/fastlib/fCWT))
- Optional: a CPU/compiler supporting the [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) instruction set
- Optional: OpenMP
- Optional: OpenMP (and fftw built with [OpenMP support](https://www.fftw.org/doc/Usage-of-Multi_002dthreaded-FFTW.html))
- On Windows, OpenMP support is disabled since rtools decided to compile fftw without OpenMP support.
- On Linux and MacOS the build scripts should automatically detect whether OpenMP support is available.

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ noise-resistant time–frequency analysis. Nat Comput Sci 2, 47–58 (2022).
## System dependencies

- R \>= 4.1
- [fftw](https://www.fftw.org/) library (used by
[fCWT](https://github.com/fastlib/fCWT))
- [fftw](https://www.fftw.org/) library with [single-precision
support](https://www.fftw.org/faq/section2.html#singleprec) enabled
(used by [fCWT](https://github.com/fastlib/fCWT))
- Optional: a CPU/compiler supporting the
[AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions)
instruction set
- Optional: OpenMP
- Optional: OpenMP (and fftw built with [OpenMP
support](https://www.fftw.org/doc/Usage-of-Multi_002dthreaded-FFTW.html))
- On Windows, OpenMP support is disabled since rtools decided to
compile fftw without OpenMP support.
- On Linux and MacOS the build scripts should automatically detect
Expand Down

0 comments on commit c707a7b

Please sign in to comment.