Skip to content

Commit

Permalink
readme: updates for v1.0.1 (notably, openmp in the C++ helpers now wo…
Browse files Browse the repository at this point in the history
…rks on ARM Mac)
  • Loading branch information
lgarrison committed Sep 12, 2024
1 parent 77d1b11 commit bd1e84e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
4 changes: 3 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Changelog

## v1.0.1 (2024-09-12)
Minor optimizations that make use of finufft v2.3. This version was used in the submitted research note.
Minor optimizations and fixes that make use of finufft v2.3. This version was used in the submitted research note.

OpenMP in the C++ helpers on MacOS ARM has also been fixed, which should result in a small performance improvement for users on M1/M2/etc CPUs.

The finufft version requirement is >= 2.3.

Expand Down
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,6 @@ nifty-ls can likewise be built from source following the instructions above for
best performance, but most of the heavy computations are offloaded to (cu)finufft,
so the performance benefit is minimal.

**⚠️ MacOS ARM users (M1/M2/etc)**: due to an OpenMP library incompatibility, the
nifty-ls "C++ helpers" are not parallelized in the Mac ARM builds on PyPI. This is not
expected to have a big impact on performance, as the core finufft computation will still
be parallelized. Building both finufft and nifty-ls from source is a possible
workaround.

## Usage
### From Astropy
Importing `nifty_ls` makes nifty-ls available via `method="fastnifty"` in
Expand Down

0 comments on commit bd1e84e

Please sign in to comment.