Metadata-Version: 2.4
Name: aiod-napari
Version: 0.1
Summary: A plugin for segmenting images using AI models via the Segment-Flow Nextflow pipeline.
Project-URL: homepage, https://github.com/FrancisCrickInstitute/aiod_napari
Project-URL: documentation, https://franciscrickinstitute.github.io/aiod_docs/sections/front_ends/napari_plugin/
Project-URL: source, https://github.com/FrancisCrickInstitute/aiod_napari
Author-email: Cameron Shand <cameron.shand@crick.ac.uk>, Numan Ahmed <numan.ahmed@crick.ac.uk>, Fiona Young <fiona.young@crick.ac.uk>, Qin Yu <qin.yu@crick.ac.uk>, Jon Smith <jon.smith@crick.ac.uk>
License: MIT License
        
        Copyright (c) 2026 Cameron Shand
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: napari
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: <3.13,>=3.11
Requires-Dist: aiod-registry==0.1
Requires-Dist: aiod-utils==0.1
Requires-Dist: dask-image
Requires-Dist: glasbey
Requires-Dist: napari>=0.6
Requires-Dist: numpy<2
Requires-Dist: pandas
Requires-Dist: platformdirs
Requires-Dist: pyyaml
Requires-Dist: qtpy
Requires-Dist: requests
Requires-Dist: scikit-image>0.20
Requires-Dist: scipy
Requires-Dist: tabulate
Provides-Extra: testing
Requires-Dist: napari; extra == 'testing'
Requires-Dist: pyqt5; extra == 'testing'
Requires-Dist: pytest; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'
Requires-Dist: pytest-qt; extra == 'testing'
Requires-Dist: tox; extra == 'testing'
Description-Content-Type: text/markdown

# AIoD Napari Plugin

Napari plugin part of [AI OnDemand (AIoD)](https://franciscrickinstitute.github.io/aiod_docs) to provide an accessible interface for running deep learning models on images via our [Nextflow pipeline](https://github.com/FrancisCrickInstitute/Segment-Flow).

----------------------------------

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

## Installation

See our latest installation information in our [documentation](https://franciscrickinstitute.github.io/aiod_docs/sections/front_ends/napari_plugin/#installation)!

In general, you should see the [official Napari installation instructions](https://napari.org/stable/getting_started/installation.html#install-python-package) first to ensure Napari is installed with an appropriate Qt backend.

### `uv`
A `uv.lock` file is provided for smoother installation:

```
uv add aiod_napari
```

### Conda
We have also provided a conda environment file to install all the dependencies for this plugin. To install the environment, run the following command:

    conda env create -f ai-od.yml

Note that when it comes to the installation of napari this may be preferable, depending on whether your system is best supported by the pip- or conda-packaged version.

## Usage
For general usage of the plugin, see the [documentation](https://franciscrickinstitute.github.io/aiod_docs/sections/front_ends/napari_plugin/).

For developers, see our [developer guide](https://franciscrickinstitute.github.io/aiod_docs/sections/contributing/developing/) for some tips on how to get started and contribute to the plugin.

## Contributing

Contributions are very welcome. Tests can be run with [tox], please ensure the coverage at least stays the same before you submit a pull request.

## Issues

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