napari-cupy-image-processing


Namenapari-cupy-image-processing JSON
Version 0.4.1 PyPI version JSON
download
home_pagehttps://github.com/haesleinhuepf/napari-cupy-image-processing
SummaryGPU-accelerated image processing using CUDA
upload_time2023-08-17 12:35:58
maintainer
docs_urlNone
authorRobert Haase
requires_python>=3.7
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # napari-cupy-image-processing

[![License](https://img.shields.io/pypi/l/napari-cupy-image-processing.svg?color=green)](https://github.com/haesleinhuepf/napari-cupy-image-processing/raw/master/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/napari-cupy-image-processing.svg?color=green)](https://pypi.org/project/napari-cupy-image-processing)
[![Python Version](https://img.shields.io/pypi/pyversions/napari-cupy-image-processing.svg?color=green)](https://python.org)
[![tests](https://github.com/haesleinhuepf/napari-cupy-image-processing/workflows/tests/badge.svg)](https://github.com/haesleinhuepf/napari-cupy-image-processing/actions)
[![codecov](https://codecov.io/gh/haesleinhuepf/napari-cupy-image-processing/branch/master/graph/badge.svg)](https://codecov.io/gh/haesleinhuepf/napari-cupy-image-processing)
[![Development Status](https://img.shields.io/pypi/status/napari-cupy-image-processing.svg)](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-cupy-image-processing)](https://napari-hub.org/plugins/napari-cupy-image-processing)


GPU-accelerated image processing using [cupy](https://cupy.dev) and [CUDA](https://en.wikipedia.org/wiki/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](https://www.napari-hub.org/plugins/napari-assistant) graphical user interface. 
Therefore, just click the menu `Tools > Utilities > Assistant (na)` or run `naparia` from the command line.

![img.png](https://github.com/haesleinhuepf/napari-cupy-image-processing/raw/main/docs/screenshot-with-tools-menu.png)

You can also call operations from python, e.g. as shown in this [demo notebook](https://github.com/haesleinhuepf/napari-cupy-image-processing/raw/main/docs/demo.ipynb).

## 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](https://docs.cupy.dev/en/stable/install.html#installing-cupy-from-conda-forge). 

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](https://docs.cupy.dev/en/stable/reference/ndimage.html) functions is quite easy as you can see in the 
[implementation of the current operations](https://github.com/haesleinhuepf/napari-cupy-image-processing/blob/main/napari_cupy_image_processing/_cupy_image_processing.py#L48). 
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.

[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[MIT]: http://opensource.org/licenses/MIT
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin

[file an issue]: https://github.com/haesleinhuepf/napari-cupy-image-processing/issues

[napari]: https://github.com/napari/napari
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/haesleinhuepf/napari-cupy-image-processing",
    "name": "napari-cupy-image-processing",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Robert Haase",
    "author_email": "robert.haase@tu-dresden.de",
    "download_url": "https://files.pythonhosted.org/packages/78/71/97941f0a5b834560802f40ef4d63a79aa62839161e2abe66afec48c483ad/napari-cupy-image-processing-0.4.1.tar.gz",
    "platform": null,
    "description": "# napari-cupy-image-processing\r\n\r\n[![License](https://img.shields.io/pypi/l/napari-cupy-image-processing.svg?color=green)](https://github.com/haesleinhuepf/napari-cupy-image-processing/raw/master/LICENSE)\r\n[![PyPI](https://img.shields.io/pypi/v/napari-cupy-image-processing.svg?color=green)](https://pypi.org/project/napari-cupy-image-processing)\r\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-cupy-image-processing.svg?color=green)](https://python.org)\r\n[![tests](https://github.com/haesleinhuepf/napari-cupy-image-processing/workflows/tests/badge.svg)](https://github.com/haesleinhuepf/napari-cupy-image-processing/actions)\r\n[![codecov](https://codecov.io/gh/haesleinhuepf/napari-cupy-image-processing/branch/master/graph/badge.svg)](https://codecov.io/gh/haesleinhuepf/napari-cupy-image-processing)\r\n[![Development Status](https://img.shields.io/pypi/status/napari-cupy-image-processing.svg)](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha)\r\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-cupy-image-processing)](https://napari-hub.org/plugins/napari-cupy-image-processing)\r\n\r\n\r\nGPU-accelerated image processing using [cupy](https://cupy.dev) and [CUDA](https://en.wikipedia.org/wiki/CUDA)\r\n\r\n## Usage\r\n\r\nThis napari plugin adds some menu entries to the Tools menu. You can recognize them with their suffix `(n-cupy)` in brackets.\r\nFurthermore, it can be used from the [napari-assistant](https://www.napari-hub.org/plugins/napari-assistant) graphical user interface. \r\nTherefore, just click the menu `Tools > Utilities > Assistant (na)` or run `naparia` from the command line.\r\n\r\n![img.png](https://github.com/haesleinhuepf/napari-cupy-image-processing/raw/main/docs/screenshot-with-tools-menu.png)\r\n\r\nYou can also call operations from python, e.g. as shown in this [demo notebook](https://github.com/haesleinhuepf/napari-cupy-image-processing/raw/main/docs/demo.ipynb).\r\n\r\n## Installation\r\n\r\nYou can install `napari-cupy-image-processing` using conda:\r\n\r\n    mamba install -c conda-forge cupy cudatoolkit=11.2 napari-cupy-image-processing\r\n\r\n## Troubleshooting installation\r\n\r\nIn case of issues, follow the [instructions for installing cupy](https://docs.cupy.dev/en/stable/install.html#installing-cupy-from-conda-forge). \r\n\r\nA more detailed example for installation (change 11.2 to your desired CUDA version):\r\n```\r\nmamba create --name cupy_p39 python=3.9 \r\nconda activate cupy_p39\r\n```\r\nAnd then:\r\n```\r\nmamba install -c conda-forge cupy cudatoolkit=11.2 napari-cupy-image-processing\r\n```\r\n\r\n## Contributing\r\n\r\nContributions are very welcome. Adding [cupy ndimage](https://docs.cupy.dev/en/stable/reference/ndimage.html) functions is quite easy as you can see in the \r\n[implementation of the current operations](https://github.com/haesleinhuepf/napari-cupy-image-processing/blob/main/napari_cupy_image_processing/_cupy_image_processing.py#L48). \r\nIf you need another function in napari, just send a PR. Please make sure the tests pass locally before submitting a PR.\r\n\r\n```\r\npip install pytest-cov pytest-qt\r\npytest --cov=napari_cupy_image_processing\r\n```\r\n\r\nThis [napari] plugin was generated with [Cookiecutter] using with [@napari]'s [cookiecutter-napari-plugin] template.\r\n\r\n## License\r\n\r\nDistributed under the terms of the [MIT] license,\r\n\"napari-cupy-image-processing\" is free and open source software\r\n\r\n## Issues\r\n\r\nIf you encounter any problems, please [file an issue] along with a detailed description.\r\n\r\n[napari]: https://github.com/napari/napari\r\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\r\n[@napari]: https://github.com/napari\r\n[MIT]: http://opensource.org/licenses/MIT\r\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\r\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\r\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\r\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\r\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\r\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\r\n\r\n[file an issue]: https://github.com/haesleinhuepf/napari-cupy-image-processing/issues\r\n\r\n[napari]: https://github.com/napari/napari\r\n[tox]: https://tox.readthedocs.io/en/latest/\r\n[pip]: https://pypi.org/project/pip/\r\n[PyPI]: https://pypi.org/\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "GPU-accelerated image processing using CUDA",
    "version": "0.4.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/haesleinhuepf/napari-cupy-image-processing/issues",
        "Documentation": "https://github.com/haesleinhuepf/napari-cupy-image-processing#README.md",
        "Homepage": "https://github.com/haesleinhuepf/napari-cupy-image-processing",
        "Source Code": "https://github.com/haesleinhuepf/napari-cupy-image-processing",
        "User Support": "https://github.com/haesleinhuepf/napari-cupy-image-processing/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e0733c0029d97e1f3e9c29411dcdc8fa8d7d42ca160f3f77da97dde58dc58213",
                "md5": "fee02efbe349bbccfdf7b72ca6bd0851",
                "sha256": "2cfaa29ca27ed6e761c89750ede7b2a16c61c472d48feeed4c98a8a25ec9220b"
            },
            "downloads": -1,
            "filename": "napari_cupy_image_processing-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fee02efbe349bbccfdf7b72ca6bd0851",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 10385,
            "upload_time": "2023-08-17T12:35:57",
            "upload_time_iso_8601": "2023-08-17T12:35:57.033627Z",
            "url": "https://files.pythonhosted.org/packages/e0/73/3c0029d97e1f3e9c29411dcdc8fa8d7d42ca160f3f77da97dde58dc58213/napari_cupy_image_processing-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "787197941f0a5b834560802f40ef4d63a79aa62839161e2abe66afec48c483ad",
                "md5": "7548f0a3c0a044defab4cf5a6fc05ddb",
                "sha256": "fc52befc6827d5a10550e90e6cb0a8383d1594b5c255f41d2b6daf6a7908017b"
            },
            "downloads": -1,
            "filename": "napari-cupy-image-processing-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7548f0a3c0a044defab4cf5a6fc05ddb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 10714,
            "upload_time": "2023-08-17T12:35:58",
            "upload_time_iso_8601": "2023-08-17T12:35:58.231799Z",
            "url": "https://files.pythonhosted.org/packages/78/71/97941f0a5b834560802f40ef4d63a79aa62839161e2abe66afec48c483ad/napari-cupy-image-processing-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-17 12:35:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "haesleinhuepf",
    "github_project": "napari-cupy-image-processing",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "napari-cupy-image-processing"
}
        
Elapsed time: 0.10008s