napari-serverkit 0.1.0

Napari client for the imaging-server-kit project.

🪐 Napari Server Kit

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

or clone the project and install the development version:

git clone https://github.com/Imaging-Server-Kit/napari-serverkit.git
cd napari-serverkit
pip install -e .

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.