Skip to main content

A Python plugin for OMERO.web

Project description

https://travis-ci.org/ome/omero-iviewer.svg?branch=master https://badge.fury.io/py/omero-iviewer.svg

OMERO.iviewer

An OMERO.web app for visualizing images in OMERO.

Requirements

  • OMERO 5.6.0 or newer.

Installing from PyPI

This section assumes that an OMERO.web is already installed.

Install the app using pip:

NB: You need to ensure that you are running pip from the python environment where omero-web is installed. Depending on your install, you may need to call pip with, for example: /path/to/venv/bin/pip install ...

$ pip install -U omero-iviewer

Add iviewer custom app to your installed web apps:

$ omero config append omero.web.apps '"omero_iviewer"'

To replace the default omero.web viewer:

$ omero config set omero.web.viewer.view omero_iviewer.views.index

To enable the “open with” feature:

$ omero config append omero.web.open_with '["omero_iviewer", "omero_iviewer_index",
  {"supported_objects":["images", "dataset", "well"],
   "script_url": "omero_iviewer/openwith.js", "label": "OMERO.iviewer"}]'

Now restart OMERO.web as normal.

Usage

A guide to using OMERO.iviewer can be found on https://omero-guides.readthedocs.io/en/latest/iviewer/docs/iviewer.html

License

OMERO.iviewer is released under the AGPL.

Supported by

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