docs: clarify that the NFFT/FFTW C libraries are bundled in the wheel - #12
Open
passscoed wants to merge 1 commit into
Open
docs: clarify that the NFFT/FFTW C libraries are bundled in the wheel#12passscoed wants to merge 1 commit into
passscoed wants to merge 1 commit into
Conversation
The README, docs landing page and PyPI description described pyNFFT3 as a "Python interface for the NFFT C library ... using ctypes" without stating that the compiled NFFT/FFTW libraries ship inside the wheel. This reads as an external prerequisite (as with the older pyNFFT) and leads users to believe a system NFFT/FFTW install or a compiler is required, when `pip install pyNFFT3` works out of the box. - README: reword the tagline; note in "Getting started" that the prebuilt libraries ship in the wheel (and why it is ~100 MB); add an explicit "no compiler / no system NFFT/FFTW" line and a platform/NumPy-upgrade note. - docs/source/index.rst: state that the shared libraries are shipped and loaded at runtime. - pyproject.toml: make the PyPI summary explicit about the bundled binaries. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README, docs landing page and PyPI description described pyNFFT3 as a "Python interface for the NFFT C library ... using ctypes" without stating that the compiled NFFT/FFTW libraries ship inside the wheel. This reads as an external prerequisite (as with the older pyNFFT) and leads users to believe a system NFFT/FFTW install or a compiler is required, when
pip install pyNFFT3works out of the box.