napari-cupy-image-processing

GPU-accelerated image processing using cupy and CUDA

Usage¶

This napari plugin adds some menu entries to the Tools menu. You can recognize them with their suffix (n-cupy) in brackets. Furthermore, it can be used from the napari-assistant graphical user interface. Therefore, just click the menu Tools > Utilities > Assistant (na) or run naparia from the command line.

You can also call operations from python, e.g. as shown in this demo notebook.

Installation¶

You can install napari-cupy-image-processing using conda:

mamba install -c conda-forge cupy cudatoolkit=11.2 napari-cupy-image-processing

Troubleshooting installation¶

In case of issues, follow the instructions for installing cupy.

A more detailed example for installation (change 11.2 to your desired CUDA version):

mamba create --name cupy_p39 python=3.9 
conda activate cupy_p39

And then:

mamba install -c conda-forge cupy cudatoolkit=11.2 napari-cupy-image-processing

Contributing¶

Contributions are very welcome. Adding cupy ndimage functions is quite easy as you can see in the implementation of the current operations. If you need another function in napari, just send a PR. Please make sure the tests pass locally before submitting a PR.

pip install pytest-cov pytest-qt
pytest --cov=napari_cupy_image_processing

This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.

License¶

Distributed under the terms of the MIT license, "napari-cupy-image-processing" is free and open source software

Issues¶

If you encounter any problems, please file an issue along with a detailed description.