Skip to content

Commit

Permalink
improved installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
daurer committed Mar 8, 2024
1 parent cd56696 commit d87a479
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 23 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Features
$ mpiexec -n [nodes] python <your_ptypy_script>.py

* **GPU acceleration** based on custom kernels, CuPy or PyCUDA/reikna.
See examples in ``templates/accelerate``.
See examples in ``templates/accelerate``, ``templates/engines/pycuda`` and ``templates/engines/cupy``.

* A **client-server** approach for visualization and control based on
`ZeroMQ <http://www.zeromq.org>`_ .
Expand Down Expand Up @@ -104,7 +104,7 @@ Ptypy depends on standard python packages:
GPU support
-----------

We support an accelerated version of |ptypy|_ for CUDA-capable GPUs based on our own kernels and the
We support an accelerated version of |ptypy| for CUDA-capable GPUs based on our own kernels and the
`CuPy <https://cupy.dev/>`_ package. We recommend to install the dependencies for this version like so.
::

Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Highlights
$ mpiexec/mpirun -n [nodes] python <your_ptypy_script>.py

* **GPU acceleration** based on custom kernels, CuPy or PyCUDA/reikna.
See examples in ``templates/accelerate``.
See examples in ``templates/accelerate``, ``templates/engines/pycuda`` and ``templates/engines/cupy``.

* A **client-server** approach for visualization and control based on
`ZeroMQ <http://www.zeromq.org>`_ .
Expand Down
30 changes: 10 additions & 20 deletions doc/rst_templates/getting_started.tmp
Original file line number Diff line number Diff line change
Expand Up @@ -101,20 +101,6 @@ Install the dependencies for this version like so.
(ptypy_cupy)$ pip install .


While we use the `CuPy FFT <https://docs.cupy.dev/en/stable/reference/fft.html>`_ to
provide a filtered FFT, i.e. a FFT that is fused with a pointwise
matrix multiplication, you can optionally also install a version
based on cufft and callbacks. Due to the nature of this extension it
needs to be built for fixed array sizes externally. The currently supported
array sizes are 16, 32, 64, 128, 256, 512, 1024 and 2048.
::

$ conda activate ptypy_cupy
(ptypy_cupy)$ cd cufft
(ptypy_cupy)$ conda env update --file dependencies.yml --name ptypy_cupy
(ptypy_cupy)$ pip install .


Install for GPU support with PyCUDA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -130,12 +116,16 @@ Install the dependencies for this version like so.
(ptypy_pycuda)$ pip install .


While we use `Reikna <https://pypi.org/project/reikna/>`_ to
provide a filtered FFT, i.e. a FFT that is fused with a pointwise
matrix multiplication, you can optionally also install a version
based on cufft and callbacks. Due to the nature of this extension it
needs to be built for fixed array sizes externally. The currently supported
array sizes are 16, 32, 64, 128, 256, 512, 1024 and 2048.
We use `Reikna <https://pypi.org/project/reikna/>`_ to
provide a filtered FFT, i.e. a FFT that is fused with a pointwise matrix multiplication.

Optional installation of filtered cufft
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For optimal performance with both PyCUDA and CuPY engines, you can optionally install a version
of the filtered FFT based on cufft and callbacks. Due to the nature of this extension it
needs to be built for fixed array sizes externally and currently supports array
sizes of 16, 32, 64, 128, 256, 512, 1024 and 2048.
::

$ conda activate ptypy_pycuda
Expand Down

0 comments on commit d87a479

Please sign in to comment.