🪐 Napari Server Kit

⚠️ Since v0.0.2, the Napari Server Kit has been integrated directly into the imaging-server-kit package. We recommend using imaging-server-kit>=0.0.2 to use algorithms in Napari instead of separately installing the Napari plugin.

---

Run Imaging Server Kit algorithms interactively in Napari.

screencast.webm

Installation

You can install the plugin either via python or the executable installer.

Python installation

You can install napari-serverkit via pip::

pip install napari-serverkit

Then, start Napari with the Server Kit plugin from the terminal:

napari -w napari-serverkit

Executable installer

Download, unzip, and execute the installer from the Releases page.

Usage

Refer to the Imaging Server Kit documentation for detailed instructions on how to use the napari-serverkit plugin.

TL;DR

• In Python, use sk.to_napari(algo) to generate a dock widget for an sk.algorithm object and use it in Napari.
• In Napari, connect to an algorithm server via Plugins > Server Kit (Napari Server Kit).

import napari
import imaging_server_kit as sk

@sk.algorithm
def my_algorithm(...):
    ...

sk.to_napari(my_algorithm)
napari.run()

Contributing

Contributions are very welcome.

License

This software is distributed under the terms of the BSD-3 license.

Issues

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

Acknowledgements

This project uses the PyApp software for creating a runtime installer.