{"name":"napari-nucleaizer","display_name":"Napari nucleAIzer plugin","visibility":"public","icon":"","categories":[],"schema_version":"0.2.0","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-nucleaizer.launch","title":"Launch nucleAIzer widget","python_name":"napari_nucleaizer.nucleaizer_widget:Nucleaizer","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":null,"writers":null,"widgets":[{"command":"napari-nucleaizer.launch","display_name":"Nuclei segmentation and training","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.1","name":"napari-nucleaizer","version":"0.2.5","dynamic":null,"platform":null,"supported_platform":null,"summary":"A GUI interface for training and prediction using the nucleAIzer nuclei detection method.","description":"# napari_nucleaizer\n\n[![License](https://img.shields.io/pypi/l/napari-nucleaizer.svg?color=green)](https://github.com/etasnadi/napari-nucleaizer/raw/master/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-nucleaizer.svg?color=green)](https://pypi.org/project/napari-nucleaizer)\n[![Python package](https://github.com/etasnadi/napari_nucleaizer/actions/workflows/test_and_deploy.yml/badge.svg)](https://github.com/etasnadi/napari_nucleaizer/actions/workflows/test_and_deploy.yml)\n[![codecov](https://codecov.io/gh/etasnadi/napari_nucleaizer/branch/master/graph/badge.svg?token=5XC36PA6OQ)](https://codecov.io/gh/etasnadi/napari_nucleaizer)\n[![Documentation Status](https://readthedocs.org/projects/napari-nucleaizer-docs/badge/?version=latest)](https://napari-nucleaizer-docs.readthedocs.io/en/latest/?badge=latest)\n\n\n\nGUI for the nucleaAIzer method in Napari.\n\n![Plugin interface in napari.](https://github.com/etasnadi/napari_nucleaizer/blob/main/napari_screenshot.png?raw=true)\n\n## Overview\n\nThis is a napari plugin to execute the nucleaizer nuclei segmentation algorithm.\n\n### Main functionalities\n\nUsing this plugin will be able to\n\n1. Load your image into Napar, then outline the nuclei.\n2. Specify an image folder containing lots of images and an output folder, and automatically segment all of the images in the input folder.\n3. If you are not satisfied with the results, you can train your own model:\n 1. You can use our pretrained models and fine tune them on your data.\n 2. You can skip the nucleaizer pipeline and train only on your data.\n\n\n### Supported image types\n\nWe have several pretrained models for the following image modelities:\n* fluorescent microscopy images\n* IHC stained images\n* brightfield microscopy images,\n\namong others. For the detailed descriptions of our models, see: https://zenodo.org/record/6800341.\n\n### How it works?\n\nFor the description of the algorithm, see our paper: \"Hollandi et al.: nucleAIzer: A Parameter-free Deep Learning Framework for Nucleus Segmentation Using Image Style Transfer, Cell Systems, 2020. https://doi.org/10.1016/j.cels.2020.04.003\"\n\nThe original code (https://github.com/spreka/biomagdsb) is partially transformed into a python package (nucleaizer_backend) to actually perform the operations. See the project page of the backend at: https://github.com/etasnadi/nucleaizer_backend.\n\nIf you wish to use the web interface, check: http://nucleaizer.org.\n\n![All functionalities.](https://github.com/etasnadi/napari_nucleaizer/blob/main/nucleaizer_screenshot.png?raw=true)\n\n\n\n## Install\n\n1. Create an environment (recommended).\n\n2. Install napari: `pip install \"napari[pyqt5]\"`. Other methods: https://napari.org/tutorials/fundamentals/installation.html\n\n3. Install the plugin into napari:\n\n * User mode from [PyPI](https://pypi.org/project/napari-nucleaizer/): start Napari (command line: `napari`) and select he **Install/Uninstall Plugins...** under the **Plugins** menu. In the popup, filter for `napari-nucleaizer`.\n\n * Developer mode: clone this project and use `pythhon3 -m pip install -e ` to install the project locally **into the same evnrionment as napari**. It has the advantage that you will have the latest version.\n## Run\n\n1. Start Napari by calling `napari` from the command line.\n2. Then, activate the plugin in the `Plugins` menu. If you successfully installed the plugin, you have to see something like this:\n\n![Plugin interface in napari.](https://github.com/etasnadi/napari_nucleaizer/blob/main/napari_plugin_launch.png?raw=true)\n\n## Further help\n\nSee the [documentation](https://napari-nucleaizer-docs.readthedocs.io/en/latest/index.html) (work in progress).\n\n## Issues\n\nUse the github issue tracker if you experinece unexpected behaviour.\n\n## Contact\n\nYou can contact me in [e-mail](mailto:tasnadi.ervin@MY-INSTITUTE) where MY-INSTITUTE is `brc.hu`.\n","description_content_type":"text/markdown","keywords":null,"home_page":"https://github.com/etasnadi/napari_nucleaizer","download_url":null,"author":"Ervin Tasnadi","author_email":"tasnadi.ervin@brc.hu","maintainer":null,"maintainer_email":null,"license":"BSD-3","classifier":["Development Status :: 3 - Alpha","Intended Audience :: Developers","Framework :: napari","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: 3.10","Operating System :: OS Independent","License :: OSI Approved :: BSD License"],"requires_dist":["napari","qtpy","jsonpickle","numpy","scikit-image","imageio","nucleaizer-backend"],"requires_python":">=3.8","requires_external":null,"project_url":["Bug Tracker, https://github.com/etasnadi/napari_nucleaizer/issues","Documentation, https://napari-nucleaizer-docs.readthedocs.io/en/latest/index.html","Source Code, https://github.com/etasnadi/napari_nucleaizer","User Support, https://github.com/etasnadi/napari_nucleaizer/issues"],"provides_extra":null,"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}