sameer-antani / kaibu

Kaibu -- a progressive web app for visualizing and annotating multi-dimensional images.

Kaibu is a web application for visualizing and annotating multi-dimensional images, built with OpenLayers and itk-vtk-viewer.

---

WARNING: This is a work-in-progress repo, you are welcome to try it out but it's not ready for use in production yet.

Documentation: https://kaibu.org/docs/

How to use Kaibu?

The flexibel design of Kaibu allows you to use it in different ways as explained in the sections below.

As standalone application

Visit https://kaibu.org to see Kaibu as a stand-alone appliction running in your browser.

As ImJoy plugin

https://imjoy.io/#/app?plugin=https://kaibu.org/#/app

Currently we support view_image, add_image, add_shapes and add_points, the definition is mostly the same as napari.

Kaibu API functions for ImJoy

See documentation https://kaibu.org/docs/#/api.

In a Jupyter notebook

First, install Kaibu with pip install imjoy-jupyter-extension, then start the Jupyter notebook. Then you can use the above plugin example in the notebook.

You can try the demo on Binder here:

Kaibu badges

We provide two badges for you to add to your project:

![open with kaibu](https://kaibu.org/static/badge/open-with-kaibu.svg)

![view in kaibu](https://kaibu.org/static/badge/view-in-kaibu.svg)

Why Kaibu?

Kaibu is a small island in Fiji, and we name it to pay tribute to the open source image processing package Fiji/ImageJ. Meanwhile, the layered design of Kaibu is inspired by Napari which is also named after an island. Kaibu in Chinese(开步) means "to step forward", and yes, it is time to step forward with Kaibu!

License

MIT