Skip to content

Getting Started

Prerequisites

ZeroC ICE + omero-py

omero-py depends on ZeroC ICE, which cannot be built from source on modern Python. Pre-built wheels are available for Python 3.10 – 3.12 from Glencoe Software.

pip install https://github.com/glencoesoftware/zeroc-ice-py-linux-x86_64/releases/download/20240202/zeroc_ice-3.6.5-cp311-cp311-manylinux_2_28_x86_64.whl
pip install omero-py

pip install https://github.com/glencoesoftware/zeroc-ice-py-win-x86_64/releases/download/20240325/zeroc_ice-3.6.5-cp311-cp311-win_amd64.whl
pip install omero-py

pip install https://github.com/glencoesoftware/zeroc-ice-py-macos-universal2/releases/download/20240131/zeroc_ice-3.6.5-cp311-cp311-macosx_11_0_universal2.whl
pip install omero-py

conda install -c conda-forge zeroc-ice omero-py

Tip

Replace cp311 with cp310 or cp312 to match your Python version.

PyQt6

PyQt6 is listed as a dependency and will be installed automatically via pip.

Installation

pip install omero-browser-qt

Optional extras

Extra Install command Adds
viewer pip install "omero-browser-qt[viewer]" vispy + PyOpenGL for 3D volume rendering
docs pip install "omero-browser-qt[docs]" MkDocs toolchain (maintainers only)

First workflow

The simplest way to browse and select images:

from PyQt6.QtWidgets import QApplication
from omero_browser_qt import OmeroGateway, OmeroBrowserDialog

app = QApplication([])
gw = OmeroGateway()

# Shows login dialog, then the browser. Returns selected ImageWrappers.
for img in OmeroBrowserDialog.select_images(gateway=gw):
    print(img.getName(), img.getId())

gw.disconnect()

If you also need the project/dataset breadcrumb for each image:

for ctx in OmeroBrowserDialog.select_image_contexts():
    print(ctx.breadcrumb)          # e.g. "Project > Dataset > image.tiff"
    print(ctx.image.getId())

OMERO Viewer

The package installs an omero_viewer launcher by default. Install the viewer extra as well if you want 3D support:

pip install "omero-browser-qt[viewer]"

Then launch the viewer with:

omero_viewer

On Windows, pip installs this as a small omero_viewer.exe launcher in the active environment. From a source checkout, you can also run python -m omero_browser_qt.omero_viewer.

When logging in from the viewer or browser, the app automatically caches a reusable OMERO session UUID for up to ten minutes. This is not the password, and it allows reconnecting after closing and reopening the app while that OMERO session is still valid.

Next steps