Skip to content

Commit

Permalink
docs: update getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
paquiteau committed Jan 18, 2024
1 parent 19681e4 commit 732db51
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 11 deletions.
32 changes: 25 additions & 7 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,10 @@ finufft_ CPU ✔ single/double numpy
gpunufft_ GPU ✔ single/double numpy
tensorflow-nufft_ GPU (CUDA) ✘ single tensorflow
pynufft-cpu_ CPU ✘ single/double numpy
pynfft_ (*) CPU ✘ singles/double numpy
stacked (**) CPU/GPU ✔ single/double numpy
pynfft_ CPU ✘ single/double numpy
bart_ CPU/GPU ✔ single numpy
sigpy_ CPU ✔ single numpy
stacked (*) CPU/GPU ✔ single/double numpy
==================== ============ =================== =============== =================


Expand All @@ -51,10 +53,11 @@ stacked (**) CPU/GPU ✔ single/double numpy
.. _tensorflow-nufft: https://github.com/flatironinstitute/pynufft
.. _gpunufft: https://github.com/chaithyagr/gpuNUFFT
.. _pynufft-cpu: https://github.com/jyhmiinlin/pynufft
.. _pynfft: https://github.com/ghisvail/pynfft
.. _pynfft: https://github.com/pynfft/pynfft
.. _bart: https://github.com/mrirecon/bart
.. _sigpy: https://github.com/sigpy/sigpy

- (*) PyNFFT is only working with Cython < 3.0.0 , and is not actively maintained (https://github.com/mind-inria/mri-nufft/issues/19)
- (**) stacked-nufft allow to use any supported backend to perform a stack of 2D NUFFT and adds a z-axis FFT (using scipy or cupy)
- (*) stacked-nufft allow to use any supported backend to perform a stack of 2D NUFFT and adds a z-axis FFT (using scipy or cupy)


**The NUFFT operation is often not enough to provide good image quality by itself (even with density compensation)**.
Expand All @@ -72,7 +75,7 @@ To benefit the most from certain backend we recommend to use the following instr
finufft / cufinufft
~~~~~~~~~~~~~~~~~~~

Those are develop by the `flatiron-institute <https://github.com/flatironinstitute/finufft>` and are installable with `pip install finufft` and `pip install cufinufft`.
Those are develop by the `flatiron-institute <https://github.com/flatironinstitute/finufft>`_ and are installable with `pip install finufft` and `pip install cufinufft`.

.. warning::

Expand All @@ -81,7 +84,7 @@ Those are develop by the `flatiron-institute <https://github.com/flatironinstitu
gpuNUFFT
~~~~~~~~

an active gpuNUFFT fork is maintained by `chaithyagr <https://github.com/chaithyagr/gpunufft/>`.
an active gpuNUFFT fork is maintained by `chaithyagr <https://github.com/chaithyagr/gpunufft/>`_.

.. warning::

Expand All @@ -95,6 +98,21 @@ To install it use `pip install gpuNUFFT` or for local development.
cd gpuNUFFT
python setup.py install
BART
~~~~

BART has to be installed separately and `bart` command needs to be runnable from your `PATH`.
See `installation instructions <https://mrirecon.github.io/bart/installation.html>`_


PyNFFT
~~~~~~

PyNFFT requires Cython<3.0.0 to work. and can be installed using

.. code-block:: sh
pip install cython<3.0.0 pynfft2
Which backend to use
--------------------
Expand Down
9 changes: 8 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,11 @@
misc/code_of_conduct
misc/license
misc/development
misc/related

.. toctree::
:hidden:
:caption: Related Projects

PySAP <https://cea-cosmic.github.io/pysap>
ModOpt <https://cea-cosmic.github.io/ModOpt/>
Brainweb-dl <http://github.com/paquiteau/brainweb-dl>
2 changes: 1 addition & 1 deletion docs/misc/related.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Related Projects
.. toctree::
:maxdepth: 2

PySAP <https://python-pysap.readthedocs.io/en/latest/>
PySAP <https://cea-cosmic.github.io/pysap>
ModOpt <https://cea-cosmic.github.io/ModOpt/>
Brainweb-dl <http://github.com/paquiteau/brainweb-dl>
8 changes: 6 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ dynamic = ["version"]

[project.optional-dependencies]

gpu = ["cupy-wheel"]
gpunufft = ["gpunufft", "cupy-cuda11x"]
cufinufft = ["cufinufft", "cupy-cuda11x"]
finufft = ["finufft"]
pynfft = ["pynfft2", "cython<3.0.0"]
pynufft = ["pynufft"]

test = ["pytest", "pytest-cov", "pytest-xdist", "pytest-sugar", "pytest-cases"]
dev = ["black", "isort", "ruff"]

doc = ["sphinx-book-theme","sphinx-copybutton", "sphinx-gallery", "matplotlib", "pooch", "brainweb-dl"]
# pooch is for scipy.datasets

Expand Down

0 comments on commit 732db51

Please sign in to comment.