Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add source install instructions for gpu #632

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Add source install instructions for gpu #632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adbaf6a
docs: add source install instructions for gpu
janden Feb 13, 2025
7f445d6
docs: fix typo
janden Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you would like to compile from source, you can tell ``pip`` to compile the li
pip install --no-binary finufft finufft

By default, this will use the ``-march=native`` flag when compiling the library, which should result in improved performance.
Note that ``finufft`` has to be specified twice (first as an argument to ``--no-binary`` and second as the package the is to be installed). This option also allows you to switch out the default FFT library (FFTW) for DUCC0 using::
Note that ``finufft`` has to be specified twice (first as an argument to ``--no-binary`` and second as the package that is to be installed). This option also allows you to switch out the default FFT library (FFTW) for DUCC0 using::

pip install --no-binary finufft finufft --config-settings=cmake.define.FINUFFT_USE_DUCC0=ON finufft

Expand Down
12 changes: 11 additions & 1 deletion docs/python_gpu.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ Python interface (GPU)
Quick-start examples
--------------------

As mentioned in the :ref:`Python GPU installation instructions <install-python-gpu>`, the easiest way to install the Python interface for cuFINUFFT is to run ``pip install cufinufft``.
As mentioned in the :ref:`Python GPU installation instructions <install-python-gpu>`, the easiest way to install the Python interface for cuFINUFFT is to run::

pip install cufinufft

If you would like to compile from source, you can tell ``pip`` to compile the library from source with the option ``--no-binary`` using the command::

pip install --no-binary cufinufft cufinufft

This will often result in improved performance since the build will be optimized for your particular architecture.
In particular, it can take advantage of newer CUDA features if you have a recent version of CUDA installed.
Note that ``cufinufft`` has to be specified twice (first as an argument to ``--no-binary`` and second as the package that is to be installed).

*Note*: The interface to cuFINUFFT has changed between versions 1.3 and 2.2.
Please see :ref:`Migration to cuFINUFFT v2.2<cufinufft_migration>` for details.
Expand Down
Loading