Skip to main content

napari/OMERO interoperability

Project description

napari-omero

License PyPI Python Version CI codecov conda-forge

This package provides interoperability between the OMERO image management platform, and napari: a fast, multi-dimensional image viewer for python.

It provides a GUI interface for browsing an OMERO instance from within napari, as well as command line interface extensions for both OMERO and napari CLIs.

demo

Features

  • GUI interface to browse remote OMERO data, with thumbnail previews.
  • Loads remote nD images from an OMERO server into napari
  • Planes are loading on demand as sliders are moved ("lazy loading").
  • session management (login memory)
  • OMERO rendering settings (contrast limits, colormaps, active channels, current Z/T position) are applied in napari

as a napari dock widget

To launch napari with the OMERO browser added, install this package and run:

napari-omero

The OMERO browser widget can also be manually added to the napari viewer:

import napari

viewer = napari.Viewer()
viewer.window.add_plugin_dock_widget('napari-omero')

napari.run()

as a napari plugin

This package provides a napari reader plugin that accepts OMERO resources as "proxy strings" (e.g. omero://Image:<ID>) or as OMERO webclient URLS.

viewer = napari.Viewer()

# omero object identifier string
viewer.open("omero://Image:1")

# or URLS: https://help.openmicroscopy.org/urls-to-data.html
viewer.open("http://yourdomain.example.org/omero/webclient/?show=image-314")

these will also work on the napari command line interface, e.g.:

napari omero://Image:1
# or
napari http://yourdomain.example.org/omero/webclient/?show=image-314

as an OMERO CLI plugin

This package also serves as a plugin to the OMERO CLI

omero napari view Image:1
  • ROIs created in napari can be saved back to OMERO via a "Save ROIs" button.
  • napari viewer console has BlitzGateway 'conn' and 'omero_image' in context.

installation

Requires python 3.7 - 3.10.

from conda

It's easiest to install omero-py from conda, so the recommended procedure is to install everything from conda, using the conda-forge channel

conda install -c conda-forge napari-omero

from pip

napari-omero itself can be installed from pip, but you will still need omero-py

conda create -n omero -c conda-forge python=3.9 omero-py
conda activate omero
pip install napari-omero[all]  # the [all] here is the same as `napari[all]`

issues

This is alpha software & some things will be broken or sub-optimal!
  • experimental & definitely still buggy! Bug reports are welcome!
  • remote loading can be very slow still... though this is not strictly an issue of this plugin. Datasets are wrapped as delayed dask stacks, and remote data fetching time can be significant. Plans for asynchronous rendering in napari and tiled loading from OMERO may eventually improve the subjective performance... but remote data loading will likely always be a limitation here. To try asyncronous loading, start the program with NAPARI_ASYNC=1 napari-omero.

contributing

Contributions are welcome! To get setup with a development environment:

# clone this repo:
git clone https://github.com/tlambert03/napari-omero.git
# change into the new directory
cd napari-omero
# create conda environment
conda env create -f environment.yml
# activate the new env
conda activate napari-omero

# install in editable mode
pip install -e .

To maintain good code quality, this repo uses flake8, mypy, and black. To enforce code quality when you commit code, you can install pre-commit

# install pre-commit which will run code checks prior to commits
pre-commit install

The original OMERO data loader and CLI extension was created by Will Moore.

The napari reader plugin and GUI browser was created by Talley Lambert

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari_omero-0.2.1.tar.gz (10.2 MB view details)

Uploaded Source

Built Distribution

napari_omero-0.2.1-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

Details for the file napari_omero-0.2.1.tar.gz.

File metadata

  • Download URL: napari_omero-0.2.1.tar.gz
  • Upload date:
  • Size: 10.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for napari_omero-0.2.1.tar.gz
Algorithm Hash digest
SHA256 4ed29e255dfbcb4c40e6184a8d1065ff8603d4f4d5f3bf072a8e6fc5940d83ec
MD5 643f386dce8260510a95c96e5b63ef88
BLAKE2b-256 3ff73130e76316193a0191ccc3b07be4224d637a9673be02f8938fe6e3e7568f

See more details on using hashes here.

File details

Details for the file napari_omero-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: napari_omero-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 26.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for napari_omero-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f07d66ce22afd52eaa0bb7d525e8f1682b8b29db59d3741cfc4ef4c24d0f3006
MD5 514e2ca9e31c13295e3ccc1e4d6734a3
BLAKE2b-256 3929e2cfc2bcaa8c8b2b811638923dc20ae7fabb694daef4b3abe1fe0dd5587c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page